Skip to content

For developers

Extending the module, the front-end runtime, and the reference material behind the editor UI.

Quick start

composer require drupal/canvas_builder
drush en canvas_builder

Settings live at Administration → Configuration → Content authoring → Canvas Builder (/admin/config/content/canvas-builder), behind the Administer Canvas Builder permission.

First thing to try: select a Section on a Canvas page. The floating toolbar sets its layout; the Style tab sets its background, spacing, and typography.

Issues and patches: project issue queue.

  • Architecture

    How a style edit flows from the control through the draft, publish, and revision lifecycle, and the seams the module hooks into Canvas through.

  • Extending

    Add a style option, a whole new style type, or a plugin from your own module.

  • Events

    The client-side Drupal.canvasBuilder namespace and the full cb:* event contract other code can subscribe to.

  • Frontend

    How a published page actually renders: class flattening, per-viewport visibility, and the front-end runtime libraries.

  • Style definition schema

    The full YAML shape a style definition must satisfy, field by field.

  • Custom style types

    Build a new style type — a widget beyond the built-in select, media, overlay, and box-model handlers.

  • Prop groups & widgets

    Add a new prop-group tab, or a custom form widget for a component prop.

  • Frameworks

    Switch between Custom, Bootstrap, and Tailwind — framework profiles, layout class maps, and the Tailwind safelist.

  • Limitations

    Known constraints and edge cases worth knowing before you build on top of them.