Skip to content

Commit eb552d1

Browse files
authored
chore(docs): Add note to Storybook guide about StaticImage (#33127)
1 parent 4ff5026 commit eb552d1

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/docs/how-to/testing/visual-testing-with-storybook.md

+2
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,8 @@ Storybook v6 has [out-of-the-box support for TypeScript](https://storybook.js.or
162162

163163
A complete guide to writing stories is beyond the scope of this guide, but we'll take a look at creating a story.
164164

165+
> **Note:** Writing stories for components that use `StaticImage` from `gatsby-plugin-image` is currently not supported. Contributions to making this possible are welcome.
166+
165167
First, create the story file. Storybook looks for all files with a `.stories.js` extension and loads them into Storybook for you. Generally, you will want your stories near where the component is defined. However, since this is Gatsby, you will have to create those files outside the `pages` directory if you want stories for your pages.
166168

167169
A good solution is to use the `stories` directory which was created when Storybook was installed and put any page stories in there.

0 commit comments

Comments
 (0)