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

Cleanup & document a11y migration #5833

Merged
merged 2 commits into from Mar 4, 2019
Merged

Cleanup & document a11y migration #5833

merged 2 commits into from Mar 4, 2019

Conversation

shilman
Copy link
Member

@shilman shilman commented Mar 4, 2019

Issue: #5832

What I did

  • simplify, document, test
  • added a story to test story-level config
  • renamed withA11Y to withA11y for consistency

How to test

See new story in official-storybook

@shilman shilman added maintenance User-facing maintenance tasks addon: a11y release labels Mar 4, 2019
@vercel
Copy link

vercel bot commented Mar 4, 2019

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

tmeasday
tmeasday approved these changes Mar 4, 2019
View reviewed changes
Copy link
Member

@tmeasday tmeasday left a comment

Choose a reason for hiding this comment

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

Thanks @shilman! Small suggestions

MIGRATION.md Outdated
addParameters({ a11y: options });
```

You can pass `a11y` parameters at the global level (via `addParameters` imported from `@storybook/react` et al.), and the story level (via the third argument to `.add()`).
Copy link
Member

Choose a reason for hiding this comment

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

Should this line be "the component level"? (given the example above is global)

@codecov
Copy link

codecov bot commented Mar 4, 2019

Codecov Report

Merging #5833 into next will decrease coverage by <.01%.
The diff coverage is 0%.

Impacted file tree graph

@@            Coverage Diff             @@
##             next    #5833      +/-   ##
==========================================
- Coverage   34.31%   34.31%   -0.01%     
==========================================
  Files         648      648              
  Lines        9461     9463       +2     
  Branches     1370     1344      -26     
==========================================
  Hits         3247     3247              
- Misses       5596     5598       +2     
  Partials      618      618
Impacted Files Coverage Δ
addons/a11y/src/index.js 0% <0%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 51be1fc...be07879. Read the comment docs.

@vercel vercel bot requested a deployment to staging March 4, 2019 06:19 Abandoned
@shilman shilman merged commit 3ffa081 into next Mar 4, 2019
@shilman shilman deleted the 5832-a11y-migration branch March 4, 2019 06:19
@vercel vercel bot requested a deployment to staging March 4, 2019 06:19 Abandoned
shilman added a commit that referenced this pull request Mar 4, 2019
@shilman
Merge pull request #5833 from storybooks/5832-a11y-migration
b5451c6 
Cleanup & document a11y migration
@shilman shilman mentioned this pull request Mar 4, 2019
Closed
@Hypnosphi
Copy link
Member

renamed withA11Y to withA11y

I understand that withA11Y was only introduced in alpha and it's technicaly no breaking change, but It was really hard to debug the reason of "decorator is not a function" error =(

Can we keep the old spelling as a deprecated export?

@shilman shilman added this to the v5.0.0 milestone Mar 4, 2019
@shilman
Copy link
Member Author

shilman commented Mar 4, 2019

Ugh, sorry about that @Hypnosphi. Will fix now!

@shilman shilman mentioned this pull request Mar 4, 2019
Merged
@shilman shilman added the patch:done Patch/release PRs already cherry-picked to main/release branch label Mar 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tmeasday tmeasday tmeasday approved these changes

@danielduan danielduan Awaiting requested review from danielduan

@Hypnosphi Hypnosphi Awaiting requested review from Hypnosphi

@jbovenschen jbovenschen Awaiting requested review from jbovenschen

@usulpro usulpro Awaiting requested review from usulpro

Assignees
No one assigned
Labels
addon: a11y maintenance User-facing maintenance tasks patch:done Patch/release PRs already cherry-picked to main/release branch
Projects
None yet
Milestone
v5.0.0
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@shilman @Hypnosphi @tmeasday