Header and Navigation Widgets
This page covers the widgets for the top of every page: the logo, the menu, the search bar and the small menus a shopper uses to move around. 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 › Headers & Navigation | 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 Headers & Navigation group in the Elements tab holds 20 widgets. This page describes 17 of them: bordered-tab-menu-widget, custom-header, general-header, horizontal-menu, horizontal-menu-list-widget, logo-widget, menu-btn, menu-slider, mobile-header, mobile-tab-menu, responsive-header, scrollable-menu-widget, searchbar-widget, tab-menu, vertical-menu, vertical-menu-list-widget, welcome-header. The other three are layouts built for individual shops and are not described here.
Most shops place one header widget in the page’s header layout rather than on every page, so it is shared. The menus these widgets show come from Menu Manager — when a header shows an empty menu, check first that the menu list it points at has items there. 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 Headers & Navigation, 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.
bordered-tab-menu-widget
Tab menu with borders.
- In Elements, open Headers & Navigation (or search bordered-tab-menu-widget) and drag bordered-tab-menu-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 — Menu list (pick from list)
- Style — Color; Font; Slides per view
- Style › Active — Color
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
custom-header
Custom header (demo).
- In Elements, open Headers & Navigation (or search custom-header) and drag custom-header onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- General — Menu list (pick from list); Second menu list (pick from list); Mobile; Sticky; Cart page (pick a page); Search results page (pick a page); Icon colour; Background colour; Show search Button; Color search Button; Text search Button; Hide cart; Show logo
- General, continued — Show menu; Show back; Config search bar; Font; Searchbar position (top / bottom / left / right / center); Menu position (top / bottom / left / right / center); Border; Text transform (uppercase / lowercase / capitalize); Text; Destination URL; Link type (COMPONENT / PAGE / CONTENT CATEGORY / EXTERNAL LINK / LAYOUT INSTANCE LINK / postGuid / postName / CATEGORY / LAYOUT INSTANCE); External link target (_blank / _self / _top / _system); Position (top / bottom / left / right / center)
- Style — Color; Font
- Style › Badge — Color; Background
- Sub menu style — Type (VERTICAL_NESTED / HORIZONTAL_NESTED / HORIZONTAL_NESTED_STATIC); Display image; Display button; Display name; Full display; Weight; Size; Icon; Color; Font; Background; Border
- Sub menu style › Button — Color; Background
- Badge style — Color; Background
- Search style — Search background; Search shadow
- Category details — Category (pick from list); Category group (pick from list)
- Logo — Position (top / bottom / left / right / center); Height; Width; Margin; Margin top; Margin bottom; Margin left; Margin right
- Click route config — Forward URL; Query params (JSON)
- Header config — Height; Margin; Margin top; Margin bottom; Margin left; Margin right
- Sub menu config — Menu list (pick from list); Display entity; Display logo; Full display; Line length; Font family
- Sub menu config › Logo — Height; Width
- Button — Color; Background; Border color; Border style; Border width; Border radius; Size; Height; Font; Weight
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
Marked in the code as a demonstration widget to be removed; do not build a live page on it.
general-header
General website header.
- In Elements, open Headers & Navigation (or search general-header) and drag general-header onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- General — Sticky; Search results page (pick a page); Icon colour; Background colour; Font colour; Show search Button; Color search Button; Text search Button; Hide cart; Font; Border
- Badge style — Color; Background
- Search style — Search background; Search shadow
- Menu style — Color; Background; Disable parent route
- Category details — Category (pick from list); Category group (pick from list)
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
horizontal-menu
Horizontal menu.
- In Elements, open Headers & Navigation (or search horizontal-menu) and drag horizontal-menu onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- General — Menu list (pick from list); Background color; Color; Hover color; Hover background color; Sub menu background color; Sub menu hover color; Sub menu hover background color
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
horizontal-menu-list-widget
Horizontal menu from a menu list.
- In Elements, open Headers & Navigation (or search horizontal-menu-list-widget) and drag horizontal-menu-list-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 — Menu list (pick from list); Mobile; Items per column
- Style — Color; Font; Text size; Icon size
- Style › Badge — Color; Background
- Sub menu style — Type (VERTICAL_NESTED / HORIZONTAL_NESTED / HORIZONTAL_NESTED_STATIC); Display image; Display button; Display name; Full display; Disable right click; Weight; Size; Icon; Color; Font; Background; Border; Border radius; Padding top; Padding bottom; Padding left; Padding right; Margin; Margin top; Margin bottom; Margin left; Margin right; Width
- Sub menu style › Button — Color; Background
- Menu container style — Left; Position
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
logo-widget
Website logo.
- In Elements, open Headers & Navigation (or search logo-widget) and drag logo-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; Logo URL; Logo desktop only; Width; Height
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
Tick Logo to show the website’s own logo. Untick it and fill in Logo URL to show a different image instead.
menu-btn
Menu buttons.
- In Elements, open Headers & Navigation (or search menu-btn) and drag menu-btn onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- General — Button details (a list; each item has Button URL, Button name, Button image URL)
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
menu-slider
Sliding menu.
- In Elements, open Headers & Navigation (or search menu-slider) and drag menu-slider onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- General — Menu list (pick from list); Visible items
- Style › Button — Color; Background
- Style › Text — Color
- Style — Shape
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
mobile-header
Header for mobile screens.
- In Elements, open Headers & Navigation (or search mobile-header) and drag mobile-header onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- General — Sticky; Cart page (pick a page); Search results page (pick a page); Icon colour; Background colour; Show search Button; Color search Button; Text search Button; Hide cart; Show logo; Show menu; Show back; Config search bar; Font; Searchbar position (top / bottom / left / right / center); Menu position (top / bottom / left / right / center); Border; Text transform (uppercase / lowercase / capitalize); Is website builder; Over write current logo URL
- Badge style — Color; Background
- Search style — Search background; Search shadow
- Category details — Category (pick from list); Category group (pick from list)
- Logo — Position (top / bottom / left / right / center); Height; Width; Margin; Margin top; Margin bottom; Margin left; Margin right
- Menu — Padding top; Padding bottom; Padding left; Padding right
- Click route config — Forward URL; Query params (JSON)
- Header config — Height; Margin; Margin top; Margin bottom; Margin left; Margin right
- Sub menu config — Menu list (pick from list); Display entity; Display logo; Full display; Line length; Font family
- Sub menu config › Logo — Height; Width
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
mobile-tab-menu
Bottom tab menu for mobile.
- In Elements, open Headers & Navigation (or search mobile-tab-menu) and drag mobile-tab-menu onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- General — Menu list (pick from list)
- Style — Color; Background; Border
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
responsive-header
Responsive header for all screen sizes.
- In Elements, open Headers & Navigation (or search responsive-header) and drag responsive-header onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- General — Is website builder; Sticky; Search results page (pick a page); Icon colour; Background colour; Font colour; Show search Button; Color search Button; Text search Button; Hide cart; Font; Border; Menu list (pick from list); User menu list (pick from list); Logo scale web; Logo scale mobile; Items per column; Show all submenus at once; Show only logo and search on mobile; Show only back button and title on mobile; Show only title and search on mobile; Show backbutton and opened search; Hide search ui; Hide mobile search; Focused search
- Badge style — Color; Background
- Search style — Search background; Search shadow
- Menu style — Color; Background; Disable parent route
- Category details — Category (pick from list); Category group (pick from list)
- Container styles — Background
- Menu styles — Background; Color; Size; Menu list justify content
- Icon styles — Color; Border
- Mat menu styles — Color
- Menu item style — Color; Font; Size; Icon; Weight
- Menu item hover style — Background; Color; Font; Size; Icon; Weight
- Drop menu styles — Display image; Display button; Display name; Full display; Disable right click; Border radius; Background; Border; Fixed column; Padding top; Padding bottom; Padding left; Padding right; Margin; Margin top; Margin bottom; Margin left; Margin right; Width
- Drop menu styles › Button — Color; Background
- Hamburger styles — Background
- Click route config — Forward URL; Query params (JSON)
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
Menu list and User menu list each pick a menu made in Menu Manager; edit the menu there to change its items on every page that uses this header.
scrollable-menu-widget
Scrollable menu.
- In Elements, open Headers & Navigation (or search scrollable-menu-widget) and drag scrollable-menu-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 — Menu list (pick from list)
- Style — Font; Active; Color
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
searchbar-widget
Search bar.
- In Elements, open Headers & Navigation (or search searchbar-widget) and drag searchbar-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 — Enable toggle; Search results page (pick a page); Show search Button; Enable custom search bar
- Style › Searchbar — Color; Background; Border radius
- Style › Button — Color; Background
- Style — Shadow; Searchbar container width; Width
- Style › Icon — Color
- Custom search bar styles — Min witdh; Min height; Hide search button; Button height; Input margin top; Button margin top
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
tab-menu
Tab menu.
- In Elements, open Headers & Navigation (or search tab-menu) and drag tab-menu onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- General — Menu override; Show tab menu; Menu list (pick from list)
- Style — Color; Background; Border
- Style › Active — Color
- Style › Badge — Color; Background
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
vertical-menu
Vertical menu.
- In Elements, open Headers & Navigation (or search vertical-menu) and drag vertical-menu onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- General — Menu list (pick from list)
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
vertical-menu-list-widget
Vertical menu from a menu list.
- In Elements, open Headers & Navigation (or search vertical-menu-list-widget) and drag vertical-menu-list-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 — Menu list (pick from list)
- Style — Color; Font; Col; Col sm
- Style › Parent — Color; Font
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
welcome-header
Welcome greeting header.
- In Elements, open Headers & Navigation (or search welcome-header) and drag welcome-header onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- General — Welcome msg; Welcome email; Welcome phone; Text 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 | custom-header › Query params; mobile-header › Query params; responsive-header › Query params | Invalid JSON shows JSON is invalid and is not saved; the last valid value stays |
| Categories | custom-header › Category; general-header › Category; mobile-header › Category; responsive-header › Category | Pick the product category by name; each is shown as Group › Category, and the search box finds it by either. 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 |
| Category groups | custom-header › Category group; general-header › Category group; mobile-header › Category group; responsive-header › Category group | Pick the product category group by name. 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 |
| Menu lists | bordered-tab-menu-widget › Menu list; custom-header › Menu list; custom-header › Second menu list; horizontal-menu › Menu list; horizontal-menu-list-widget › Menu list; menu-slider › Menu list; mobile-header › Menu list; mobile-tab-menu › Menu list; responsive-header › Menu list; responsive-header › User menu list; scrollable-menu-widget › Menu list; tab-menu › Menu list; vertical-menu › Menu list; vertical-menu-list-widget › Menu list | Pick it by name from the website’s menu lists, the ones made in Menu Manager. 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