Block Protocol Metadata
Block Metadata in Block Protocol
| Type | object |
|---|---|
| File match |
block-metadata.json
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/block-protocol-metadata/latest.json |
| Source | https://blockprotocol.org/schemas/block-metadata.json |
Validate with Lintel
npx @lintel/lintel checkProperties
The type of block this is (e.g. custom element, React)
2 nested properties
A unique, slugified name for the block.
The applicable block protocol version, e.g. 0.3
The versioned URL to the block's schema, e.g. https://blockprotocol.org/@blockprotocol/types/entity-type/thing/v/2
The path or URL to the entrypoint source file (e.g. index.html, index.js).
The version of the block, which should use semantic versioning (@see https://semver.org/).
The name of the author of the block
The commit hash of the source this block was built from. If specified, 'repository' must also be specified.
A short description of the block, to help users understand its capabilities
URL of a web socket that reports updates in locally developed blocks. To be used by EAs to auto reload.
The display name used for a block
A list of examples property objects which comply with the block's schema, for demonstration purposes
An icon for the block, to be displayed when the user is selecting from available blocks (as well as elsewhere as appropriate, e.g. in a website listing the block).
A preview image of the block for users to see it in action before using it. This would ideally have a 3:2 width:height ratio and be a minimum of 900x1170px.
The license the block is made available under (e.g. MIT).
A list which represents different variants of the block that the user can create.