Skip to content

Commit

Permalink
Update typescript.md for main.ts
Browse files Browse the repository at this point in the history
You need ts-node to make the configuration file .ts. I have spent a lot of time trying to figure this out. Therefore, I would like to add this change to the documentation.
  • Loading branch information
mrskiro authored Jul 19, 2021
1 parent 93b1df5 commit b136ab8
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/configure/typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ Each framework uses the base configuration unless otherwise specified:

To make it easier to configure Typescript handling, use the `typescript` field in your [`.storybook/main.js`](./overview.md#configure-story-rendering).

<div class="aside">
If you want the configration to be main.ts, you will need [ts-node](https://github.com/TypeStrong/ts-node) as a dependency.
</div>


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

<!-- prettier-ignore-start -->
Expand Down Expand Up @@ -61,4 +66,4 @@ Next time you restart your Storybook the extra props will also be in the UI.

<div class="aside">
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.
</div>
</div>

0 comments on commit b136ab8

Please sign in to comment.