block-template-html

Block Protocol template: HTML

Step one: copy this template

See https://blockprotocol.org/docs/developing-blocks

TL;DR: Run npx create-block-app@latest [your-block-name] --template=html

Other templates are available. See npx create-block-app@latest --help

Step two: write and build a component

1. Change into the folder: cd path/to/your-block-name

2. Update block-metadata.json and block-schema.json to define your block's metadata and the properties it takes.

3. Write your block starting in app.html. To test it during development:

   • edit dev/index.html to give your block starting properties

   • run the dev server with yarn dev (or npm run dev)

4. When finished, run yarn build (or npm run build), which:

   • Bundles the component into a single source file
   • Once uploaded to a remote folder, embedding applications can access block-metadata.json to load a block and its schema. This file is documented in full here.

Please see the Block Protocol docs for help in creating and updating data from your block.

You can format your code using yarn format (or npm run format).

N.B.

• JSON schema offers more validations than TypeScript.

Step three: publish your block

Head over to blockprotocol.org to read instructions on publishing your block.

External Dependencies

This template assumes there is no bundling process. You will need to reference external dependencies using ES Modules. Tools like esm.sh or unpkg.com can make this much easier.

The Block Protocol does not currently support externals when using HTML blocks.

Debugging

The component can be debugged locally by first starting yarn dev.

Now (using VS Code), go to the Debug tab, select "Launch Chrome" and start the debugger (F5).

You should now be able to set breakpoints and step through the code.