Skip to content

Button and Utility Widgets

This page covers the widgets for single buttons, back and scroll-to-top buttons and sticky text buttons. 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 jobScreen or tabRead
Add one of these widgets to a pageDesign Panel › Elements › Buttons & UtilitiesConfiguration
Change a widget that is already on the pageClick it on the canvas, Design Panel › Selected NodeIts section under Configuration
Know which settings need an ID, JSON or rich textSelected NodeFields
Make a change reach the shopSAVE NODE, then PublishConfiguring Widgets
Find out why a widget shows nothingTroubleshooting

Overview

The Buttons & Utilities group in the Elements tab holds 4 widgets: back-button, button-single, scroll-top-button, sticky-text-button-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

BeforeThese widgetsAfter
You can open the Website Builder and the page exists — User Permission Manager, Layout InstancePlaced on a page and configuredShoppers 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 Buttons & Utilities, 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.

back-button

Back button.

  1. In Elements, open Buttons & Utilities (or search back-button) and drag back-button onto the page.
  2. In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
    • General — Horizontal position; Vertical position; Page to open (pick a page); Is website builder
    • Button style — Color; Fill (clear / outline / solid); Size
    • Icon style — Color; Background
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

button-single

A single button with a link.

  1. In Elements, open Buttons & Utilities (or search button-single) and drag button-single onto the page.
  2. In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
    • General — 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)
    • Button — Color; Background; Border color; Border style; Border width; Border radius; Size; Height; Font; Weight; Font padding
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

scroll-top-button

Scroll-to-top button.

  1. In Elements, open Buttons & Utilities (or search scroll-top-button) and drag scroll-top-button onto the page.
  2. Selected Node shows This widget has no settings to configure. The widget reads nothing from its settings; give the node a recognisable Name if you like.
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

sticky-text-button-widget

Sticky text button.

  1. In Elements, open Buttons & Utilities (or search sticky-text-button-widget) and drag sticky-text-button-widget onto the page.
  2. In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
    • General — Page the button opens (pick a page); Label navigation; Open system browser; Is website builder
    • Style › Details — Color; Background; Text; Font
    • Style › Button — Color; Background; Icon
  3. 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. On this page that means: back-button with no Page to open takes the shopper back to the page they came from, and sticky-text-button-widget with no Page the button opens shows its text bar without the icon button.

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

SymptomCauseFix
The widget is empty on the shopA record it shows is missing or inactiveCheck the records its pickers point at
A change is gone after reloadThe page was not publishedRedo it and Publish before leaving
It shows on desktop but not on phonesIt was added on a desktop platform onlySwitch Platform and add it there too
SAVE NODE does nothingWidget Config (JSON) holds invalid JSONFix 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 loadedPublish 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 loadedNothing of that kind exists yet, or loading failedCreate the record first, or reload the page

Related documentation

Last updated on