Banner and Slider Widgets
This page covers the widgets for the big visual blocks: announcement bars, hero images, image and video carousels and image grids. For each one it gives the steps to place it and the settings its form offers, in the words the form uses, so you can tell before you start which records and images you need to have ready.
Your job, and the screen for it
| The job | Screen or tab | Read |
|---|---|---|
| Add one of these widgets to a page | Design Panel › Elements › Banners & Sliders | Configuration |
| Change a widget that is already on the page | Click it on the canvas, Design Panel › Selected Node | Its section under Configuration |
| Know which settings need an ID, JSON or rich text | Selected Node | Fields |
| Make a change reach the shop | SAVE NODE, then Publish | Configuring Widgets |
| Find out why a widget shows nothing | Troubleshooting |
Overview
The Banners & Sliders group in the Elements tab holds 7 widgets: dynamic-image-grid-widget, promotional-widget, slider, slider-button-widget, slider-v2, top-banner-widget, video-slider-widget. Images are referred to by their address. Upload them in the Media Library and paste the address into the widget. Placing, saving and publishing work the same for every widget and are explained once in Configuring Widgets in the Website Builder; this page adds what is particular to each widget.
Where it fits
| Before | These widgets | After |
|---|---|---|
| You can open the Website Builder and the page exists — User Permission Manager, Layout Instance | Placed on a page and configured | Shoppers see them on the storefront after Publish |
Screens and menus
Open a page from the Layout Manager tile. In the Design Panel, the Elements tab lists these widgets under Banners & Sliders, each with its one-line description; the search box matches the description too. Clicking a placed widget on the canvas opens its settings in Selected Node.
Configuration
Before you can use it
- Everything in Configuring Widgets › Before you can use it: CP Commerce Admin for your login, and the records the widgets point at.
- Check Platform before you drop a widget: it is added to that platform’s version of the page only.
dynamic-image-grid-widget
Image grid.
- In Elements, open Banners & Sliders (or search dynamic-image-grid-widget) and drag dynamic-image-grid-widget onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- General — Title; Image link; Items (a list; each item has Image URL, Label, Alt, Image redirection link, Query params); Is clickable; Shadow
- Title styles — Color; Font size; Font weight
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
promotional-widget
Promotion banner.
- In Elements, open Banners & Sliders (or search promotional-widget) and drag promotional-widget onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- General — Images (a list; each item has Src, Label, Alt, Image redirection link, Query params); Post page (pick a page); Shadow; Content category (pick from list)
- Banner — Show banner; Banner message
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
slider
Image carousel slider (v1).
- In Elements, open Banners & Sliders (or search slider) and drag slider onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- Margin — Length
- Border radius — Length
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
slider-button-widget
Slider of buttons.
- In Elements, open Banners & Sliders (or search slider-button-widget) and drag slider-button-widget onto the page.
- In Selected Node, fill in the widget’s form: Text Color, Font, Button Text Color and Button Border Color, then under Add Slides one entry per slide with Title, Time, Button Text, Icon, Image URL and Redirect URL.
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
slider-v2
Image carousel slider.
- In Elements, open Banners & Sliders (or search slider-v2) and drag slider-v2 onto the page.
- In Selected Node, fill in the widget’s form: Under Add Images, one entry per slide with its Image URL and a Link Type — an External Link, or a page of this shop (Layout Instance) with optional Query Parameters. Image Display Type and Grid Config (comma-separated) decide how the images are laid out.
Under More settings at the bottom of the form:
- General — Active swiper bullet color; Box shadow
- Caption style — Background; Color; Font style; Font family; Font size; Text align
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
Each slide links either to a page of your shop — set Link Type to Layout Instance Link and pick the page under Layout Instance — or, with External Link, to any address. The list also offers Component, Page and Content Category, but a slide set to one of those does nothing when a shopper taps it, so pick one of the two that work. Links also work only when Image Display Type is SLIDER_DEFAULT: under SLIDES_PER_VIEW_AUTO or COL_IMG_DISPLAY the images show, but tapping one opens nothing.
top-banner-widget
Announcement bar at the top of the page.
- In Elements, open Banners & Sliders (or search top-banner-widget) and drag top-banner-widget onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- General — Logo URL; Logo alt text; Header text; Sub header text; Redirection link; Redirection link text; Shadow
- Styles — Background color; Color
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
Header text is the message. Redirection link is typed, not picked: /page/ and a page’s code for one of your pages, or a full https:// address.
video-slider-widget
Video carousel.
- In Elements, open Banners & Sliders (or search video-slider-widget) and drag video-slider-widget onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- General — Media folder (pick from list); Thumbnail media folder (pick from list); Hide arrows; Slides per view
- Style — Font; Size; Color
- Arrow styles — Width; Height; Background; Color
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
Fields
The settings are listed with each widget above, in the form’s own words. Colours, lists and JSON behave as described in Configuring Widgets › Step 3.
Settings marked (pick a page) — their labels end in page — open a list of your pages when you click them and fill in the page’s address, /page/ and its code. You can also type any link instead, such as a full https:// address. Left empty, the widget uses its own default page where it has one.
The settings that pick a record, take JSON or hold rich text:
| Kind | Where | What to know |
|---|---|---|
| Typed as JSON | dynamic-image-grid-widget › Query params; promotional-widget › Query params | Invalid JSON shows JSON is invalid and is not saved; the last valid value stays |
| Media folders | video-slider-widget › Media folder; video-slider-widget › Thumbnail media folder | Pick the Media Library folder by name; the widget shows what is in it. A saved one that is not in the loaded list shows as Not in the list — saved ID …; publish, then reload, before you replace it — a reload loses unpublished changes |
| Content categories | promotional-widget › Content category | Pick it from the website’s content categories, the ones posts are filed under in the content management system. A saved one that is not in the loaded list shows as Not in the list — saved ID …; publish, then reload, before you replace it — a reload loses unpublished changes |
Lifecycle and effects
SAVE NODE keeps a change in your browser tab only; Publish sends the page to the shop, and a reload before publishing loses the change. A setting left empty is not saved and the widget uses its own behaviour for it; opening a widget and saving without changes leaves its stored settings as they were. The full sequence is in Configuring Widgets › Lifecycle and effects.
Related applets
- CP Commerce Admin — decides who may publish, and holds the same pages under Layout Instance.
- Media Library — where the images these widgets show are uploaded.
Troubleshooting
| Symptom | Cause | Fix |
|---|---|---|
| The widget is empty on the shop | A record it shows is missing or inactive | Check the records its pickers point at |
| A change is gone after reload | The page was not published | Redo it and Publish before leaving |
| It shows on desktop but not on phones | It was added on a desktop platform only | Switch Platform and add it there too |
| SAVE NODE does nothing | Widget Config (JSON) holds invalid JSON | Fix or undo the JSON |
| A picker shows Not in the list — saved ID … | The record it saved was deleted, belongs to another website, or is not in the list as loaded | Publish what you have first (a reload loses unpublished changes), then reload; if it still shows, check the record before you pick a replacement |
| A picker shows The list is empty or could not be loaded | Nothing of that kind exists yet, or loading failed | Create the record first, or reload the page |
Related documentation
- Configuring Widgets in the Website Builder — placing, saving, previewing and publishing
- Website Builder — the other widget groups and the Website Builder pages