UIBundle

Represents the UI of a Salesforce Multi-Framework app, such as a React app.

This type extends Metadata and inherits its fields.

UIBundle components have the suffix .uibundle-meta.xml and are stored in the uiBundles/``your_app folder.

Introduced in API version 66.0.

Ensure that the Salesforce app domain is enabled for your org in React Development with Salesforce Multi-Framework in Setup.

The UIBundle metadata type can contain up to 2,500 files.

• Type: string
• Required: No
• Description: A description of what the web application does.

• Type: boolean
• Required: Yes
• Description: Required. Specifies whether the web application is accessible (true) or not (false).

• Type: boolean
• Required: No
• Description: For internal use only.

• Type: string
• Required: Yes
• Description: Required. Specifies the web-application name that appears in the UI.

• Type: string (enumeration of type string)
• Required: No
• Introduced: API version 67.0
• Description: Specifies the Salesforce target where the app is supported.
• Possible values:
  • AppLauncher — Deprecated in API version 67.0. Instead, use CustomApplication. Makes the app available in the App Launcher.
  • CustomApplication — When used with the CustomApplication metadata type, makes the app available in the App Launcher. This is the default target if you don’t specify a value. Available in API version 67.0 and later.
  • Experience — Indicates that the app is an external-facing site or portal and makes it available in the Digital Experiences app.

• Type: string
• Required: Yes
• Description: Required. Indicates the version of the web application.

The following is an example of a UIBundle component.

1<UIBundle xmlns="http://soap.sforce.com/2006/04/metadata">
2    <masterLabel>Customer Portal</masterLabel>
3    <description>Customer self-service portal built with React.</description>
4    <isActive>true</active>
5    <target>Experience</target>
6    <version>1</version>
7</UIBundle>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>UIBundle</name>
6    </types>
7    <version>66.0</version>
8</Package>

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.