-
Notifications
You must be signed in to change notification settings - Fork 18
Update Theme Definition
As new features are added to the theme, the preview images and descriptions should be updated accordingly. This page walks through the process of creating an updated theme definition. One is unable to modify the current theme definition within Salesforce and instead, a new Theme Definition must be created and merged into the repository.
Configure build.xml task retrieveChangeSet
to pull code into a folder other than src
. The following example keeps each package in its own sub directory of retrieveUnpackaged
where pkgName
is the name of the change set.
<target name="retrieveChangeSet">
<mkdir dir="retrieveUnpackaged/${sf.pkgName}" />
<sf:retrieve username="${sf.username}"
password="${sf.password}"
sessionId="${sf.sessionId}"
serverurl="${sf.serverurl}"
maxPoll="${sf.maxPoll}"
pollWaitMillis="${sf.pollWaitMillis}"
retrieveTarget="retrieveUnpackaged/${sf.pkgName}"
packageNames="${sf.pkgName}"
/>
</target>
Community Theme preview images have fixed proportions. After taking any screenshots, open your favorite image editing software and paste the images into a 1260x820px canvas and save. Otherwise, the preview images may be cropped or not presented as intended.
- Open Experience Builder
- Settings > Developer > Export a Theme
- Fill out all fields, add images as desired
- Create Change Set, adding new Community Theme Definition to it
- Click View/Add Dependencies, add Static Resources that have a title of
siteAsset_*
to the change set ant retrieveChangeSet
- Copy new descriptions, titles, and image references into
communityThemeDefinitions/USWDS_Lightning_Community.communityThemeDefinition
. Note, images appear in their own<bundlesInfo>
element. - Add Static Resource references into package.xml
- Remove old Static Resource references from package.xml and
staticresources
folder
An example diff is below which shows the differences between v1.3 and v1.2.
<type>Highlight</type>
</bundlesInfo>
<bundlesInfo>
- <description>Base theme and components tested for 508 compliance and meets WCAG AA standard.</description>
+ <description>The Identifier component helps agencies clearly denote ownership of the site as well as providing links to key resources such as Privacy Policy, FOIA Requests, Accessibility statements, and USA.gov. https://designsystem.digital.gov/components/identifier/</description>
<order>3</order>
- <title>508 Compliant</title>
+ <title>Identifier</title>
<type>Highlight</type>
</bundlesInfo>
<bundlesInfo>
- <image>siteAsset_73208940f50844eb9e9d529e49f3b79a</image>
+ <description>Starting from a mobile-first base, the desktop experience can be adjusted to provide standard page width (936px), widescreen (1312px), or full width.</description>
+ <order>4</order>
+ <title>Widescreen View</title>
+ <type>Highlight</type>
+ </bundlesInfo>
+ <bundlesInfo>
+ <image>siteAsset_6269382aeaeb4500860a2db12f34b873</image>
<order>1</order>
- <title>siteAsset_73208940f50844eb9e9d529e49f3b79a</title>
+ <title>siteAsset_6269382aeaeb4500860a2db12f34b873</title>
<type>PreviewImage</type>
</bundlesInfo>
<bundlesInfo>
- <image>siteAsset_6defa8943c1147a29c8eb9a3ff4cbc4e</image>
+ <image>siteAsset_60bed73cf7234f8ea58510320465d20c</image>
<order>2</order>
+ <title>siteAsset_60bed73cf7234f8ea58510320465d20c</title>
+ <type>PreviewImage</type>
+ </bundlesInfo>
+ <bundlesInfo>
+ <image>siteAsset_6defa8943c1147a29c8eb9a3ff4cbc4e</image>
+ <order>3</order>
<title>siteAsset_6defa8943c1147a29c8eb9a3ff4cbc4e</title>
<type>PreviewImage</type>
</bundlesInfo>
<defaultBrandingSet>USWDS_Lightning_Community</defaultBrandingSet>
- <description>A US Web Design System Theme for Lightning Communities. https://designsystem.digital.gov/</description>
+ <description>A US Web Design System Theme for Lightning Communities. Contribute at https://github.com/GSA/uswds-sf-lightning-community</description>
<enableExtendedCleanUpOnDelete>true</enableExtendedCleanUpOnDelete>
<masterLabel>USWDS Lightning Community</masterLabel>
<publisher>U.S. GSA</publisher>
-
Spotlight
- List and links of sites using the theme.
For Developers
Repo Maintainers
- Icon Assets
- Release Process
- Testing Instructions
- Theme Updates/ Upgrades
Users
- Community Setup
- Supported Components
-
Theme Settings
- A guide for all theme level settings and configuration options.