--- schema_version: "1" id: 4a102aec1901155ccdbad808378caa16f1a51a50c5d4b2146904cc8031bf676e title: UiWidgetBundle (Beta) collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_uiwidgetbundle.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_uiwidgetbundle.htm source_site: developer.salesforce.com content_type: documentation content_hash: 5e3674abcd319f25271b36245d9e897f9ee9b1b08fb4c1b00ea9b7a52659231c description: Represents a widget. Use widgets to define reusable UI compositions once and deploy them across supported Salesforce applications and third-party platforms. Deploy this bundle to your Salesforce org to make the widget available. --- # UiWidgetBundle (Beta) Represents a widget. Use widgets to define reusable UI compositions once and deploy them across supported Salesforce applications and third-party platforms. Deploy this bundle to your Salesforce org to make the widget available. ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png) #### Note This feature is a beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/ "HTML (New Window)") or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/ "HTML (New Window)"). Use of this pilot or beta service is at the Customer's sole discretion. ![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Parent Type This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field. ## File Structure and Directory Location UiWidgetBundle components are stored in the uiWidgets folder. Here’s an example of the UiWidgetBundle structure. +--myMetadataPackage     +--uiWidgets (1)         +--WIDGET\_NAME (2) +--WIDGET\_NAME.json (3) +--WIDGET\_NAME.uiwidget-meta.xml(4) +--schema.json (5) The bundle includes these resources. - The uiWidgets folder (1) contains a folder for each created widget in the format {widgetName} (2). - Each widget folder contains a {widgetName}.json file (3) that defines the JSON UI composition structure for the widget, specifying the component layout, nesting, and data bindings. - Each widget folder also contains a  {widgetName}.uiwidget-meta.xml file (4) that defines the widget type. - Finally, an optional schema.json file (5) defines the attribute contract—the attributes and their associated Lightning types the widget accepts. ## Version UiWidgetBundle components are available in API version 67.0 and later. ## Fields | Field Name | Description | | --- | --- | | description | Field Type string Description Required. Describes the widget. | | masterLabel | Field Type string Description Required. Represents the name of a widget bundle which is defined when the UiWidgetBundle is created. | | widgetType | Field Type string Description Required. Represents the widget type. The only allowed value is JSON. | ## Declarative Metadata Sample Definition This package.xml file retrieves all the UiWidgetBundle components in an org.              \*         UiWidgetBundle          67.0 In the retrieved .zip file, each widget is nested under a uiWidgets folder. This example shows the directory structure in the .zip file of a widget named hotelCard: +--uiWidgets +--hotelCard +--schema.json +--hotelCard.json +--hotelCard.uiwidget-meta.xml Here are the contents of the files in the hotelCard directory. This sample code shows the contents of the schema.json file. { "title": "Hotel Card Widget", "description": "Displays hotel information as a visual card", "type": "object", "properties": { "attributes": { "lightning:type": "lightning\_\_objectType", "properties": { "title": { "title": "Hotel Name", "description": "Primary heading displayed at the top", "lightning:type": "lightning\_\_textType" }, "imageUrl": { "title": "Image URL", "description": "URL of the hotel image", "lightning:type": "lightning\_\_urlType" }, "price": { "title": "Price Per Night", "description": "Nightly rate displayed as currency", "lightning:type": "lightning\_\_numberType" }, "description": { "title": "Description", "description": "Short description of the hotel", "lightning:type": "lightning\_\_textType" } } } } } Contents of the hotelCard.json file. { "type": "lightning\_\_agentforceWidget", "contentBody": { "widgetBody": { "definition": "tile/widget", "children": \[ { "definition": "tile/card", "attributes": { "padding": "lg", "variant": "default", "maxWidth": "full" }, "children": \[ { "definition": "tile/image", "attributes": { "src": "{!$attrs.imageUrl}", "alt": "{!$attrs.title}" } }, { "definition": "tile/text", "attributes": { "text": "{!$attrs.title}", "variant": "h3", "weight": "semibold" } }, { "definition": "tile/text", "attributes": { "text": "{!$attrs.price}", "variant": "body", "weight": "medium" } }, { "definition": "tile/text", "attributes": { "text": "{!$attrs.description}", "variant": "body" } } \] } \] } } } Contents of the hotelCard.uiwidget-meta.xml file. Hotel Card Displays hotel information as a visual card. JSON ## Wildcard Support in the Manifest File This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders."). #### See Also - [Headless Experience Layer Developer Guide (Beta)](https://developer.salesforce.com/docs/platform/hxl/guide/get-started.html "Headless Experience Layer Developer Guide (Beta) - html (New Window)")