---
schema_version: "1"
id: 23037e152968698893827180dbddaaf9b31e1d0e351c9f764776bcf20fcbdd96
title: UIBundle
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_uibundle.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_uibundle.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 28e80f769a805ffd8cec6c63b1f2ecf4dda78fd5c3f158307ff69484cf556201
description: Represents the UI of a Salesforce Multi-Framework app, such as a React app.
---
# UIBundle

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

![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.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

UIBundle components have the suffix .uibundle-meta.xml and are stored in the uiBundles/your\_app folder.

## Version

UIBundle components are available in API version 66.0 and later.

## Special Access Rules

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.

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

A description of what the web application does.



 |
| isActive | 

Field Type

boolean

Description

Required. Specifies whether the web application is accessible (true) or not (false).



 |
| isProtected | 

Field Type

boolean

Description

For internal use only.



 |
| masterLabel | 

Field Type

string

Description

Required. Specifies the web-application name that appears in the UI.



 |
| target | 

Field Type

string

Description

Specifies the Salesforce target where the app is supported. Valid values are:

- 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.





 |
| version | 

Field Type

string

Description

Required. Indicates the version of the web application.



 |

## Declarative Metadata Sample Definition

The following is an example of a UIBundle component.

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

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

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>UIBundle</name\>
    </types\>
    <version\>66.0</version\>
</Package\>

## 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.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [_Agentforce Vibes Developer Guide_: Build a React App with Salesforce Multi-Framework (Beta)](https://developer.salesforce.com/docs/platform/einstein-for-devs/guide/reactdev-overview.html "Agentforce Vibes Developer
    Guide: Build a React App with Salesforce Multi-Framework (Beta) - html (New Window)")