Skip to content

Commit

Permalink
Merge pull request #2944 from uswds/release-3.10.0
Browse files Browse the repository at this point in the history
USWDS-Site: Documentation updates for 3.10.0
  • Loading branch information
thisisdano authored Nov 13, 2024
2 parents fa1c2ab + b49527f commit 3588290
Show file tree
Hide file tree
Showing 15 changed files with 1,670 additions and 546 deletions.
1 change: 0 additions & 1 deletion .browserslistrc
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Supported browsers
> 2%
last 2 versions
IE 11
not dead
2 changes: 1 addition & 1 deletion .tool-versions
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
ruby 3.2.5
nodejs 20.9.0
nodejs 22.11.0
3 changes: 1 addition & 2 deletions _components/step-indicator/guidance/accessibility.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
- **Use semantic heading levels.** Though our default code uses an `<h4>`, use the correct heading level in your own implementation.
- **Use aria-label="progress".** Placing this `aria-label` on the element with the class `usa-step-indicator` helps provide important context to screen readers.
- **Use visually hidden text on labels.** Use visually hidden text make the completion status of each step explicit.
- **Indicate the current step.** When using labeled segments, use `aria-current="true"` on the list item representing the current step.
- **Hide unlabeled segments.** There is no content inside the segments when labels aren't used, so it is safe to add `aria-hidden="true"` to the element with the class name `usa-step-indicator__segments`.
- **Hide unlabeled segments.** There is no content inside the segments when labels aren't used, so it is safe to add `aria-hidden="true"` to the element with the class name `usa-step-indicator__segments`.
4 changes: 2 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: U.S. Web Design System (USWDS)
description: USWDS makes it easier to build accessible, mobile-friendly government websites.
google_analytics_ua: UA-48605964-43
uswds_version: 3.9.0
uswds_version: 3.10.0
uswds_email: [email protected]
federalist_base: "https://federalist-3b6ba08e-0df4-44c9-ac73-6fc193b0e19c.sites.pages.cloud.gov/preview/uswds/uswds"
federalist_component_preview: "iframe.html?id="
Expand Down Expand Up @@ -44,7 +44,7 @@ jekyll_get:
json: "https://api.github.com/repos/uswds/uswds/contents/SECURITY.md"
decode_content: true
- data: hash
json: "https://api.github.com/repos/uswds/uswds/contents/security/uswds-3.9.0-zip-hash.txt?ref=main"
json: "https://api.github.com/repos/uswds/uswds/contents/security/uswds-3.10.0-zip-hash.txt?ref=main"
decode_content: true

repos:
Expand Down
8 changes: 8 additions & 0 deletions _data/changelogs/component-checkbox.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@ title: Checkbox
type: component
changelogURL:
items:
- date: 2024-11-13
summary: Removed style tags from indeterminate checkbox SVGs.
summaryAdditional: |
These style tags were unnecessary and caused a conflict with some automated testing tools.
affectsAssets: true
githubPr: 6162
githubRepo: uswds
versionUswds: 3.10.0
- date: 2024-09-18
summary: Added WCAG compliance tag and accessibility test status section.
affectsGuidance: true
Expand Down
8 changes: 8 additions & 0 deletions _data/changelogs/component-combo-box.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@ title: Combo box
type: component
changelogURL:
items:
- date: 2024-11-13
summary: Updated the order of combo box search results.
summaryAdditional: The component now displays options that start with the query at the top of the list, followed by options that contain the query. This behavior more closely aligns with user expectations.
isBreaking: false
affectsJavascript: true
githubPr: 6122
githubRepo: uswds
versionUswds: 3.10.0
- date: 2024-10-04
summary: Removed custom screen reader instructions.
summaryAdditional: Combo box now relies on the default instructions provided by screen readers.
Expand Down
7 changes: 7 additions & 0 deletions _data/changelogs/component-file-input.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@ title: File input
type: component
changelogURL:
items:
- date: 2024-11-13
summary: Fixed a bug that caused image previews to break when a Content Security Policy is enabled.
summaryAdditional: The component now uses event listeners in place of inline JavaScript to handle error states.
affectsJavascript: true
githubPr: 5997
githubRepo: uswds
versionUswds: 3.10.0
- date: 2024-03-13
summary: Added known issues section.
summaryAdditional:
Expand Down
8 changes: 8 additions & 0 deletions _data/changelogs/component-modal.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@ title: Modal
type: component
changelogURL:
items:
- date: 2024-11-13
summary: Fixed a bug that prevented bundling the modal package with a custom prefix.
summaryAdditional: This update removed hard-coded class names from the modal JavaScript.
isBreaking: false
affectsJavascript: true
githubPr: 6026
githubRepo: uswds
versionUswds: 3.10.0
- date: 2024-11-6
summary: Added focus trap guidance.
summaryAdditional: Updated guidance to ensure users trap focus inside the modal so that it doesn't move to the content behind it.
Expand Down
12 changes: 9 additions & 3 deletions _data/changelogs/component-step-indicator.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
title: Step indicator
type: component
# Provide url for the package CHANGELOG.md. Note: Not all pages will have a related CHANGELOG.md file.
changelogURL:

items:
# 3.4.0 release
- date: 2024-11-13
summary: Removed the `aria-label` from the wrapper of the step indicator component.
summaryAdditional: This resolves an error related to having an invalid attribute on a `div` element.
affectsAccessibility: true
affectsMarkup: true
affectsGuidance: true
githubPr: 6146
githubRepo: uswds
versionUswds: 3.10.0
- date: 2023-03-09
summary: Improved contrast on pending items.
summaryAdditional: Graphical elements related to pending items now meet accessibility standards for contrast ratio.
Expand All @@ -14,7 +21,6 @@ items:
githubPr: 5048
githubRepo: uswds
versionUswds: 3.4.0
# 3.0 release
- date: 2022-04-28
summary: Updated to Sass module syntax and new package structure.
isBreaking: true
Expand Down
9 changes: 8 additions & 1 deletion _data/changelogs/component-time-picker.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
title: Time picker
type: component
# Provide url for the package CHANGELOG.md. Note: Not all pages will have a related CHANGELOG.md file.
changelogURL:

items:
- date: 2024-11-13
summary: Updated the time picker hint text to improve clarity.
summaryAdditional: This update allows the component to meet the success criteria in [WCAG 3.3.2](https://www.w3.org/WAI/WCAG21/Understanding/labels-or-instructions.html).
affectsAccessibility: true
affectsContent: true
githubPr: 6147
githubRepo: uswds
versionUswds: 3.10.0
- date: 2024-11-07
summary: Added WCAG compliance tag and accessibility test status section.
affectsGuidance: true
Expand Down
10 changes: 0 additions & 10 deletions _data/issues/combo-box.yml

This file was deleted.

2 changes: 1 addition & 1 deletion _includes/step-indicator.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<div class="usa-step-indicator" aria-label="progress">
<div class="usa-step-indicator">
<ol class="usa-step-indicator__segments">
{% for step in page.steps %}
{% if step.status == "completed" %}
Expand Down
4 changes: 2 additions & 2 deletions config/gulp/build.js
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ function buildUSWDSComponents() {
/**
* We need to: install USWDS deps and build components to HTML.
*/
return spawnP("npm", ["install", "--legacy-peer-deps"], sharedOpts).then(
() => spawnP("npm", ["run", "build:html"], sharedOpts),
return spawnP("npm", ["install"], sharedOpts).then(() =>
spawnP("npm", ["run", "build:html"], sharedOpts),
);
}
}
Expand Down
Loading

0 comments on commit 3588290

Please sign in to comment.