2.1.0

⚠️ This release contains destructive changes per issue #183. See Upgrading instructions below. ⚠️

What's Changed

Full Changelog: v2.0.0...v2.1.0

Automated Tests

An additional 15 tests have been added to the codebase.

• Banner (1) #192
• Card List (1) #180
• Hero (5) #181
• Identifier (8) #165

New USWDS Components

• #181 USWDS Hero

Other Updates

• #111 Created fully-fledged demo site which can be deployed to orgs and enable users to quickly get up to speed on the components and features of the theme.
• #177 Updated external dependencies to resolve vulnerabilities in third party libraries.
• #178 Shorted community theme definition which was preventing deployment of codebase.
• #180 Added information about accessibility testing and contribution protocols. Included alt text validation for Hero and Card components.
• #182 Adjusted height of theme body to ensure sites with limited content consume the full screen height.
• #183 Removed uswdsNavBar component from codebase.
• #184 Updated the scratch org definition to turn off Lightning Web Security for new scratch orgs. This was done to enable support for automated tests.
• #189 Ensured all components load uswds-init.js. This was not known to cause issues but update was made proactively.
• #192 Fixed bug which caused the Banner component when navigating between different theme layouts.

Upgrade Instructions

• Be sure to run the latest version of the SFDX CLI npm update --global sfdx-cli
• Install latest updates from package.json npm update
• Follow steps in Destructive Changes to deploy v2.1.0

Destructive Changes

The uswdsNavBar component has been removed per issue #183 . Broadly speaking, it should not be in use as the controller functionality was never built would not work. That being said, teams should take steps to replace it in the event it is used.

• Deploy src/ to target org.

sfdx force:mdapi:deploy -d src/ -w 100 -u {username}

• In each community check for use of the uswdsNavBar component and replace it with uswdsMegaMenu. Set the Main Nav Menu Name to that of the navigationMenu you hope to reference.

• Save and publish the changes

• Deploy the v2.1.0 destructive changes to the org. This will delete the uswdsNavBar component.

  sfdx force:mdapi:deploy -d deprecationManifests/v2.1.0 -w 100 -u {username}

• If errors are thrown, one of the communities may still be using the component. Update and redeploy.

Dependencies and security

0 vulnerabilities in regular dependencies

5 vulnerabilities in devDependencies (development dependencies)

Release ZIP SHA-256 hash: ff824060b498668e7b1b742d73591e7705bca1ddd8e26d031b782eb1a2826c37

Contributors

Many thanks to the folks who have contributed code, ideas, and reported bugs!

@mvogelgesang @carchiere @freemacj @choughSFDC @ToddBrown-Github

2.0.0

USWDS SF Lightning Community 2.0.0

This is labeled as a major release due to the fact that a number of new components were introduced and automated testing has been implemented.

What's Changed

Full Changelog: v1.4.2...v2.0.0

Automated Tests

The introduction of automated tests represents a major step forward for this project and brings with it a level of certainty for future releases.

• #107 Leveraging the Lightning Test Service, 92 tests were built using the Jasmine test runner and cover the following components either in full or partially. Setup instructions are included in CONTRIBUTING.md
  • 404 Page (8)
  • Builder Notification (3)
  • USA Banner (6)
  • USWDS Card List (2)
  • USWDS Collection Element (6)
  • USWDS Collection List (2)
  • USWDS Pagination (23)
  • USWDS Step Indicator (9)
  • USWDS Step Indicator Heading (4)
  • USWDS Step Indicator Segment (5)
  • USWDS Search (1)
  • USWDS Tag (5)
  • USWDS Theme (18)
• #161 VSCode Code Snippets have been added to aid the development of test files as well as test components (describe, it, then). Code snippets allow for the quick scaffolding of test files and related segments.
  

New USWDS Components

• #139 Breadcrumb (USWDS Overview)
• #145 Collection (USWDS Component Overview)
• #142 Step Indicator (USWDS Component Overview)
• #146 Tag (USWDS Component Overview)

Other Updates

• #154 Builder Notification Component - Created to replace the Lightning Notifications Library component which caused Jasmine tests to break. Builder Notification operates in much the same way and also prints errors out to the console. Note if errors go unresolved, they will be exposed to users upon publishing!

Upgrade Instructions

There are no breaking changes in this release and no manual actions are required in community builder.

In preparation for installation, do the following:

• Be sure to run the latest version of the SFDX CLI npm update --global sfdx-cli
• Install latest updates from package.json npm update

Dependencies and security

0 vulnerabilities in regular dependencies

0 vulnerabilities in devDependencies (development dependencies)

Release ZIP SHA-256 hash: 90f6c35b7655136669482793d937c56c0b141f563e2a4e15de780cb9adcbb8f0

1.4.2

What's Changed

Full Changelog: 1.4.1...v1.4.2

• Hotfix 20220103 by @mvogelgesang in #119

Upgrade Instructions

• No specific steps required beyond deploying code

Release ZIP SHA-256 hash: 8b9be1f64be2158619851256ba1541a11d32060b0fc7c8e7f107a46b2e47461a

1.4.1

What's Changed

Full Changelog: v1.4.0...1.4.1

Bug Fix

• #109 where the Visit homepage button was not actually navigating back to home.

Upgrade Instructions

If upgrading from v.1.3.0, some teams noted that the Body Width theme setting would revert to the default.

Contributors, Issue Creators, and Advisors

@mvogelgesang @smithaunnivelan

Release ZIP SHA-256 hash: 112741e821158476ded7b00457bebd570865a44226b755da24036241b7fec3cd

1.4.0

What's new

Full Changelog: v1.3.0...v1.4.0

Accessibility Improvements

• #50 - Social Media Navigation - added aria-label
• #54 - Footer - removed empty header tags if text was not completed in Theme Settings

New USWDS Components/ Templates

• #77 Pagination
  • Implementation of the USWDS Pagination Component
  • Can be included in a larger component which displays a list of records or other data
  • Choose between English and Spanish language versions
• #83 Card
  • Implementation of USWDS Card component
  • Useful when displaying brief content snippets and links to a larger page
  • All currently defined card types from USWDS supported
• #69 404 Page
  • Choose between English and Spanish language versions

Example Components

• Two new components, Card and Pagination, are meant to be included in a larger component which is responsible for fetching data. As such, a new directory, /examples/ has been established to provide working prototypes of each component. Each subdirectory in /examples can be independently deployed and includes a README.md with background information as well as deployment instructions.
• #67 themeColorStyleGuide - addresses a common need from development teams who need a resource to evaluate the impact of Branding Sets on buttons and other page elements

Code Tours

• VSCode Plugin - Code Tours
• In order to facilitate a stronger developer experience, Code Tours have been established for the new Card and Pagination components.

Upgrade to USWDS 2.12.1

• Current as of September 2021

Other updates

• #66 Support for rectangular logos and no header text
• #62 Added support for a third Contact Us option, links. This addresses a need identified by development teams who point users at a web form for support cases.
• #101 When selecting the theme in Community Builder, the theme version will now also be displayed. This addresses an issue where site builders might not be fully aware of which version they are using.

Documentation

• USWDS Component List - List of USWDS Components mapped to this theme along with configuration options
• Spotlight - A public list of sites employing this theme

Upgrade Instructions

If upgrading from v.1.3.0, some teams noted that the Body Width theme setting would revert to the default.

Contributors, Issue Creators, and Advisors

@rajanangunoorigsa @mvogelgesang @carchiere

Security and dependencies

0 vulnerabilities in regular dependencies

Release ZIP SHA-256 hash: fffe461a1952ebe818ef01ba2ca0c80dd0c0f3831f658694c771404c26c55712

Release 1.3.0

Release 1.3.0 upgrades the theme to USWDS v2.10.0, adds the new Identifier component, and adds two new drop zones to the base theme. If upgrading from a previous version of the theme, a handful of post deployment configuration steps are required, see Upgrade Instructions.

Features

• Identifier - #44 Inclusion of the new Identifier component in USWDS. This required changes to the overall footer. Before and after examples can be found issue.
• USWDS Version Upgrade - #29 & #36 Upgrade to USWDS v2.9.0 and v2.10.0. See notes in #36 which describe tradeoffs that were made when reducing the total package size of v2.10.0
• New Drop Zones
  • #34 Added a full-width announcement banner component drop zone just below the header. Any component dropped here will be displayed across all pages.
  • #28 Added a component drop zone next to the User Profile menu called Shopping Cart. Drop zone can fit a single icon such as a shopping cart.
• Adjustable Page Width - #27 Added configurable option to select between three different page widths grid-container (edge to edge, max width 1312px, max width 936px (default))
• #38 Updated Prettier dependencies
• #30 Updated INSTALLATION and CONTRIBUTING guidelines
• #31 Updated Theme Definition preview images and descriptions to highlight new major features
• Wiki Updates
  • New page, Theme Settings, to provide examples and further explanation of all theme settings and drop zones found in the theme
  • New page, Upgrading Minor Versions of USWDS, documents the process to create a <5MB package.
  • New page, Update Theme Definition, documents process for updating theme definition descriptions and preview images.

Upgrade Instructions

Release 1.3.0 requires post deployment configuration steps to ensure the new Identifier component has all content in place. Upon deployment, be sure to set the following within Theme Settings:

• Body Width (default: Standard)
• Identifier Type (default: English)
• Site Domain (just the bare domain, no HTTPS needed. E.g. labs.gsa.gov)

Previous versions of this theme had body content stretch the full page width. Check page layouts to ensure that adjustments are not needed to accommodate this change.

Contributors

@mvogelgesang

USWDS Version

USWDS Version 2.10.0

Release 1.2.0

Release 1.2.0 further refines and enhances the USWDS SF Lightning Community codebase. Following Salesforce Lightning guidelines and practices followed by USWDS, we have adopted Prettier as the default code formatter for the entire codebase. Using Prettier enhances readability and simplifies discussions around code so that we may focus on the content rather than the style.

Features

• Reconfigured footer menu
  • Moves 'secondary nav' links from right hand side to bottom below agency logo.
  • New toggle-able section in footer which enables a content block to be dropped into right hand side next to Contact Us.
  • Toggle-able main footer nav section which allows for either a big menu (menu with sub-items) and a small menu (flat structure)
• Updated contribution, pull request, and issue guidelines
• Fixed CSS for Font Awesome icons so the entire icon is clickable as a link

Contributors

@mvogelgesang

USWDS Version

USWDS Version 2.8.0

Release 1.1.0

Release 1.1.0 addresses a key display bug which was identified after release as well as making updates to bring the theme into alignment with USWDS v2.8.0.

New Features

• #13 Updated USA Banner to support .gov and .mil sites in both English and Spanish. Corresponds with new Banner components released by USWDS in v2.8.0.
• #7 Created toggle on Theme Settings allowing for the User Profile/ Login portion of the page to be hidden. Note: login and registration pages will still be published. As of this release, Salesforce does not provide the capability to disable login.

Bugs Addressed

• #10 Addressed Mega Menu display issue where menus with sub-items were displaying all contents upon page load rather than being collapsed.

Miscellaneous updates

• #13 Changed name of USWDS Static Resource to move from a convention where version number is included (uswds_v_2_7_0) to one that does not require updates across all components with each minor version update (uswds_2_x).
  #8 Updated installation instructions to clarify steps for new communities and upgrading existing communities.

Contributors

@mvogelgesang @Prenabhatt

USWDS Version 2.8.0

Release 1.0.0

Initial Release

Initial release which provides a Lightning Community Theme based off US Web Design System. The theme provides the following capabilities to a user with access to Community Builder:

• Set site name and logo
• Configurable menus for navigation which includes five sections: main menu, under search box, primary footer, footer sidebar, and footer social media icons
• Set phone and email information for site contact center/ pocs
• Toggle-able navBar, Search, and User Profile Menu sections which allow user to choose between native Salesforce components or to insert components they have built custom
  • USWDS theme'd navBar and Search are included
• Toggle-able section in footer to add email signup or other custom component on right side
• Native branding set

USWDS Version 2.7