Configuration reference
Every setting Listing Interrupter exposes, in the order the admin shows it. Field descriptions are the help texts shipped in the admin — the plugin is the source of truth for them.
Plugin settings
The plugin has no shop-wide settings. Its page under Settings → Extensions → Listing Interrupter & Banner Studio contains no configurable values; everything is configured per tile, in Marketing → Listing Interrupter.
Tile — Content tab
General card
| Field | Type | Default | Description |
|---|---|---|---|
| Name | Text, required | — | Internal name shown in the list — shoppers never see it. |
| Active | Switch | On | Shown whenever the availability rule matches |
Content card
Every field in this card is translatable: switch the shop language in the top bar to author another language. On tablet and mobile each field can also carry a per-device override — see Per-device overrides.
| Field | Type | Default | Description |
|---|---|---|---|
| Background image | Media | — | The tile's background image, picked from the Media library. |
| Badge line (optional) | Text, translatable | — | Small label above the headline, e.g. SALE or NEW. |
| Headline | Text, translatable | — | The main line shoppers read on the tile. |
| Subline (optional) | Text, translatable | — | Optional supporting line under the headline. |
| CTA label | Text, translatable | — | Button label, e.g. Shop now. |
| Link opens | Same tab / New tab | Same tab | Open the link in the same tab or a new one. |
| Link type | URL / Category / Product | — | Choose whether the tile links to a URL, category, or product. |
| Target URL | URL | — | Full destination URL the tile opens. (Link type: URL) |
| Category | Category select | — | Category the tile links to. (Link type: Category) |
| Product | Product select | — | Product the tile links to. (Link type: Product) |
Appearance card
| Field | Type | Default | Description |
|---|---|---|---|
| Text color | Colour picker (hex) | #ffffff | Colour of the tile text and button label. |
| Background colour | Colour picker (hex) | — | Solid colour shown when no background image is set. |
| Overlay | None / Dark gradient · 40% / Solid dark | None | Darkens the background image so text stays readable. |
| Content alignment | Left / Center / Right | Left | Horizontal alignment of the tile's text block. |
| Vertical alignment | Top / Middle / Bottom | Middle | Vertical alignment of the tile's text block. |
| Corners | Switch (Rounded corners) | On | Round the tile corners to match your theme. |
Live preview
Read-only. Renders the tile with your storefront font and its configured width, and redraws on every keystroke. It follows the device switcher, so it shows the resolved tile for the device you are editing. The exact grid context lives on the Placement tab.
Tile — Placement tab
Where it appears card
| Field | Type | Default | Description |
|---|---|---|---|
| Categories | Category tree, multi-select | — | Category listings where the tile can appear. A tile with no category is never shown. |
| Sales channels | Multi-select | — | A tile with no sales channel is never shown. |
| Availability rules (optional) | Rule multi-select | — | Rules cover audience and timing — customer groups, cart value, or a date range via the native date condition. The tile shows only when every selected rule matches (add more to narrow further). Leave empty to always show the tile to everyone. |
Placement per device card
| Field | Type | Default | Description |
|---|---|---|---|
| Device | Desktop / Tablet / Mobile | Desktop | Which viewport you are editing. Not stored — it selects which values the card edits. |
| Visible on | Switch | On | Turn the tile off on this device without deleting it. |
| Position | Set by dragging the tile on the canvas | 1 | The grid slot the tile occupies, counted from 1. |
| Width (span) | Set by dragging the tile's right edge | 1 cell | How many product cells the tile occupies, or a full row. |
| Show on pages | Text | 1 | Exact (2), range (1-5), open (3- or -2). Empty = all pages; new tiles start on page 1. Applies to every device. |
The canvas's Preview selectors (sales channel, category, preview page) are editing aids only. They are never saved to the tile.
Page range syntax
| Value | Pages the tile appears on |
|---|---|
| (empty) | All pages |
2 | Page 2 only |
1-5 | Pages 1 through 5 |
3- | Page 3 and all following |
-2 | Pages 1 and 2 |
Anything else is rejected on save with Not a valid page range. Use a number (2), a range (1-5), or an open range (3- or -2).
Span values
| Stored value | Meaning | Product cells displaced |
|---|---|---|
"1" … "N" | That many product cells wide, capped at the viewport's column count | Same number |
"row" | Full row — the tile gets a row of its own | None |
An unrecognised value falls back to one cell.
Per-device overrides
Tablet and mobile inherit from desktop until a field is unlocked with the chain-link icon.
| Field | Overridable per device | Translated |
|---|---|---|
| Background image | Yes | No |
| Badge line | Yes | Yes |
| Headline | Yes | Yes |
| Subline | Yes | Yes |
| CTA label | Yes | Yes |
| Text color | Yes | No |
| Background colour | Yes | No |
| Overlay | Yes | No |
| Position | Yes | No |
| Width (span) | Yes (desktop + tablet; mobile is single-column) | No |
| Visible on device | Yes | No |
| Link, alignment, corners | No — shared across devices | No |
| Show on pages | No — applies to every device | No |
Only the desktop width counts towards how many products a tile displaces. See Concepts.
Permissions
Registered under Settings → Users & permissions, category Content, key ssd_listing_interrupter.
| Role | Grants | Includes |
|---|---|---|
| Viewer | Read tiles and their assignments; read categories, rules, sales channels, products and media | — |
| Editor | Update tiles, translations and all assignments | Viewer |
| Creator | Create tiles (used by Create interrupter and Duplicate) | Viewer, Editor |
| Deleter | Delete tiles | Viewer |
Admin module routes
| Route | Path | Required role |
|---|---|---|
| List | #/ssd/listing/interrupter/list | Viewer |
| Detail | #/ssd/listing/interrupter/detail/:id | Viewer |
| Create | #/ssd/listing/interrupter/create | Creator |
Navigation entry: Marketing → Listing Interrupter.
Entity reference
Entity ssd_listing_interrupter, available over the Admin API at /api/ssd-listing-interrupter.
| Field | Type | Notes |
|---|---|---|
id | UUID | Primary key |
name | string | Required; searchable |
type | string | Required; banner |
active | bool | |
priority | int | Order when tiles share a slot; higher first. Set to 1 on create and not editable in the admin — change it over the Admin API |
position | int | Required; 1-based grid slot |
span | string | Required; "1"…"N" or "row" |
pageRange | string, nullable | Page-range expression; null = all pages |
visibility | json | {mobile, tablet, desktop} booleans |
viewportOverrides | json, nullable | {tablet?, mobile?} → {mediaId?, span?, position?, styles?}; language-independent |
link | json, nullable | {type: url|category|product, value, newTab} |
styles | json | {textColor, bgColor, overlayColor, alignment, verticalAlignment, rounded} |
mediaId | UUID, nullable | Background image |
headline | string, translated | |
subline | string, translated | |
ctaText | string, translated | |
badgeText | string, translated | |
viewportContentOverrides | json, translated, nullable | {tablet?, mobile?} → {headline?, subline?, ctaText?, badgeText?} |
createdAt / updatedAt | datetime |
Associations
| Association | Target | Mapping table |
|---|---|---|
categories | category | ssd_listing_interrupter_category |
salesChannels | sales_channel | ssd_listing_interrupter_sales_channel |
rules | rule | ssd_listing_interrupter_rule |
media | media | — (media_id foreign key) |
translations | ssd_listing_interrupter_translation | — |
Deleting a tile cascades to its category, sales channel and rule assignments.
Theme integration
The storefront tile reads one SCSS variable, overridable from your theme:
| Variable | Default | Effect |
|---|---|---|
$ssd-listing-interrupter-border-radius | 8px | Corner radius applied when Rounded corners is on |
The plugin does not use Bootstrap's .rounded utility, because the Shopware storefront theme ships $enable-rounded: false, which would make the option do nothing.
Storefront scope
Tiles render inside the Product Listing CMS element — that is, on category listing pages. Search-result and manufacturer pages are not covered.
Compatibility
| Shopware | ~6.7.0 (core + storefront) |
| Plugin version | 2.0.0 |
