8000 USWDS-Site: Documentation updates for 3.11.0 by amyleadem · Pull Request #2991 · uswds/uswds-site · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

USWDS-Site: Documentation updates for 3.11.0 #2991

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 47 commits into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
b2c9b46
Create changelog
mahoneycm Oct 31, 2024
a0f177f
Restore items key
mahoneycm Oct 31, 2024
d55ee06
initial commit
RachelCorsino Nov 6, 2024
cfee4fa
added pr number
RachelCorsino Nov 6, 2024
b63c44d
cb-changelog-5986
cathybaptista Nov 7, 2024
5aa1bc6
Update 3.10.0 -> 3.11.0 in config.yml
Nov 25, 2024
db31572
added xlmns to summary
RachelCorsino Nov 26, 2024
c22c90a
updated pr number
RachelCorsino Nov 26, 2024
f891a3f
added changelog for icon list
RachelCorsino Nov 26, 2024
b92f627
Updated wording for changelog so it's more concise.
cathybaptista Nov 26, 2024
c37b2f5
added changelogs for components with markup changes
RachelCorsino Nov 27, 2024
2a4ac5f
Merge branch 'main' into rc-changelog-xlink
RachelCorsino Dec 2, 2024
4e67d9e
Add changelogs for 6332
Dec 3, 2024
471fd2b
Add changelog for 6237
Dec 5, 2024
93d5546
updated summary content
RachelCorsino Dec 9, 2024
104811d
Merge branch 'rc-changelog-xlink' of https://github.com/uswds/uswds-s…
RachelCorsino Dec 9, 2024
524dc77
updated versionUswds number
RachelCorsino Dec 9, 2024
3ec6a6d
updated version numbers and added file input changelog
RachelCorsino Dec 9, 2024
8e5c3ee
Merge pull request #2951 from uswds/rc-changelog-xlink
amyleadem Dec 9, 2024
a23d6a7
CB: Updated wording on changelog. This is and never was a bug.
cathybaptista Dec 10, 2024
e004b11
Merge branch 'main' of https://github.com/uswds/uswds-site into cb-ch…
Dec 11, 2024
26ac727
Update _data/changelogs/component-file-input.yml
mahoneycm Dec 11, 2024
4047dab
Update _data/changelogs/component-file-input.yml
mahoneycm Dec 11, 2024
3934e28
Merge branch 'main' of https://github.com/uswds/uswds-site into relea…
Dec 16, 2024
703929d
Merge branch 'release-3.11.0' of https://github.com/uswds/uswds-site …
Dec 16, 2024
7850f7d
Merge branch 'release-3.11.0' of https://github.com/uswds/uswds-site …
Dec 16, 2024
74b8199
Merge branch 'release-3.11.0' of https://github.com/uswds/uswds-site …
Dec 16, 2024
0a88ac8
Fix merge conflict
Dec 16, 2024
4a6a1eb
Merge branch 'release-3.11.0' of https://github.com/uswds/uswds-site …
Dec 16, 2024
09cab25
Fix merge conflict
Dec 16, 2024
48b0fe5
Merge pull request #2999 from uswds/al-changelog-6237
amyleadem Dec 16, 2024
4a51e2e
Merge pull request #2933 from uswds/cm-changelog-6168
amyleadem Dec 16, 2024
f00b479
Merge pull request #2997 from uswds/al-changelog-6232
amyleadem Dec 16, 2024
df77dff
Merge pull request #2957 from uswds/cb-changelog-5986
amyleadem Dec 17, 2024
4e41964
Install uswds develop branch
Dec 17, 2024
4ad195c
Replace N.N.N -> 3.11.0
Dec 17, 2024
49d1651
Update package-lock
Dec 17, 2024
a386105
Update release date
Dec 17, 2024
cae1b0b
Add changelog for 6232 to component-form.yml
Dec 17, 2024
188886d
Tweak copy in 6165
amyleadem Dec 18, 2024
5e84d0d
Fix indent formatting
Dec 18, 2024
c69ed5b
Merge branch 'release-3.11.0' of https://github.com/uswds/uswds-site …
Dec 18, 2024
9b34c0f
Rewrite summaries for 6232
Dec 18, 2024
bc593a2
Merge branch 'main' of https://github.com/uswds/uswds-site into relea…
Dec 18, 2024
83809bf
Merge branch 'main' of https://github.com/uswds/uswds-site into relea…
Dec 18, 2024
7b39bb5
Merge branch 'main' of https://github.com/uswds/uswds-site into relea…
Dec 18, 2024
3a55f99
Use USWDS 3.11.0
thisisdano Dec 18, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.10.0
uswds_version: 3.11.0
uswds_email: uswds@gsa.gov
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.10.0-zip-hash.txt?ref=main"
json: "https://api.github.com/repos/uswds/uswds/contents/security/uswds-3.11.0-zip-hash.txt?ref=main"
decode_content: true

repos:
Expand Down
6 changes: 6 additions & 0 deletions _data/changelogs/component-collection.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@ title: Collection
type: component
changelogURL:
items:
- date: 2024-12-18
summary: Replaced deprecated `xlink:href` references with `href` in icons.
affectsMarkup: true
githubPr: 6165
githubRepo: uswds
versionUswds: 3.11.0
- date: 2024-12-18
summary: Added WCAG compliance tag and accessibility test status section.
affectsGuidance: true
Expand Down
13 changes: 13 additions & 0 deletions _data/changelogs/component-file-input.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@ title: File input
type: component
changelogURL:
items:
- date: 2024-12-18
summary: Fixed a bug that prevented screen readers from announcing the invalid file type error message.
affectsAccessibility: true
affectsJavascript: true
githubPr: 6168
githubRepo: uswds
versionUswds: 3.11.0
- date: 2024-12-18
summary: Replaced deprecated `xlink:href` references with `href`.
affectsAssets: true
githubPr: 6165
githubRepo: uswds
versionUswds: 3.11.0
- date: 2024-11-19
summary: Added WCAG compliance tag and accessibility test status section.
affectsGuidance: true
Expand Down
8 changes: 8 additions & 0 deletions _data/changelogs/component-footer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@ title: Footer
type: component
changelogURL:
items:
- date: 2024-12-18
summary: 'Removed `overflow: hidden` from `usa-footer` to allow the full focus outline to show.'
summaryAdditional: This fix also improves horizontal alignment in the slim footer variant.
affectsStyles: true
affectsAccessibility: true
githubPr: 6237
githubRepo: uswds
versionUswds: 3.11.0
- date: 2024-10-04
summary: Added the `autocomplete="email"` attribute to the email input element.
summaryAdditional: This allows the component to meet all the standards outlined in [WCAG 1.3.5](https://www.w3.org/WAI/WCAG21/Understanding/identify-input-purpose.html).
Expand Down
7 changes: 7 additions & 0 deletions _data/changelogs/component-form.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ title: Form
type: component
changelogURL:
items:
- date: 2024-12-18
summary: Moved `.usa-input--[width]` and `.usa-input-group--[width]` classes out of the `usa-form` package.
summaryAdditional: These classes are now generated in the `usa-input` and `usa-input-prefix-suffix` packages and can be used without the `.usa-form` parent element.
affectsStyles: true
githubPr: 6232
githubRepo: uswds
versionUswds: 3.11.0
- date: 2024-10-04
summary: Added guidance discouraging most uses of disabled form inputs.
summaryAdditional: We also added guidance on the rare instances when disabled inputs improve usability.
Expand Down
6 changes: 6 additions & 0 deletions _data/changelogs/component-icon-list.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@ title: Icon list
type: component
changelogURL:
items:
- date: 2024-12-18
summary: Replaced deprecated `xlink:href` references with `href`.
affectsMarkup: true
githubPr: 6165
githubRepo: uswds
versionUswds: 3.11.0
- date: 2024-12-13
summary: Added WCAG compliance tag and accessibility test status section.
affectsGuidance: true
Expand Down
6 changes: 6 additions & 0 deletions _data/changelogs/component-icon.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@ title: Icon
type: component
changelogURL:
items:
- date: 2024-12-18
summary: Replaced deprecated `xlink:href` references with `href`.
affectsMarkup: true
githubPr: 6165
githubRepo: uswds
versionUswds: 3.11.0
- date: 2024-06-07
summary: Added clarity to icon guidance.
affectsGuidance: true
Expand Down
13 changes: 13 additions & 0 deletions _data/changelogs/component-input-prefix-suffix.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@ title: Input prefix or suffix
type: component
changelogURL:
items:
- date: 2024-12-18
summary: Moved `.usa-input-group--[width]` classes into the `usa-input-prefix-suffix` package from `usa-form`.
summaryAdditional: These classes can now be used without the `usa-form` package and `.usa-form` parent element.
affectsStyles: true
githubPr: 6232
githubRepo: uswds
versionUswds: 3.11.0
- date: 2024-12-18
summary: Replaced deprecated `xlink:href` references with `href`.
affectsMarkup: true
githubPr: 6165
githubRepo: uswds
versionUswds: 3.11.0
- date: 2023-11-20
summary: Added documentation for `usa-input-group--success` variant.
affectsGuidance: true
Expand Down
198 changes: 102 additions & 96 deletions _data/changelogs/component-modal.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,99 +2,105 @@ 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.
isBreaking: false
affectsGuidance: true
githubPr: 2874
githubRepo: uswds-site
versionUswds: 3.9.0
- date: 2023-11-09
summary: Updated JavaScript to include fallbacks and error messages when initialization cannot be completed.
summaryAdditional: Additionally, this improved code consistency and prevented errors when trying to initialize modal twice.
isBreaking: false
affectsJavascript: true
githubPr: 5315
githubRepo: uswds
versionUswds: 3.7.0
- date: 2023-09-29
summary: Updated how the modal JavaScript resets body padding and improved body padding detection.
summaryAdditional: Now the component will rely on the CSS to reset body padding rather than injecting an inline style with JavaScript.
affectsJavascript: true
affectsStyles: true
githubPr: 5493
githubRepo: uswds
versionUswds: 3.6.1
- date: 2023-03-09
summary: Fixed the display of interactive form elements (like Date Picker) in modal windows.
summaryAdditional: Now any element in a modal should work as expected.
isBreaking: false
affectsJavascript: true
githubPr: 5049
githubRepo: uswds
versionUswds: 3.4.0
- date: 2022-08-05
summary: Styled aria-disabled to match disabled.
summaryAdditional: Now disabled styling is applied whether you use `disabled` (disabled and hidden from screen readers) or `aria-disabled` (disabled and visible to screen readers).
isBreaking: false
affectsAccessibility: true
affectsAssets: false
affectsGuidance: false
affectsJavascript: false
affectsMarkup: false
affectsStyles: true
githubPr: 4783
githubRepo: uswds
versionUswds: 3.1.0
- date: 2022-08-05
summary: Added `type="button"` to all non-form buttons to prevent default submit behaviors.
summaryAdditional: This allowed us to remove `preventDefault()` from the relevant component JavaScript.
affectsJavascript: true
affectsMarkup: true
githubPr: 4695
githubRepo: uswds
versionUswds: 3.1.0
- date: 2022-04-28
summary: Updated to Sass module syntax and new package structure.
isBreaking: true
affectsAccessibility: true
affectsAssets: true
affectsGuidance: true
affectsJavascript: true
affectsMarkup: true
affectsStyles: true
githubPr: 4656
githubRepo: uswds
versionUswds: 3.0.0
- date: 2022-06-16
summary: Added guidance for handling external links.
affectsGuidance: true
githubPr: 1225
githubRepo: uswds-site
- date: 2021-03-17
summary: Added modal documentation.
affectsGuidance: true
githubPr: 1180
githubRepo: uswds-site
- date: 2021-03-17
summary: Added modal component.
summaryAdditional: A modal disables page content and focuses the user’s attention on a single task or message.
isBreaking: false
affectsAccessibility: false
affectsAssets: false
affectsGuidance: true
affectsJavascript: true
affectsMarkup: true
affectsStyles: true
githubPr: 3981
githubRepo: uswds
versionUswds: 2.11.0
- date: 2024-12-18
summary: Replaced deprecated `xlink:href` references with `href`.
affectsMarkup: true
githubPr: 6165
githubRepo: uswds
versionUswds: 3.11.0
- 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.
isBreaking: false
affectsGuidance: true
githubPr: 2874
githubRepo: uswds-site
versionUswds: 3.9.0
- date: 2023-11-09
summary: Updated JavaScript to include fallbacks and error messages when initialization cannot be completed.
summaryAdditional: Additionally, this improved code consistency and prevented errors when trying to initialize modal twice.
isBreaking: false
affectsJavascript: true
githubPr: 5315
githubRepo: uswds
versionUswds: 3.7.0
- date: 2023-09-29
summary: Updated how the modal JavaScript resets body padding and improved body padding detection.
summaryAdditional: Now the component will rely on the CSS to reset body padding rather than injecting an inline style with JavaScript.
affectsJavascript: true
affectsStyles: true
githubPr: 5493
githubRepo: uswds
versionUswds: 3.6.1
- date: 2023-03-09
summary: Fixed the display of interactive form elements (like Date Picker) in modal windows.
summaryAdditional: Now any element in a modal should work as expected.
isBreaking: false
affectsJavascript: true
githubPr: 5049
githubRepo: uswds
versionUswds: 3.4.0
- date: 2022-08-05
summary: Styled aria-disabled to match disabled.
summaryAdditional: Now disabled styling is applied whether you use `disabled` (disabled and hidden from screen readers) or `aria-disabled` (disabled and visible to screen readers).
isBreaking: false
affectsAccessibility: true
affectsAssets: false
affectsGuidance: false
affectsJavascript: false
affectsMarkup: false
affectsStyles: true
githubPr: 4783
githubRepo: uswds
versionUswds: 3.1.0
- date: 2022-08-05
summary: Added `type="button"` to all non-form buttons to prevent default submit behaviors.
summaryAdditional: This allowed us to remove `preventDefault()` from the relevant component JavaScript.
affectsJavascript: true
affectsMarkup: true
githubPr: 4695
githubRepo: uswds
versionUswds: 3.1.0
- date: 2022-04-28
summary: Updated to Sass module syntax and new package structure.
isBreaking: true
affectsAccessibility: true
affectsAssets: true
affectsGuidance: true
affectsJavascript: true
affectsMarkup: true
affectsStyles: true
githubPr: 4656
githubRepo: uswds
versionUswds: 3.0.0
- date: 2022-06-16
summary: Added guidance for handling external links.
affectsGuidance: true
githubPr: 1225
githubRepo: uswds-site
- date: 2021-03-17
summary: Added modal documentation.
affectsGuidance: true
githubPr: 1180
githubRepo: uswds-site
- date: 2021-03-17
summary: Added modal component.
summaryAdditional: A modal disables page content and focuses the user’s attention on a single task or message.
isBreaking: false
affectsAccessibility: false
affectsAssets: false
affectsGuidance: true
affectsJavascript: true
affectsMarkup: true
affectsStyles: true
githubPr: 3981
githubRepo: uswds
versionUswds: 2.11.0
6 changes: 6 additions & 0 deletions _data/changelogs/component-pagination.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@ title: Pagination
type: component
changelogURL:
items:
- date: 2024-12-18
summary: Replaced deprecated `xlink:href` references with `href`.
affectsMarkup: true
githubPr: 6165
githubRepo: uswds
versionUswds: 3.11.0
- date: 2024-10-16
summary: Added WCAG compliance tag and accessibility test status section.
affectsGuidance: true
Expand Down
8 changes: 8 additions & 0 deletions _data/changelogs/component-table.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ type: component
changelogURL:

items:
- date: 2024-12-18
summary: Updated table header styles to be consistent across all table elements.
summaryAdditional: Now, all `thead th`, `tbody th`, and `tfoot th` cells will have the same visual styles. Teams should confirm that their tables display as expected.
isBreaking: false
affectsStyles: true
githubPr: 5986
githubRepo: uswds
versionUswds: 3.11.0
- date: 2024-03-20
summary: Added WCAG compliance tag and accessibility test status section.
affectsGuidance: true
Expand Down
9 changes: 7 additions & 2 deletions _data/changelogs/component-text-input.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# Add page title. eg: Accessibility, Banner
title: Text input
type: component
# Provide url for the package CHANGELOG.md. Note: Not all pages will have a related CHANGELOG.md file.
changelogURL:

items:
- date: 2024-12-18
summary: Moved `.usa-input--[width]` classes into the `usa-input` package from `usa-form`.
summaryAdditional: These classes can now be used without the `usa-form` package and `.usa-form` parent element.
affectsStyles: true
githubPr: 6232
githubRepo: uswds
versionUswds: 3.11.0
- date: 2024-06-19
summary: Added WCAG compliance tag and accessibility test status section.
affectsGuidance: true
Expand Down
Loading
Loading
0