Skip to content

Getting started with CMS Block Builder

This tutorial walks you through installing the plugin, building your first custom CMS block, and placing it on a page so it is visible in the storefront. It takes about ten minutes.

Prerequisites

  • Shopware 6.7 admin access with permission to manage plugins and Shopping Experiences pages.
  • The CMS Block Builder plugin installed and activated (see step 1).

Step 1 — Install and activate the plugin

  1. In the Shopware admin go to Extensions > My extensions.
  2. Find CMS Block Builder and click Install, then Activate.
  3. After activation, the Content menu gains a new CMS Block Builder entry.

Step 2 — Open the Block Builder

  1. In the admin sidebar, click Content > CMS Block Builder.
  2. You see the block library list. It is empty on a fresh install.
  3. Click Create Block in the top-right corner.

CMS Block Builder block list

Step 3 — Fill in the block settings

On the create page, fill in:

FieldWhat to enter
Block NameA human-readable display name, e.g. Hero with Text
Technical NameA unique identifier in lowercase with hyphens, e.g. hero-with-text. Cannot be changed after saving.
CategoryChoose where the block appears in the block picker, e.g. Custom.
PositionLeave at 0 for now — lower numbers appear earlier in the picker.

Leave Active switched on.

Block settings card showing Name, Technical Name, Category, and Position fields

Step 4 — Design the layout in the Block Composer

The Block Composer is the drawable grid below the settings card. It uses a 12-column CSS Grid canvas.

Quick start with a preset:

  1. In the empty state, you see preset cards: 1 Column, 2 Columns, Sidebar Left, etc.
  2. Click 2 Columns to instantly place two equal-width slots side by side.
  3. The grid shows two areas labelled slot-0 and slot-1.

Block Composer empty state showing preset cards

Assign elements to each slot:

  1. Click on the slot-0 area (or it opens automatically after drawing). The element picker modal appears.
  2. Scroll through the available CMS element previews and click the one you want, e.g. Image.
  3. The slot now shows "Image" as its element label.
  4. Click on slot-1 and assign Text (or any other element).

Element picker modal showing CMS element preview thumbnails

Both slots now have elements assigned.

Block Composer with filled layout — Image slot on left, Text slot on right

Step 5 — Save the block

Click Save in the top-right corner. If the block saves successfully, you see a success notification and the page reloads with the block detail view.

The block is now registered in the CMS block picker.

Step 6 — Place the block on a page

  1. Go to Content > Shopping Experiences (Erlebniswelten).
  2. Open an existing page or create a new one.
  3. In the block picker sidebar on the right, find the category you chose (e.g. Custom). Your block appears there with its name.
  4. Drag the block onto the page canvas.
  5. Each slot opens the standard Shopware element configuration panel. Fill in the image and text content as you would for any other block.
  6. Save the page.

CMS editor block picker showing the Custom category with the new custom block

Step 7 — Preview in the storefront

Open the page in the storefront. Your custom block is rendered as a two-column CSS Grid with the image on the left and the text on the right.

Storefront rendering of the custom block — two-column CSS Grid layout

You have built and placed your first custom CMS block. From here you can:

Your Vision. Signed, Sealed, Delivered.