Skip to content
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

USWDS-Site - Table: Restore standard table and striped table component previews #2143

Merged
merged 9 commits into from
Jul 17, 2023

Conversation

mahoneycm
Copy link
Contributor

@mahoneycm mahoneycm commented Jun 14, 2023

Summary

Restore standard table and striped table component previews to guidance page

Related issue

Closes #2140

Preview link

Preview link:
Table →

Problem statement

The Table guidance page was missing the standard and striped component previews and code blocks

Solution

Create standard and striped variant markdown files and component code include file.

Testing and review

  1. Visit the Table guidance page
  2. Confirm that standard & striped table previews are visible
  3. Confirm their code previews are correct and not missing any markup
  4. Confirm that side-nav matches page flow and that variants are in the expected order
  5. Confirm appropriate change log items

Note: Both standard and striped variants don't appear to ever have had a lead sentence. Left blank for now.

Screenshot

image

Before opening this PR, make sure you’ve done whichever of these applies to you:

  • Confirm that this code follows the 18F Front End Coding Style Guide and Accessibility Guide.
  • Run git pull origin [base branch] to pull in the most recent updates from your base and check for merge conflicts. (Often, the base branch is main).
  • Run npm test and confirm that all tests pass.

@mahoneycm mahoneycm marked this pull request as ready for review June 14, 2023 21:04
Copy link
Contributor

@mejiaj mejiaj left a comment

Choose a reason for hiding this comment

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

Thanks for fixing this! Confirming it matches what's on wayback machine.

@@ -4,6 +4,13 @@ type: component
changelogURL:

items:
- date: NNNN-NN-NN
Copy link
Contributor

Choose a reason for hiding this comment

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

Flagging this for change before merge.

Copy link
Contributor

@amyleadem amyleadem left a comment

Choose a reason for hiding this comment

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

Thanks for finding and fixing this so quickly, @mahoneycm! Added a couple of small effort fixes for your review.

  • Confirmed that all USWDS table variants are represented in uswds-site
  • Confirmed that the variants and order match what is found in the wayback machine
  • Confirmed that component preview and component code for standard and striped variants match what is found in Storybook
  • Confirmed presentation in sidenav
    • Found a typo that prevented the link text from appearing. Added a suggestion below.
  • Proofed changlog entry for accuracy and typos.
    • Added some small notes below.

_components/table/02-striped-table.md Outdated Show resolved Hide resolved
_data/changelogs/component-table.yml Outdated Show resolved Hide resolved
_data/changelogs/component-table.yml Outdated Show resolved Hide resolved
_components/table/table.md Outdated Show resolved Hide resolved
mahoneycm and others added 2 commits June 15, 2023 15:13
Co-authored-by: Amy Leadem <93996430+amyleadem@users.noreply.github.com>
Co-authored-by: Amy Leadem <93996430+amyleadem@users.noreply.github.com>
@mahoneycm mahoneycm requested a review from amyleadem June 16, 2023 18:39
@amyleadem
Copy link
Contributor

@mahoneycm I added a couple of responses to my earlier comments. I am seeing that a couple items didn't get committed. Let me know if you have questions!

mahoneycm and others added 2 commits June 16, 2023 16:22
Co-authored-by: Amy Leadem <93996430+amyleadem@users.noreply.github.com>
Co-authored-by: Amy Leadem <93996430+amyleadem@users.noreply.github.com>
@mahoneycm
Copy link
Contributor Author

@amyleadem sorry about that! Changes are committed now!

Copy link
Contributor

@amyleadem amyleadem left a comment

Choose a reason for hiding this comment

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

Looks good!

@mejiaj mejiaj merged commit 0c13252 into main Jul 17, 2023
@mejiaj mejiaj deleted the cm-restore-standard-striped-table branch July 17, 2023 14:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

USWDS-Site - Bug: Table guidance page missing standard usa-table variant
3 participants