GuidesAPI ReferenceRelease Notes
HomeLog InHome
Guides

Widget builder concept

The widget builder lets content managers build CMS-configured widgets. In CMS, you set the widget content type, data source, layout, and supported design options. The developer references the widget ID in the app, and the SDK loads the widget settings from the backend. You can change supported widget settings on the fly without needing your developer to make changes.

What it is

A CMS-configured widget stores its configuration in the Experiences backend. Each widget gets a widget remote ID, which the developer uses to reference the widget in code.

The widget configuration is updated in the app after the widget loads or refreshes data again. See CMS-configured widgets.

How it works

flowchart LR
  cms[Content manager in CMS] -->|builds widget| widget[CMS widget]
  widget -->|assigns| remoteId[Widget remote ID]
  remoteId -->|handoff| dev[Developer]
  dev -->|places widget in app| sdk[SDK]
  sdk -->|loads backend settings| widget
  1. A content manager builds a widget in the CMS widget builder.
  2. CMS assigns a widget remote ID.
  3. The developer places the widget in the app using the ID.
  4. The SDK loads the backend settings when the widget runs.

What you can configure in the CMS widget builder

CMS-configured widgets use the same configuration areas as code-configured widgets, with a simpler set of options in CMS:

  • Content type: Stories, Moments, or Videos (set when you create the widget; it can't change later)
  • Data source: label rules with simple AND / OR priority
  • Layout: row, grid, or single-line presentation (set when you create the widget; it can't change later)
  • Design: presets in CMS, or In code for advanced styling

For now:

  • Advanced styling, such as detailed colors, fonts, widths, backgrounds, and text sizes, may need to be set in code.
  • More complex data source logic or For you data sources require code-configured widgets.

Related documentation

TopicDescription
Widget builder how toCreate, edit, and hand off widgets in the CMS UI
CMS-configured widgetsDeveloper path


Did this page help you?