Metadata API Developer Guide
jNewer Version Available
LightningExperienceTheme
Represents the details of a custom theme,
including the BrandingSet. Themes enable admins to specify
configurable attributes, such as three colors and five images. The colors and some of the
images override SLDS token values and influence the generation of
app.css.
File Suffix and Directory Location
LightningExperienceTheme components have the suffix .lightningExperienceTheme and are stored in the lightningExperienceThemes folder.
Version
LightningExperienceTheme components are available in API version 42.0 and later.
Special Access Rules
The LightningExperieceTheme type is available when the S1DesktopAllowed permission is enabled in your org.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| defaultBrandingSet | string | Required. The ID of the BrandingSet properties associated with this LightningExperienceTheme. |
| description | string | The optional description text of this LightningExperienceTheme. Limited to 1000 characters. |
| masterLabel | string | Required. The label for this LightningExperienceTheme, which displays in Setup. Limited to 70 characters. |
| shouldOverrideLoadingImage | boolean | If true, the LightningExperienceTheme overrides the splash screen image. |
Declarative Metadata Sample Definition
The following is an example of a LightningExperienceTheme component. See BrandingSet for an example of the BrandingSet component.
1<?xml version="1.0" encoding="UTF-8"?>
2<LightningExperienceTheme xmlns="http://soap.sforce.com/2006/04/metadata">
3 <defaultBrandingSet>SummerCelebrationBrand</defaultBrandingSet>
4 <description>Theme for summer celebration week.</description>
5 <masterLabel>Summer Celebration</masterLabel>
6 <shouldOverrideLoadingImage>false</shouldOverrideLoadingImage>
7</LightningExperienceTheme>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>LEXTHEMINGThemeName</members>
5 <name>BrandingSet</name>
6 </types>
7 <types>
8 <members>Summer Celebration</members>
9 <name>LightningExperienceTheme</name>
10 </types>
11 <version>42.0</version>
12</Package>