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

Would love to have the a11y plugin included, how can I help ? #41

Open
sync opened this issue Jan 18, 2021 · 7 comments
Open

Would love to have the a11y plugin included, how can I help ? #41

sync opened this issue Jan 18, 2021 · 7 comments

Comments

@sync
Copy link

sync commented Jan 18, 2021

Happy to do the work, if you give me some guidelines, I am comfortable with rollup, esm and friends

@sync
Copy link
Author

sync commented Jan 18, 2021

I can include it get the plugin booted but I have to remove references form api.useChannel (emit)

@sync
Copy link
Author

sync commented Jan 18, 2021

cannot get past this error

  this.getChannel = function () {
    // this.channel should get overwritten by setChannel. If it wasn't called (e.g. in non-browser environment), throw.
    if (!_this.channel) {
      throw new Error('Accessing non-existent addons channel, see https://storybook.js.org/basics/faq/#why-is-there-no-addons-channel');
    }

@dan-valinotti
Copy link

+1 this issue, I definitely think that the a11y addon should be included in this package since I can't seem to find a working solution to add my own plugins.

It would make a lot of sense to include the a11y addon, since Accessibility is obviously something @open-wc cares about since they include docs in their site for testing + ESLint a11y.

@bennypowers
Copy link
Member

@sync can you provide a little more context? what have you done so far and how do you get to that error?

@sync
Copy link
Author

sync commented Aug 5, 2021

to be honest the new esm storybook and Vite builder got super fast now, but I'll look at what I did in January (it's been a while)

@LarsDenBakker
Copy link
Member

I don't want to add the a11y addon by default, as it always loads axe which is huge. It would be great if the a11y addon lazy loads axe when you switch to the panel.

Since we do a11y testing in eslint and during testing, I personally don't see that much extra value in the addon. However we could make it optional, ideally creating a prebuild which you can import and add to the addons array.

@dan-valinotti
Copy link

I don't want to add the a11y addon by default, as it always loads axe which is huge. It would be great if the a11y addon lazy loads axe when you switch to the panel.

Since we do a11y testing in eslint and during testing, I personally don't see that much extra value in the addon. However we could make it optional, ideally creating a prebuild which you can import and add to the addons array.

I think this is a good middle ground. Great point that you'd have to have axe as a dependency even if you didn't need it, I think the larger issue is that this is a prebuilt system but it's not extendible, ie you can't bring your own addons, or choose which addons you want/don't want on install.

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

No branches or pull requests

4 participants