Link Search Menu Expand Document

Layout

A block schema can include an optional layout section, which defines how the variables are displayed to the Creator within the Easol site builder. When including a layout, block variables must be declared as attributes within the block schema.

Layouts can also be used in the Header and Footer templates only to specify the order that the elements appear (which will be above navigation items). However, there can only be one layout section. You must give it a label, even though this will not be presented to the Creator. Only elements in the first section will be shown, any further sections defined are ignored.

Layout types can be nested to organise block variables further.

Note: If a layout is defined this will replace the default site builder tabs and any groups defined for variables will be ignored. Any variable not included in the layout will not be accessible in the block’s Creator facing settings.

Example
---
attributes:
    heading:
        type: string
        label: Block Heading
    text:
        type: text
        default: Enter some nice copy about your experience
    image:
        type: image
        default:
            asset: images/sky.png
        label: Background Image
        hint: Recommended image size 1920px by 600px
    cta_enabled:
        type: boolean
        label: Display a button
        default: true
    button_text:
        type: string
        default: Click me
        label: Button text
    button_link:
        type: link
        label: Button link
layout:
    - type: tab
      label: Content
      elements: 
        - type: accordion
          label: Text
          elements:
            - heading
            - text
        - type: accordion_toggle
          toggle_attribute: cta_enabled
          elements:
            - button_text
            - button_link
    - type: tab
      label: Design
      elements:
        - image
---

Table of contents