From 9a98574ef4009f5bd1df66e52768150d3fe848ac Mon Sep 17 00:00:00 2001 From: Kyle Gach Date: Wed, 15 May 2024 10:24:50 -0600 Subject: [PATCH] Merge pull request #27132 from storybookjs/misc-docs-updates Docs: Misc 8.1 updates (cherry picked from commit 3974106634ef30c755aa0700ccfaa74ba40d6a7c) --- code/addons/docs/docs/docspage.md | 4 ++-- docs/api/portable-stories-playwright.md | 4 +++- docs/writing-stories/mocking-modules.md | 10 ++++++++++ 3 files changed, 15 insertions(+), 3 deletions(-) diff --git a/code/addons/docs/docs/docspage.md b/code/addons/docs/docs/docspage.md index 5e89251c2ede..ea50050f6b94 100644 --- a/code/addons/docs/docs/docspage.md +++ b/code/addons/docs/docs/docspage.md @@ -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', }, }, }; diff --git a/docs/api/portable-stories-playwright.md b/docs/api/portable-stories-playwright.md index ae7d012b8445..38dc1502f0a4 100644 --- a/docs/api/portable-stories-playwright.md +++ b/docs/api/portable-stories-playwright.md @@ -1,5 +1,5 @@ --- -title: 'Portable stories in Playwright' +title: 'Portable stories in Playwright CT' --- export const SUPPORTED_RENDERERS = ['react', 'vue']; @@ -34,6 +34,8 @@ Normally, Storybook composes a story and its [annotations](#annotations) automat +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. diff --git a/docs/writing-stories/mocking-modules.md b/docs/writing-stories/mocking-modules.md index 0f165546a381..d80c3bfe1241 100644 --- a/docs/writing-stories/mocking-modules.md +++ b/docs/writing-stories/mocking-modules.md @@ -95,6 +95,16 @@ import { getUserFromSession } from '#lib/session'; // ... rest of the file ``` + + +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. + + + ## 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.