Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 3.52 KB

typescript.md

File metadata and controls

62 lines (42 loc) · 3.52 KB
title
TypeScript

Storybook has built-in TypeScript support, so your TypeScript project should work with zero configuration needed.

Default configuration

The base TypeScript configuration uses babel-loader for TypeScript transpilation, and optionally fork-ts-checker-webpack-plugin for checking.

Each framework uses the base configuration unless otherwise specified:

  • Angular ignores the base and uses ts-loader and ngx-template-loader.
  • Vue ignores the base and uses ts-loader and applies it to both .tsx and .vue files.
  • React adds react-docgen-typescript-plugin to the base.

Main.js configuration

To make it easier to configure TypeScript handling, use the typescript field in your .storybook/main.js.

The following code snippets show the fields for you to use with TypeScript:

<CodeSnippets paths={[ 'common/storybook-main-add-ts-config.js.mdx', 'common/storybook-main-add-ts-config.ts.mdx', ]} />

Field Framework Description Type
check All Optionally run fork-ts-checker-webpack-plugin boolean
checkOptions All Options to pass to fork-ts-checker-webpack-plugin if it's enabled See Docs
reactDocgen React Which react docgen processor to run: "react-docgen-typescript", "react-docgen", false string or false
reactDocgenTypescriptOptions React Options to pass to react-docgen-typescript-plugin if react-docgen-typescript is enabled. See docs

Overriding the configuration to infer additional props

The configuration provided above will remove any props from any third-party libraries.

If required, you can adjust the configuration and include the extra props.

Adjust the configuration as demonstrated below. And the next time you restart your Storybook, the extra props will also be in the UI.

<CodeSnippets paths={[ 'common/storybook-main-extend-ts-config.js.mdx', 'common/storybook-main-extend-ts-config.ts.mdx', ]} />

If you run into an issue where any additional props don't show up, check your component's code. If you're using a default export, change it to a named export, and doing that will ensure that the additional props are included.