Skip to content

Commit 211001a

Browse files
committed
docs: expand UI bundle description in command help
1 parent 3cddf3d commit 211001a

1 file changed

Lines changed: 1 addition & 2 deletions

File tree

messages/ui-bundle.dev.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,14 @@
33
Preview a UI bundle locally and in real-time, without deploying it to your org.
44

55
# description
6+
A UI bundle refers to an application that runs on Salesforce Platform that uses a non-native UI framework, such as React. Salesforce provides native UI frameworks, such as Lighting Web Components (LWC), to build applications that run on the Salesforce Platform. But you can also use non-native JavaScript- or TypeScript-based UI frameworks, such as React, to build a UI experience for the Salesforce Platform and that you can launch from the App Launcher. UI bundles are defined by the UiBundle metadata type in your DX project.
67

78
This command starts a local development (dev) server so you can preview a UI bundle using the local metadata files in your DX project. Using a local preview helps you quickly develop UI bundles, because you don't have to continually deploy metadata to your org.
89

910
The command also launches a local proxy server that sits between your UI bundle and Salesforce, automatically injecting authentication headers from Salesforce CLI's stored tokens. The proxy allows your UI bundle to make authenticated API calls to Salesforce without exposing credentials.
1011

1112
Even though you're previewing the UI bundle locally and not deploying anything to an org, you're still required to authorize and specify an org to use this command.
1213

13-
Salesforce UI bundles are represented by the UiBundle metadata type.
14-
1514
# flags.name.summary
1615

1716
Name of the UI bundle to preview.

0 commit comments

Comments
 (0)