Generic addon decorators #3555
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,37 @@ | ||
| import { document } from 'global'; | ||
| import axe from 'axe-core'; | ||
| import addons from '@storybook/addons'; | ||
| import Events from '@storybook/core-events'; | ||
| import { logger } from '@storybook/client-logger'; | ||
|
|
||
| import { CHECK_EVENT_ID, RERUN_EVENT_ID } from './shared'; | ||
|
|
||
| let axeOptions = {}; | ||
|
|
||
| export const configureA11y = (options = {}) => { | ||
| axeOptions = options; | ||
| }; | ||
|
|
||
| const runA11yCheck = () => { | ||
| const channel = addons.getChannel(); | ||
| const wrapper = document.getElementById('root'); | ||
|
|
||
| axe.reset(); | ||
| axe.configure(axeOptions); | ||
| axe.run(wrapper).then(results => channel.emit(CHECK_EVENT_ID, results), logger.error); | ||
| }; | ||
|
|
||
| const a11ySubscription = () => { | ||
| const channel = addons.getChannel(); | ||
| channel.on(Events.STORY_RENDERED, runA11yCheck); | ||
| channel.on(RERUN_EVENT_ID, runA11yCheck); | ||
| return () => { | ||
| channel.removeListener(Events.STORY_RENDERED, runA11yCheck); | ||
| channel.removeListener(RERUN_EVENT_ID, runA11yCheck); | ||
| }; | ||
| }; | ||
|
|
||
| export const checkA11y = story => { | ||
| addons.getChannel().emit(Events.REGISTER_SUBSCRIPTION, a11ySubscription); | ||
| return story(); | ||
| }; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -69,17 +69,3 @@ storiesOf("Button", module) | |
| .addDecorator(backgrounds) | ||
| .add("with text", () => <button>Click me</button>); | ||
| ``` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| module.exports = require('./dist/deprecated'); | ||
|
There was a problem hiding this comment. I think we can keep those files for one alpha release |
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import deprecate from 'util-deprecate'; | ||
|
|
||
| import backgrounds from '.'; | ||
|
|
||
| export default deprecate( | ||
| backgrounds, | ||
| "addon-backgrounds: framework-specific imports are deprecated, just use `import backgrounds from '@storybook/addon-backgrounds`" | ||
| ); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the pattern we want to encourage?
I feel like it is more inflexible than we might like, i.e it means stories can only ever be rendered in
#root, whereas there are other conceivable ways you might want to render a story.Could we instead do something like:
Not sure if that's the best API, but does the idea make sense?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense, will try something like
STORY_RENDEREDeventNot sure that I get what you mean by other ways to render a story though. The current setup with
showMainetc expects that everything you render is inside#rootThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess what I mean is that at the moment you can call
const story = getStory()on the story store and then execute that function to get something renderable (how you render that depends on the view layer of course). At the moment that function is also wrapped in the relevant decorators and those decorators will work however the story is rendered.At the moment the only place a story is rendered is to the
#rootvia therenderMainfunction, but other ways you might want to render a story is e.g. inside some<Story/>element in a documentation site.Maybe I'm overthinking it, we would need to think about how decorators/addons make sense in that context a bit anyway, but it's something I think we will want to do in the future.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's a pattern we could support in SBNext
CC @ndelangen
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added
STORY_RENDEREDevent to avoidsetTimeout(fn, 0), but I decided to keep#rootpart for now. Most of the addons, including a11y, have manager part, so they are unusable outside of storybook context. So I think that gettingrootEldynamically would bring more complexity than value right nowThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
WFM, thanks for talking through it with me.