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

[Component] Verify Tagline Component #205

Closed
19 of 21 tasks
billhimmelsbach opened this issue Oct 19, 2023 · 0 comments · Fixed by #218
Closed
19 of 21 tasks

[Component] Verify Tagline Component #205

billhimmelsbach opened this issue Oct 19, 2023 · 0 comments · Fixed by #218
Assignees

Comments

@billhimmelsbach
Copy link
Contributor

billhimmelsbach commented Oct 19, 2023

Verify banner component to be used in the component library

Context

Screenshot 2023-10-19 at 8 00 19 AM

Verification checklist

For existing components

Verify the CFPB Design System (React) component against the CFPB Design System

  • Has component intro text copied from the DS page
  • Has source link to component's DS page (ex - Source: https://cfpb.github.io/design-system/components/banner-notification)
  • Each DS variant is implemented as a separate story
    • Story name should be sentence case (ex. List Link => List link)
    • Naming is consistent with the DS
    • Same component names, same placeholder text, etc.
  • Order of stories matches between DS/DSR
  • Component is built correctly
    • Visually compare DSR implementation to DS
    • Verify that DS classes (organisms, molecules, atoms) are used, as opposed to styles defined in DSR
  • Manual visual review has been conducted and component has passed this review

Run accessibility checks

  • Component is keyboard-friendly (navigable with tab, space, enter, arrow keys, etc.)
  • Component does not introduce new errors or warnings in WAVE
  • Component is screen reader friendly (screen reader testing demo)
    • Is all the meaningful visual information and text of the component conveyed by the screen reader? (text, non-decorative image descriptions, etc.)
    • When interacting with the component using a screen reader, do you have all the information you need to use it? (selected vs unselected, button vs link, expanded vs collapsed, etc.)
    • Does the component have similar screen reader behavior as the sample components in WCAG, WebAIM, or similar accessibility examples?
  • For reference: CFPB manual web accessibility audit

Verify component unit tests

  • Verify component unit tests are implemented and passing - 85% or greater (ex: yarn vitest Button)

Conduct PR review

  • The component has been reviewed and approved by UI, UX, and FEWD

Verify component

  • Move component to verified in Storybook
@billhimmelsbach billhimmelsbach self-assigned this Oct 19, 2023
billhimmelsbach added a commit that referenced this issue Oct 26, 2023
I went through and [verified the Tagline component](#205) as part of the work on the banner component. Only small changes to the documentation appear to be needed. I didn't add the deprecated "Extra large tagline" story from the design system, since it was deprecated and all, but we can chat about that at the DSR sync. 

## Changes

- add component description
- remove heading
- change stories to sentence case

## How to test this PR

1. Take a peek at the DSR and see how it looks

## Screenshots
![Screenshot 2023-10-19 at 9 48 05 AM](https://github.com/cfpb/design-system-react/assets/19983248/684c015c-bd8d-4a6c-b054-0fdb1158c7e0)

## Notes
I didn't mark this component as "verified" in this PR, since I'm not sure if we have an official stamp of approval process yet, so I'll hold off till at least we chat about it at the sync.
meissadia pushed a commit that referenced this issue Oct 26, 2023
I went through and [verified the Tagline component](#205) as part of the work on the banner component. Only small changes to the documentation appear to be needed. I didn't add the deprecated "Extra large tagline" story from the design system, since it was deprecated and all, but we can chat about that at the DSR sync. 

## Changes

- add component description
- remove heading
- change stories to sentence case

## How to test this PR

1. Take a peek at the DSR and see how it looks

## Screenshots
![Screenshot 2023-10-19 at 9 48 05 AM](https://github.com/cfpb/design-system-react/assets/19983248/684c015c-bd8d-4a6c-b054-0fdb1158c7e0)

## Notes
I didn't mark this component as "verified" in this PR, since I'm not sure if we have an official stamp of approval process yet, so I'll hold off till at least we chat about it at the sync.
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 a pull request may close this issue.

1 participant