Skip to content

Commit

Permalink
Merge pull request #27132 from storybookjs/misc-docs-updates
Browse files Browse the repository at this point in the history
Docs: Misc 8.1 updates
(cherry picked from commit 3974106)
  • Loading branch information
kylegach authored and shilman committed May 15, 2024
1 parent a1ae8d2 commit 9a98574
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 3 deletions.
4 changes: 2 additions & 2 deletions code/addons/docs/docs/docspage.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,8 +165,8 @@ You can override this default behavior in `.storybook/preview.js` (or in any of
```js
export const parameters = {
docs: {
source: {
state: 'open',
canvas: {
sourceState: 'shown',
},
},
};
Expand Down
4 changes: 3 additions & 1 deletion docs/api/portable-stories-playwright.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Portable stories in Playwright'
title: 'Portable stories in Playwright CT'
---

export const SUPPORTED_RENDERERS = ['react', 'vue'];
Expand Down Expand Up @@ -34,6 +34,8 @@ Normally, Storybook composes a story and its [annotations](#annotations) automat

<Callout variant="warning">

Your project must be using React 18+ to use the portable stories API with Playwright CT.

**Using `Next.js`?** The portable stories API is not yet supported in Next.js with Playwright CT.

<!-- **Using `Next.js`?** Next.js requires specific configuration that is only available in [Jest](./portable-stories-jest.md). The portable stories API is not supported in Next.js with Playwright CT. -->
Expand Down
10 changes: 10 additions & 0 deletions docs/writing-stories/mocking-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,16 @@ import { getUserFromSession } from '#lib/session';
// ... rest of the file
```

<Callout variant="info">

Subpath imports will only be correctly resolved and typed when the [`moduleResolution` property](https://www.typescriptlang.org/tsconfig/#moduleResolution) is set to `'Bundler'`, `'NodeNext'`, or `'Node16'` in your TypeScript configuration.

If you are currently using `'node'`, that is intended for projects using a Node.js version older than v10. Projects written with modern code likely do not need to use `'node'`.

Storybook recommends the [TSConfig Cheat Sheet](https://www.totaltypescript.com/tsconfig-cheat-sheet) for guidance on setting up your TypeScript configuration.

</Callout>

## Builder aliases

If your project is unable to use [subpath imports](#subpath-imports), you can configure your Storybook builder to alias the module to the mock file. This will instruct the builder to replace the module with the mock file when bundling your Storybook stories.
Expand Down

0 comments on commit 9a98574

Please sign in to comment.