Widget Configuration File

The {widgetName}.uiwidget-meta.xml file is a required resource in every widget bundle that specifies the widget type.

This table lists the configuration fields that you specify inside the {widgetName}.uiwidget-meta.xml file.

FieldRequired or OptionalDescription
widgetTypeRequiredThe widget implementation type. JSON is currently the only supported widget type and indicates a composition-based widget.
masterLabelOptionalName for the widget
descriptionOptionalDescription for the widget

This code example shows the required configuration structure for a widget configuration file.

1<?xml version="1.0" encoding="UTF-8"?>
2<UiWidgetBundle xmlns="http://soap.sforce.com/2006/04/metadata">
3    <masterLabel>Hotel Card</masterLabel>
4    <description>Displays hotel information as a visual card.</description>
5    <widgetType>JSON</widgetType>
6</UiWidgetBundle>

Beta Feature

Headless Experience Layer is a pilot or beta service that is subject to the Beta Services Terms at Ageements - Salesforce.com or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the Product Terms Directory. Use of this pilot or beta service is at the Customer's sole discretion.