---
schema_version: "1"
id: eab24c37a7b214752a14faee30f15dd554ca7c8f02d3dd2b66f7ca24e10d87c6
title: LightningExperienceTheme
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_lightningexperiencetheme.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_lightningexperiencetheme.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: bd5f1413e7b51e4ab07737ed52342c90ce66441f96bf85f4c436ed67dbd31c4f
description: 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.
---
# LightningExperienceTheme

Represents the details of a custom theme, including the [BrandingSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_brandingset.htm#meta_brandingset "Represents the definition of a set of branding properties for an Experience Builder site or for your org's Lightning Experience theme."). 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.

To activate a custom theme with Metadata API, set the activeThemeField on the [LightningExperienceSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_lightningexperiencesettings.htm "Represents the settings that modify an org’s Lightning Experience configuration. This type extends the Metadata metadata type and inherits its fullName field.") component to the API name of the LightningExperienceTheme.

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

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

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d629252e129">Field Name</th>

              <th class="featureTableHeader  " id="d629252e132">Field Type</th>

              <th class="featureTableHeader  " id="d629252e135">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d629252e129" data-title="Field Name"><span class="keyword parmname">defaultBrandingSet</span></td>

              <td class="entry" headers="d629252e132" data-title="Field Type">string</td>

              <td class="entry" headers="d629252e135" data-title="Description">Required. The ID of the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_brandingset.htm#meta_brandingset" title="Represents the definition of a set of branding properties for an Experience Builder site or for your org's Lightning Experience theme.">BrandingSet</a> properties associated with this
                LightningExperienceTheme.</td>

            </tr>

            <tr>
              <td class="entry" headers="d629252e129" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d629252e132" data-title="Field Type">string</td>

              <td class="entry" headers="d629252e135" data-title="Description">The optional description text of this LightningExperienceTheme. Limited to 1000
                characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d629252e129" data-title="Field Name"><span class="keyword parmname">designSystemVersion</span></td>

              <td class="entry" headers="d629252e132" data-title="Field Type">LightningDesignSystemVersion (enumeration of type string)</td>

              <td class="entry" headers="d629252e135" data-title="Description">Represents the version of Salesforce Lightning Design System (SLDS) on which
                the theme is built.<p class="p">Valid values are:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">SLDS_v1</samp></li>

                  <li class="li"><samp class="codeph nolang">SLDS_v2</samp></li>

                </ul>
                <p class="p">If you don’t define a value, the default value is <samp class="codeph nolang">SLDS_v1</samp>.</p>
                <p class="p">Available in API version 64.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d629252e129" data-title="Field Name"><span class="keyword parmname">isDarkModeEnabled</span></td>

              <td class="entry" headers="d629252e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d629252e135" data-title="Description">Indicates whether individual users can enable dark mode (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>) for this LightningExperienceTheme. The default value is <samp class="codeph nolang">false</samp>. Available for custom SLDS 2 themes in select
                editions. See <a class="xref" href="https://help.salesforce.com/s/articleView?id=xcloud.customize_ui_enhancedlex.htm&amp;type=5&amp;language=en_US" target="_blank">Salesforce Cosmos Theme and SLDS 2
                  Availability</a>. Available in API version 65.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d629252e129" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d629252e132" data-title="Field Type">string</td>

              <td class="entry" headers="d629252e135" data-title="Description">Required. The label for this LightningExperienceTheme, which displays in Setup.
                Limited to 70 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d629252e129" data-title="Field Name"><span class="keyword parmname">shouldOverrideLoadingImage</span></td>

              <td class="entry" headers="d629252e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d629252e135" data-title="Description">If <samp class="codeph nolang">true</samp>, the LightningExperienceTheme
                overrides the splash screen image.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a LightningExperienceTheme component. See [BrandingSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_brandingset.htm#meta_brandingset "Represents the definition of a set of branding properties for an Experience Builder site or for your org's Lightning Experience theme.") for an example of the BrandingSet component.

<?xml version="1.0" encoding="UTF-8"?>
<LightningExperienceTheme xmlns="http://soap.sforce.com/2006/04/metadata">
    <defaultBrandingSet\>SummerCelebrationBrand</defaultBrandingSet\>
    <description\>Theme for summer celebration week.</description\>
    <masterLabel\>Summer Celebration</masterLabel\>
    <shouldOverrideLoadingImage\>false</shouldOverrideLoadingImage\>
</LightningExperienceTheme\>

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\>LEXTHEMINGThemeName</members\>
        <name\>BrandingSet</name\>
    </types\>
    <types\>
    	<members\>Summer Celebration</members\>
    	<name\>LightningExperienceTheme</name\>
    </types\>
    <version\>42.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).