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.

Sign up for GitHub

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

Jump to bottom

Storybook: Implement A11y addon #641

Closed
8 tasks done
JoCa96 opened this issue Mar 15, 2024 · 4 comments
Closed
8 tasks done

Storybook: Implement A11y addon #641

JoCa96 opened this issue Mar 15, 2024 · 4 comments
Assignees
@MajaZarkova
Labels
dev Requires technical expertise documentation Improvements or additions to documentation storybook Storybook improve- or adjustments
Milestone
Release preparation

Comments

@JoCa96
Copy link
Collaborator

JoCa96 commented Mar 15, 2024 •
edited
Loading

Why?

We want to emphasize our focus on accessibility.
By adding the addon-a11y add-on to our Storybook, we are able to show our commitment to accessibility and the quality of our components.

Acceptance criteria

  • The Accessibility tab of the add-on is available in our Storybook Stories
  • If possible, share the axe configuration (not the ignore rules)

Definition of Done

  • follow-up tickets were created if necessary
  • updated version + documentation is deployed
  • Storybook can show the feature
  • Set task to In Approval

Approval

  • Storybook, the ticket is about the accessibility tab right next to 'Controls' and 'Actions'.
  • approved by designer @jannick-ux
  • approved by dev @JoCa96

Implementation details

Reference implementations
@JoCa96 JoCa96 added this to onyx Mar 15, 2024
@JoCa96 JoCa96 converted this from a draft issue Mar 15, 2024
@BoppLi BoppLi added dev Requires technical expertise documentation Improvements or additions to documentation labels Mar 26, 2024
This was referenced Apr 15, 2024
Closed
Closed
@mj-hof mj-hof added the storybook Storybook improve- or adjustments label Apr 17, 2024
@mj-hof mj-hof changed the title Implement adding Storybook A11y Addon Storybook: Implement A11y addon Apr 17, 2024
@mj-hof mj-hof added this to the Release preparation milestone Apr 17, 2024
@mj-hof mj-hof added the 0-refinement All issues that can or need to be estimated in our next refinement label Sep 12, 2024
@mj-hof mj-hof moved this from New to Backlog in onyx Sep 12, 2024
@mj-hof mj-hof moved this from Backlog to New in onyx Sep 12, 2024
@mj-hof mj-hof removed the 0-refinement All issues that can or need to be estimated in our next refinement label Sep 12, 2024
@JoCa96 JoCa96 mentioned this issue Sep 12, 2024
Open
@JoCa96 JoCa96 moved this from New to Backlog in onyx Oct 1, 2024
@JoCa96 JoCa96 added the 0-refinement All issues that can or need to be estimated in our next refinement label Oct 1, 2024
@mj-hof mj-hof moved this from Backlog to Ready in onyx Oct 2, 2024
@mj-hof mj-hof removed the 0-refinement All issues that can or need to be estimated in our next refinement label Oct 2, 2024
@MajaZarkova MajaZarkova self-assigned this Oct 3, 2024
@MajaZarkova MajaZarkova moved this from Ready to In Progress in onyx Oct 3, 2024
@MajaZarkova MajaZarkova mentioned this issue Oct 3, 2024
Merged
MajaZarkova added a commit that referenced this issue Oct 7, 2024
@MajaZarkova
chore: Impelement a11y addon (#1921)
47c57d8 
<!-- Is your PR related to an issue? Then please link it via the
"Relates to #" below. Else, remove it. -->

Relates to #641 

Impelement a11y addon in Storybook
@MajaZarkova MajaZarkova moved this from In Progress to In Approval in onyx Oct 7, 2024
@larsrickert
Copy link
Collaborator

@MajaZarkova Do you know which rules the addon applies/checks by default? Since we decided to aim for AA, we should ensure that all rules for AA are also included in the Storybook addon :)

@MajaZarkova
Copy link
Contributor

I don't, but I can investigate

@MajaZarkova
Copy link
Contributor

@larsrickert , I found the list with the rules -> https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md

@larsrickert
Copy link
Collaborator

@larsrickert , I found the list with the rules -> https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md

These are just all available rules, right? We should check which of them are actually checked by the Storybook addon. E.g. it might only check a few of them by default and we might need to configure it to check more. But I am not sure 🤔

@MajaZarkova MajaZarkova mentioned this issue Oct 11, 2024
Merged
JoCa96 pushed a commit that referenced this issue Oct 11, 2024
@MajaZarkova
chore(storybook): Restrict a11y rules on Storybook (#1953)
be794c6 
<!-- Is your PR related to an issue? Then please link it via the
"Relates to #" below. Else, remove it. -->

Relates to #641 

Restrict a11y rules on Storybook
@JoCa96 JoCa96 moved this from In Approval to Done in onyx Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MajaZarkova MajaZarkova

Labels
dev Requires technical expertise documentation Improvements or additions to documentation storybook Storybook improve- or adjustments
Projects
onyx
Status: Done
Milestone
Release preparation
Development

No branches or pull requests
5 participants
@JoCa96 @MajaZarkova @larsrickert @BoppLi @mj-hof