Visitar URL original
USWDS-Site - Changelog: add entry and doc updates for sticky table headers [USWDS#5420] by amyleadem · Pull Request #2229 · uswds/uswds-site · GitHub
Skip to content

USWDS-Site - Changelog: add entry and doc updates for sticky table headers [USWDS#5420] - #2229

Merged
amyleadem merged 24 commits into
release-3.8.0from
al-documentation-5420
Mar 6, 2024
Merged

USWDS-Site - Changelog: add entry and doc updates for sticky table headers [USWDS#5420]#2229
amyleadem merged 24 commits into
release-3.8.0from
al-documentation-5420

Conversation

@amyleadem

@amyleadem amyleadem commented Aug 4, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

Summary

PR #5420 introduced sticky table headers as a new variant for USWDS tables. This PR adds documentation for the new variant.

Important

This branch will have build failures until uswds is updated to include the changes in 3.8.0 (particularly, uswds/uswds#5420).

New variant

Variant name Description
.usa-table--sticky-header Allows the table header element to stick to the top of the page as the user scrolls. Preferred for long tables with many rows. This variant is not compatible with the scrollable and stacked table variants.

New settings

Setting name Description
$theme-table-background-color Defines the table background color. A value of default uses the body background color.
$theme-table-sticky-top-offset Defines the top offset for sticky headers.

Preview link

Testing and review

  • Confirm the changelog entries make sense and are added to the appropriate pages
  • Confirm the settings and variant updates make sense and are added to the appropriate pages
  • Confirm grammar, spelling, and plain language for all copy updates
  • Confirm that there are no visual regressions in any of the table variants affected by USWDS - Table: Add sticky headers uswds#5420
  • Confirm the sticky table header works as expected in the component preview

@amyleadem amyleadem mentioned this pull request Aug 4, 2023
Merged
@amyleadem amyleadem changed the title USWDS-Site: Documentation updates for sticky table headers USWDS-Site - Changelog: add entry and doc updates for sticky table headers [USWDS#5420] Aug 9, 2023
amyleadem
amyleadem commented Aug 14, 2023
View reviewed changes
Comment thread package.json Outdated
"dependencies": {
"@uswds/compile": "^1.0.0-beta.3",
"@uswds/uswds": "^3.5.0"
"@uswds/uswds": "github:uswds/uswds#al-sticky-table-header"

@amyleadem amyleadem Aug 14, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Warning
We should revert this branch before merge

Amy Leadem added 2 commits August 14, 2023 09:06
Amy Leadem
Revert changes from 3.6.0 release
060f724 
- Accidentally pulled in to this PR
Amy Leadem
Update package-lock
74e679e
amyleadem
amyleadem commented Aug 14, 2023
View reviewed changes
Comment thread _data/settings/components/table.yml Outdated
@amyleadem
amyleadem marked this pull request as ready for review August 14, 2023 17:55
@amyleadem
amyleadem requested review from mahoneycm and mejiaj August 14, 2023 17:55
mahoneycm
mahoneycm suggested changes Aug 15, 2023
View reviewed changes

@mahoneycm mahoneycm left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey Amy! I noticed a visual bug when looking at the component preview. More detail in comments below.

I think we should also add usage guidance about not using it with the stacked or scrollable variants to the usability section. We have similar guidance on when not to use sortable tables

Let me know what you think!

Comment thread _components/table/table.md
Comment thread _data/settings/components/table.yml Outdated
Comment thread css/_uswds-theme-custom-styles.scss
amyleadem added 2 commits January 10, 2024 15:56
amyleadem
Update top position on sticky table header example
c240f06 
- This accommodates the height of the sticky header
amyleadem
Update package-lock
8df5813
@mahoneycm mahoneycm mentioned this pull request Feb 1, 2024
Closed
5 tasks done
@amyleadem
amyleadem changed the base branch from main to release-3.8.0 February 20, 2024 19:29
@amyleadem amyleadem mentioned this pull request Feb 28, 2024
Merged
@amyleadem
amyleadem requested a review from mahoneycm February 28, 2024 19:03
mahoneycm
mahoneycm reviewed Feb 29, 2024
View reviewed changes
Comment thread _data/settings/components/table.yml
@mahoneycm
mahoneycm self-requested a review March 4, 2024 17:35
mahoneycm
mahoneycm approved these changes Mar 4, 2024
View reviewed changes

@mahoneycm mahoneycm left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm!

@amyleadem
amyleadem merged commit a813c13 into release-3.8.0 Mar 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mejiaj mejiaj Awaiting requested review from mejiaj
1 more reviewer
@mahoneycm mahoneycm mahoneycm approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@amyleadem @mahoneycm