Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention TSX index file requirement in README #6887

Merged
merged 2 commits into from
Jun 3, 2019
Merged

Mention TSX index file requirement in README #6887

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
208c3d1
Mention TSX index file requirement in README
jefflovejapan May 27, 2019
986f2a7
Update index.md
ndelangen Jun 3, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/src/pages/configurations/typescript-config/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,10 @@ module.exports = ({ config, mode }) => {

The default `tsconfig.json` that comes with CRA works great. If your stories are outside the `src` folder, for example the `stories` folder in root, then `"rootDirs": ["src", "stories"]` needs to be added to be added to `compilerOptions` so it knows what folders to compile. Make sure `jsx` is set to preserve. Should be unchanged.

## Create a TSX storybook index

The default storybook index file is `stories/index.js` -- you'll want to rename this to `stories/index.tsx`.

## Import tsx stories

Change `config.ts` inside the Storybook config directory (by default, it’s `.storybook`) to import stories made with TypeScript:
Expand Down