New
Storybook’s Visual Tests addon enters betaVisual test with Chromatic
Star82,099

typescript

Parent: main.js|ts configuration

Type:

Loading...

Configures how Storybook handles TypeScript files.

check

Type: boolean

Optionally run fork-ts-checker-webpack-plugin. Note that because this uses a Webpack plugin, it is only available when using the Webpack builder.

checkOptions

Type: CheckOptions

Options to pass to fork-ts-checker-webpack-plugin, if enabled. See docs for available options.

reactDocgen

Type: 'react-docgen' | 'react-docgen-typescript' | false

Default:

  • false: if @storybook/react is not installed
  • 'react-docgen-typescript': if @storybook/react and typescript are installed
  • 'react-docgen': if @storybook/react is installed

Only available for React Storybook projects. Configure which library, if any, Storybook uses to parse React components, react-docgen or react-docgen-typescript. Set to false to disable parsing React components.

reactDocgenTypescriptOptions

Type: ReactDocgenTypescriptOptions

Only available for React Storybook projects. Options to pass to react-docgen-typescript-plugin if react-docgen-typescript is enabled. See docs for available options.

skipBabel

Deprecated: Will be removed in Storybook 8.0. Use skipCompiler instead.

Type: boolean

Disable parsing of TypeScript files through Babel.

skipCompiler

Type: boolean

Disable parsing of TypeScript files through the compiler, which is used for Webpack5.

Was this page helpful?

Markdown accepted ([link text](url), _italic_, **bold**, etc). Your anonymous feedback will be posted publicly on GitHub.

✍️ Edit on GitHub – PRs welcome!
Storybook
Join the community
6,514 developers and counting
WhyWhy StorybookComponent-driven UI
Open source software
Storybook

Maintained by
Chromatic
Special thanks to Netlify and CircleCI