GuidesAPI ReferenceRelease Notes
HomeLog InHome
Guides

Widget builder how to

Use these steps to build, manage, and hand off CMS-configured widgets. For what CMS-configured widgets are and how they work with the SDK, see Widget builder concept.

Open the Widgets tab

To open the Widgets tab:

  • In Arena, go to CMS > Widgets.
    The Widgets tab has Created and Archived views.

View and manage widgets

Widget list columns

In the Created view, the fields available are listed in the table that follows.

ColumnWhat it shows
Widget remote IDThe CMS-generated ID for the widget configuration. For example, xyz123. This is the ID the developer needs.
Internal nameThe CMS name that helps you identify the widget.
Data sourceLabels referenced by the widget.
TypeThe content type and layout, such as Moments and Row.
StatusThe status you set for the widget: Available or In use.

Create a widget

To create a widget:

  1. In Arena, go to CMS > Widgets.

  2. On the Created tab, select Create widget.
    The Create widget screen opens.

  3. Navigate through the Setup, Data, and Design sections to complete widget settings.

  4. Select Create.
    A widget remote ID is assigned. The developer needs this to deploy the widget in the app.

Setup section

The setup tab has the options listed in the table that follows.

AreaOptionDescription
ManagementContent type
  • Select from Stories, Moments, or Videos.
  • You can't change this later.
ManagementInternal nameEnter a CMS-only name that helps you identify the widget in the list.
ManagementWidget placement
  • Enter where the widget will appear in the app, such as a page or screen name.
  • This helps you manage your widgets, but it doesn't affect how they display in the app.
ManagementStatusSet the status yourself from the dropdown:
  • Available
  • In use
LayoutType
  • Select from Row, Grid, or Single.
  • You can't change this later.
LayoutMax items shownSet how many items the widget displays.

Data section

On the Data tab, configure how the widget selects and orders content.

AreaOptionDescription
Data sourceLabel condition
  • Select the labels that define which content appears in the widget.
  • Each condition box is an AND condition (up to 5 labels per box).
  • Select Add condition to add another box as an OR condition (up to 5 OR boxes).
  • OR order sets priority
  • Limitation: As set in labels.
Data sourceLimit resultsTurn on to limit the number of results returned by the data source.
Item orderDefault orderChoose how items are ordered, such as As set in labels, Newest first, and so on.
Item orderShow unread firstTurn on to show unread items before read items.

Design section

On the Design tab, configure the widget's appearance. Appearance may vary slightly between different operating systems.

AreaOptionDescription
Widget designDesign typeChoose how your layout is managed:
  • Presets (predefined designs; select Vertical, Horizontal, or Circle for orientation). Widget presets are set by the developer and are common to all widgets in your app.
  • In code (advanced design, such as colors, fonts, widths, backgrounds, and text sizes set by the developer in the SDK). The developer sets the layout in the context of the CMS-configured widget.

Edit a widget

To edit a widget:

  1. In Arena, go to CMS > Widgets.
  2. On the Created tab, find the widget by Internal name or use search and filters.
  3. Select Edit, then change settings as needed.
  4. Select Save changes.
    CMS updates appear in the app after the widget loads or refreshes data again (for example, through the app's normal reloadData flow). Tell the developer that CMS edits are not pushed into an already-loaded session.

Related documentation

TopicDescription
Widget builder conceptWhat CMS-configured widgets are and how they work with the SDK
WidgetsWidget types and code-configured vs CMS-configured widgets
Labels and schedulingLabels used in widget data sources


Did this page help you?