CMS-configured widgets

CMS-configured widgets let content managers control widget settings using CMS while you, the developer, place the widget in the app. The SDK loads the current widget configuration from the backend when the widget runs.

• For developers: use this guidance to integrate a CMS-configured widget in code.
• For content managers: build and edit widgets in CMS; they don't need these steps. See Widget builder concept and Widget builder how to.
• Widgets overview: Widgets

SDK availability

CMS-configured widgets (SDK widgetRemoteIdentifier / widget remote ID) are available starting with: Android 1.20.3 | iOS 1.20.0 | Web 0.36.3 | React Native 1.20.0.

What you do in the app

1. Place the Stories, Moments, or Videos widget in your app UI. Use the same content type and layout (Row, Grid, or Single) that the content manager set in CMS.
2. Ask the content manager to share the widget remote ID available in CMS.
3. Set widgetRemoteIdentifier to the widget remote ID when you initialize the widget.
4. Keep a local layout and data source as a fallback if the CMS request fails.
5. After CMS widget changes, load the widget again or call reloadData so the app picks up the new configuration.

API reference: iOS | Android | Web | React Native.

If you need advanced design or data source logic that CMS doesn't support yet, use a code-configured widget instead.

Related documentation