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:

module.exports = {
  typescript: {
    check: false,
    checkOptions: {},
    reactDocgen: 'react-docgen-typescript',
    reactDocgenTypescriptOptions: {
      shouldExtractLiteralValuesFromEnum: true,
      propFilter: (prop) => (prop.parent ? !/node_modules/.test(prop.parent.fileName) : true),
    },
  },
};

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.

module.exports = {
  stories: [],
  addons: [],
  typescript: {
    reactDocgen: 'react-docgen-typescript',
    reactDocgenTypescriptOptions: {
      compilerOptions: {
        allowSyntheticDefaultImports: false,
        esModuleInterop: false,
      },
    }
  }
};