index.json

Configure the blocks available in a theme and how they are organised in the site builder.

The blocks/index.json file defines the blocks available in a theme and how they are organised within the Easol site builder.

Each entry registers a block and assigns it a display name and category.

{
  "example": {
    "name": "Example block",
    "category": "Text"
  }
}

Properties

name

The display name of the block.

This name is shown to creators when they browse, add, or edit blocks in the site builder.

category

The category used to group blocks within the site builder.

Categories help creators find relevant blocks more easily and are displayed in alphabetical order.

Blocks that share the same category will be grouped together in the block library.

Example

The following configuration registers a block called Example block and places it in the Text category:

{
  "example": {
    "name": "Example block",
    "category": "Text"
  }
}

On this page