8000 USWDS: Draft 3.11.0 release notes · Issue #6221 · uswds/uswds · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

USWDS: Draft 3.11.0 release notes #6221

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

Closed
amyleadem opened this issue Nov 21, 2024 · 15 comments
Closed

USWDS: Draft 3.11.0 release notes #6221

amyleadem opened this issue Nov 21, 2024 · 15 comments
Assignees

Comments

@amyleadem
Copy link
Contributor
amyleadem commented Nov 21, 2024

Summary

Draft release notes for USWDS 3.11.0 based on this template (Google Docs 🔒).

@amyleadem amyleadem moved this to Needs refinement in USWDS Core Project Data Nov 21, 2024
@amyleadem amyleadem self-assigned this Nov 21, 2024
@amyleadem amyleadem moved this from Needs refinement to In progress in USWDS Core Project Data Nov 29, 2024
@amyleadem
Copy link
Contributor Author
amyleadem commented Nov 29, 2024

What's new in USWDS 3.11.0

Features

Package A11y Breaking Markup change Description
usa-elements - - - Removed outdated browser normalization styles. This update drops normalize support for Internet Explorer. Thanks @aduth! (#5555)
usa-form, usa-input-prefix-suffix, usa-input, uswds-core - - - Moved .usa-input--[width] and .usa-input-group--[width] classes out of the usa-form package. 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. Thanks @aduth! (#6232)
usa-table - - - Updated table header styles to be consistent across all table elements. Now, all thead th, tbody th, and tfoot th cells will all have the same visual styles. Thanks @ajanickiv!

✏️ Teams should confirm that their tables display as expected. (#5986)

Bug fixes

Package A11y Breaking Markup change Description
usa-button, usa-collection, usa-file-input, usa-icon-list, usa-icon, usa-input-prefix-suffix, usa-modal, usa-pagination - - Yes Replaced deprecated xlink:href references with href.

✏ Teams should update their markup to replace xlink:href references with href and pull in the updated loader.svg file. (#6165)
usa-file-input Yes - - Fixed a bug that prevented screen readers from announcing the invalid file type error message. (#6168)

✏️ Teams who support additional languages should update the error message string to match the new copy.
usa-footer Yes - - Removed overflow: hidden from usa-footer to allow the full focus outline to show. This fix also improves horizontal alignment in the slim footer variant. Thanks @6TELOIV! (#6237)

Markup changes

MDN warns that the deprecated xlink:href attribute can stop working at any time. When referencing SVG icon sprites, teams should use href instead of the deprecated xlink:href attribute.

<!-- usa-icon example -->
<svg class="usa-icon" aria-hidden="true" focusable="false" role="img">
- <use xlink:href="./img/sprite.svg#close"></use>
+ <use href="./img/sprite.svg#close"></use>
</svg>

Dependencies and security

Dependency name Previous version New version
@babel/core 7.25.7 7.26.0
@babel/preset-env 7.25.7 7.26.0
axe-core 4.10.0 4.10.2
cross-spawn 7.0.3 7.0.6
html-webpack-plugin 5.6.0 5.6.3
mocha 10.7.3 10.8.2
nwsapi (added via npm overrides) -- 2.2.13
postcss 8.4.47 8.4.49
prettier 3.3.3 3.4.2
sass 1.79.4 1.83.0
sass-embedded 1.79.4 1.83.0
snyk 1.1293.1 1.1294.3
stylelint 16.9.0 16.11.0
typescript 5.6.2 5.7.2
webpack 5.95.0 5.97.1

N vulnerabilities in regular dependencies (dependencies for USWDS projects installed with npm install @uswds/uswds)
29 moderate, 26 high vulnerabilities in devDependencies (development dependencies).

Release TGZ SHA-256 hash: 1c10cd70a3c627fd14d9ee74a4071e67c4e5ba4bf14ca1c50c19c2fe5885e70a

@amyleadem amyleadem moved this from In progress to Review in USWDS Core Project Data Dec 13, 2024
@mahoneycm
Copy link
Contributor

@amyleadem for the xlink:href are we only listing packages with markup changes? Or should we list all affected packages (for example, button and file input)

@mahoneycm
Copy link
Contributor

Also heads up, we're working on a dependency update PR right now. I'll compare and update the dependency table once that is up 👍

@mahoneycm
Copy link
Contributor

question: For the xlink:href, should we add a note for users to recommend removing as well?

If so:

Suggestion: ✏ Teams should remove this deprecated attribute from their components as well

@amyleadem
Copy link
Contributor Author

question: For the xlink:href, should we add a note for users to recommend removing as well?

If so:

Suggestion: ✏ Teams should remove this deprecated attribute from their components as well

@mahoneycm

Interesting note! My initial thought was to say it is outside the scope of USWDS, but a note like this might help keep users aware that support might drop. What do you think of something like this?

✏ MDN warns that the deprecated xlink:href attribute can stop working at any time. Teams should update this attribute in their projects.

@mahoneycm
Copy link
Contributor

@amyleadem lgtm! Small optional suggestion would be to add that teams should "review their markup and update this attribute if needed" or something along those lines. Potentially unnecessary though!

@amyleadem
Copy link
Contributor Author

Made some updates:

@mahoneycm
Copy link
Contributor

Looks like the the final vulnerability count got added to the bottom of the dependency table. Other than that, lgtm!

If we include dependency updates from #6255 and #6256 we should make sure to include these changes in the table.

@amyleadem
Copy link
Contributor Author

Update: added uswds-core to the package list for #6232

@amyleadem
Copy link
Contributor Author

Update: Added a line break to move the vulnerability section out of the dependency table

@mejiaj
Copy link
Contributor
mejiaj commented Dec 17, 2024

Made some updates:

@amyleadem re: bug vs feature: seems like a feature because nothing is currently broken.

xlink for SVGs

I like the idea of a note. If possible, it'd be helpful to have the generic note and an example of what that looks like in context of USWDS component.

For example

✏ Teams should use `href` instead of `xlink:href` (deprecated) when referencing any SVG icon sprites, for example when using USA Icon.
<!-- USA Icon example -->
<svg class="usa-icon" aria-hidden="true" focusable="false" role="img">
-  <use xlink:href="./img/sprite.svg#close"></use>
+  <use href="./img/sprite.svg#close"></use>
</svg>

@amyleadem
Copy link
Contributor Author

Realized I accidentally saved over some of my changes in the release notes (:doh:), so I restored the entry for #5555, added a markup changes section, and added a "teams should..." note for #6165.
Let me know if you want any changes.

@mejiaj
Copy link
Contributor
mejiaj commented Dec 17, 2024

LGTM

@amyleadem
Copy link
Contributor Author

Note: Need to update the dependency tables after POAM PRs are merged

@amyleadem amyleadem moved this from Review to Fed Final Review in USWDS Core Project Data Dec 18, 2024
@thisisdano
Copy link
Contributor

Done!

@github-project-automation github-project-automation bot moved this from Fed Final Review to Done in USWDS Core Project Data Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

4 participants
0