From ebc326dd82b7962d256d87630b9e300467436616 Mon Sep 17 00:00:00 2001 From: Sam Magura Date: Sat, 23 Oct 2021 17:05:24 -0400 Subject: [PATCH] docs: Reference section about TSConfig paths --- docs/configure/typescript.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/configure/typescript.md b/docs/configure/typescript.md index 353d8dda80e..9444a2bb0ea 100644 --- a/docs/configure/typescript.md +++ b/docs/configure/typescript.md @@ -2,7 +2,7 @@ title: 'TypeScript' --- -Storybook has built-in Typescript support, so your Typescript project should work with zero configuration needed. +Storybook has built-in Typescript support, so your Typescript project should work with zero configuration needed [unless you use the `paths` option in your TSConfig.](./webpack#typescript-module-resolution) ### Default configuration @@ -30,14 +30,12 @@ The following code snippets shows the fields for you to use with TypeScript: -| Field | Framework | Description | Type | -| :------------------------------- | :-------- | :------------------------------------------------------------------------------------------ | :----------------------------------------------------------------------------------------------------- | -| **check** | All | Optionally run fork-ts-checker-webpack-plugin | boolean | +| 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](https://github.com/hipstersmoothie/react-docgen-typescript-plugin) | - - +| **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](https://github.com/hipstersmoothie/react-docgen-typescript-plugin) | ### Overriding the configuration to infer additional props @@ -61,4 +59,4 @@ Next time you restart your Storybook the extra props will also be in the UI.
If you run into an issue where the extra props aren't included, check how your component is being exported. If it's using a default export, change it to a named export and the extra props will be included as well. -
\ No newline at end of file +