mirror of
https://github.com/storybookjs/storybook.git
synced 2025-04-06 15:31:16 +08:00
Merge pull request #26081 from storybookjs/api-ref-portable-stories
Documentation: API reference for portable stories
This commit is contained in:
Yann Braga
GitHub
commit
6933131242
315
docs/api/portable-stories-jest.md
Normal file
315
docs/api/portable-stories-jest.md
Normal file
@ -0,0 +1,315 @@
|
||||
---
|
||||
title: 'Portable stories in Jest'
|
||||
---
|
||||
|
||||
export const SUPPORTED_RENDERERS = ['react', 'vue'];
|
||||
|
||||
<If notRenderer={SUPPORTED_RENDERERS}>
|
||||
|
||||
<Callout variant="info">
|
||||
|
||||
Portable stories in Jest are currently only supported in [React](?renderer=react) and [Vue](?renderer=vue) projects.
|
||||
|
||||
</Callout>
|
||||
|
||||
<!-- End non-supported renderers -->
|
||||
|
||||
</If>
|
||||
|
||||
<If renderer={SUPPORTED_RENDERERS}>
|
||||
|
||||
Portable stories are Storybook [stories](../writing-stories/index.md) which can be used in external environments, such as [Jest](https://jestjs.io).
|
||||
|
||||
Normally, Storybok composes a story and its [annotations](#annotations) automatically, as part of the [story pipeline](#story-pipeline). When using stories in Jest tests, you must handle the story pipeline yourself, which is what the [`composeStories`](#composestories) and [`composeStory`](#composestory) functions enable.
|
||||
|
||||
<If renderer="react">
|
||||
|
||||
<Callout variant="info">
|
||||
|
||||
**Using `Next.js`?** You need to do two things differently when using portable stories in Jest with Next.js projects:
|
||||
|
||||
- Configure the [`next/jest.js` transformer](https://nextjs.org/docs/pages/building-your-application/testing/jest#manual-setup), which will handle all of the necessary Next.js configuration for you.
|
||||
- Import [`composeStories`](#composestories) or [`composeStory`](#composestory) from the `@storybook/nextjs` package (e.g. `import { composeStories } from '@storybook/nextjs'`).
|
||||
|
||||
</Callout>
|
||||
|
||||
</If>
|
||||
|
||||
## composeStories
|
||||
|
||||
`composeStories` will process the component's stories you specify, compose each of them with the necessary [annotations](#annotations), and return an object containing the composed stories.
|
||||
|
||||
By default, the composed story will render the component with the [args](../writing-stories/args.md) that are defined in the story. You can also pass any props to the component in your test and those props will override the values passed in the story's args.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
<CodeSnippets
|
||||
paths={[
|
||||
'react/portable-stories-jest-compose-stories.ts.mdx',
|
||||
'vue/portable-stories-jest-compose-stories.ts.mdx',
|
||||
]}
|
||||
/>
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
### Type
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```ts
|
||||
(
|
||||
csfExports: CSF file exports,
|
||||
projectAnnotations?: ProjectAnnotations
|
||||
) => Record<string, ComposedStoryFn>
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
### Parameters
|
||||
|
||||
#### `csfExports`
|
||||
|
||||
(**Required**)
|
||||
|
||||
Type: CSF file exports
|
||||
|
||||
Specifies which component's stories you want to compose. Pass the **full set of exports** from the CSF file (not the default export!). E.g. `import * as stories from './Button.stories'`
|
||||
|
||||
#### `projectAnnotations`
|
||||
|
||||
Type: `ProjectAnnotation | ProjectAnnotation[]`
|
||||
|
||||
Specifies the project annotations to be applied to the composed stories.
|
||||
|
||||
This parameter is provided for convenience. You should likely use [`setProjectAnnotations`](#setprojectannotations) instead. Details about the `ProjectAnnotation` type can be found in that function's [`projectAnnotations`](#projectannotations-2) parameter.
|
||||
|
||||
This parameter can be used to [override](#overriding-globals) the project annotations applied via `setProjectAnnotations`.
|
||||
|
||||
### Return
|
||||
|
||||
Type: `Record<string, ComposedStoryFn>`
|
||||
|
||||
An object where the keys are the names of the stories and the values are the composed stories.
|
||||
|
||||
Additionally, the composed story will have the following properties:
|
||||
|
||||
| Property | Type | Description |
|
||||
| ---------- | -------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| storyName | `string` | The story's name |
|
||||
| args | `Record<string, any>` | The story's [args](../writing-stories/args.md) |
|
||||
| argTypes | `ArgType` | The story's [argTypes](./arg-types.md) |
|
||||
| id | `string` | The story's id |
|
||||
| parameters | `Record<string, any>` | The story's [parameters](./parameters.md) |
|
||||
| load | `() => Promise<void>` | Executes all the [loaders](#2-load-optional) for a given story |
|
||||
| play | `(context?: StoryContext) => Promise<void> \| undefined` | Executes the [play function](#4-play-optional) of a given story |
|
||||
|
||||
## composeStory
|
||||
|
||||
You can use `composeStory` if you wish to compose a single story for a component.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
<CodeSnippets
|
||||
paths={[
|
||||
'react/portable-stories-jest-compose-story.ts.mdx',
|
||||
'vue/portable-stories-jest-compose-story.ts.mdx',
|
||||
]}
|
||||
/>
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
### Type
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```ts
|
||||
(
|
||||
story: Story export,
|
||||
componentAnnotations: Meta,
|
||||
projectAnnotations?: ProjectAnnotations,
|
||||
exportsName?: string
|
||||
) => ComposedStoryFn
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
### Parameters
|
||||
|
||||
#### `story`
|
||||
|
||||
(**Required**)
|
||||
|
||||
Type: `Story export`
|
||||
|
||||
Specifies which story you want to compose.
|
||||
|
||||
#### `componentAnnotations`
|
||||
|
||||
(**Required**)
|
||||
|
||||
Type: `Meta`
|
||||
|
||||
The default export from the stories file containing the [`story`](#story).
|
||||
|
||||
#### `projectAnnotations`
|
||||
|
||||
Type: `ProjectAnnotation | ProjectAnnotation[]`
|
||||
|
||||
Specifies the project annotations to be applied to the composed story.
|
||||
|
||||
This parameter is provided for convenience. You should likely use [`setProjectAnnotations`](#setprojectannotations) instead. Details about the `ProjectAnnotation` type can be found in that function's [`projectAnnotations`](#projectannotations-2) parameter.
|
||||
|
||||
This parameter can be used to [override](#overriding-globals) the project annotations applied via `setProjectAnnotations`.
|
||||
|
||||
#### `exportsName`
|
||||
|
||||
Type: `string`
|
||||
|
||||
You probably don't need this. Because `composeStory` accepts a single story, it does not have access to the name of that story's export in the file (like `composeStories` does). If you must ensure unique story names in your tests and you cannot use `composeStories`, you can pass the name of the story's export here.
|
||||
|
||||
### Return
|
||||
|
||||
Type: `ComposedStoryFn`
|
||||
|
||||
A single [composed story](#return).
|
||||
|
||||
## setProjectAnnotations
|
||||
|
||||
This API should be called once, before the tests run, typically in a [setup file](https://jestjs.io/docs/configuration#setupfiles-array). This will make sure that whenever `composeStories` or `composeStory` are called, the project annotations are taken into account as well.
|
||||
|
||||
<If renderer="react">
|
||||
|
||||
<Callout variant="info">
|
||||
|
||||
**Using `Next.js`?** When you import [`composeStories`](#composestories) or [`composeStory`](#composestory) from the `@storybook/nextjs` package (e.g. `import { composeStories } from '@storybook/nextjs'`), you probably do not need to call `setProjectAnnotations` yourself. The Next.js framework will handle this for you.
|
||||
|
||||
If you are using an addon that is required for your stories to render, you will still need to include that addon's `preview` export in the project annotations set. See the example and callout below.
|
||||
|
||||
</Callout>
|
||||
|
||||
<p></p>
|
||||
|
||||
</If>
|
||||
|
||||
```ts
|
||||
// setup-portable-stories.ts
|
||||
// Replace <your-renderer> with your renderer, e.g. nextjs, react, vue3
|
||||
import { setProjectAnnotations } from '@storybook/<your-renderer>';
|
||||
import * as addonAnnotations from 'my-addon/preview';
|
||||
import * as previewAnnotations from './.storybook/preview';
|
||||
|
||||
setProjectAnnotations([previewAnnotations, addonAnnotations]);
|
||||
```
|
||||
|
||||
<Callout variant="warning">
|
||||
|
||||
Sometimes a story can require an addon's [decorator](../writing-stories/decorators.md) or [loader](../writing-stories/loaders.md) to render properly. For example, an addon can apply a decorator that wraps your story in the necessary router context. In this case, you must include that addon's `preview` export in the project annotations set. See `addonAnnotations` in the example above.
|
||||
|
||||
Note: If the addon doesn't automatically apply the decorator or loader itself, but instead exports them for you to apply manually in `.storybook/preview.js|ts` (e.g. using `withThemeFromJSXProvider` from [@storybook/addon-themes](https://github.com/storybookjs/storybook/blob/next/code/addons/themes/docs/api.md#withthemefromjsxprovider)), then you do not need to do anything else. They are already included in the `previewAnnotations` in the example above.
|
||||
|
||||
</Callout>
|
||||
|
||||
### Type
|
||||
|
||||
```ts
|
||||
(projectAnnotations: ProjectAnnotation | ProjectAnnotation[]) => void
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
#### `projectAnnotations`
|
||||
|
||||
(**Required**)
|
||||
|
||||
Type: `ProjectAnnotation | ProjectAnnotation[]`
|
||||
|
||||
A set of project [annotations](#annotations) (those defined in `.storybook/preview.js|ts`) or an array of sets of project annotations, which will be applied to all composed stories.
|
||||
|
||||
## Annotations
|
||||
|
||||
Annotations are the metadata applied to a story, like [args](../writing-stories/args.md), [decorators](../writing-stories/decorators.md), [loaders](../writing-stories/loaders.md), and [play functions](../writing-stories/play-function.md). They can be defined for a specific story, all stories for a component, or all stories in the project.
|
||||
|
||||
## Story pipeline
|
||||
|
||||
To preview your stories, Storybook runs a story pipeline, which includes applying project annotations, loading data, rendering the story, and playing interactions. This is a simplified version of the pipeline:
|
||||
|
||||
|
||||
|
||||
When you want to reuse a story in a different environment, however, it's crucial to understand that all these steps make a story. The portable stories API provides you with the mechanism to recreate that story pipeline in your external environment:
|
||||
|
||||
### 1. Apply project-level annotations
|
||||
|
||||
[Annotations](#annotations) come from the story itself, that story's component, and the project. The project-level annotatations are those defined in your `.storybook/preview.js` file and by addons you're using. In portable stories, these annotations are not applied automatically—you must apply them yourself.
|
||||
|
||||
👉 For this, you use the [`setProjectAnnotations`](#setprojectannotations) API.
|
||||
|
||||
### 2. Prepare
|
||||
|
||||
The story is prepared by running [`composeStories`](#composestories) or [`composeStory`](#composestory). You do not need to do anything for this step.
|
||||
|
||||
### 3. Load
|
||||
|
||||
**(optional)**
|
||||
|
||||
Stories can prepare data they need (e.g. setting up some mocks or fetching data) before rendering by defining [loaders](../writing-stories/loaders.md). In portable stories, the loaders are not applied automatically—you have to apply them yourself.
|
||||
|
||||
👉 For this, you use the [`composeStories`](#composestories) or [`composeStory`](#composestory) API. The composed story will return a `load` method to be called **before** it is rendered.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
<CodeSnippets
|
||||
paths={[
|
||||
'react/portable-stories-jest-with-loaders.ts.mdx',
|
||||
'vue/portable-stories-jest-with-loaders.ts.mdx',
|
||||
]}
|
||||
/>
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
### 4. Render
|
||||
|
||||
At this point, the story has been prepared and can be rendered. You pass it into the
|
||||
|
||||
The story has been prepared and can be rendered. To render, you pass it into the rendering mechanism of your choice (e.g. Testing Library render function, Vue test utils mount function, etc).
|
||||
|
||||
👉 For this, you use the [`composeStories`](#composestories) or [`composeStory`](#composestory) API. The composed Story is a renderable component that can be passed to your rendering mechanism.
|
||||
|
||||
### 5. Play
|
||||
|
||||
**(optional)**
|
||||
|
||||
Finally, stories can define a [play function](../essentials/interactions.md#play-function-for-interactions) to interact with the story and assert on details after it has rendered. In portable stories, the play function does not run automatically—you have to call it yourself.
|
||||
|
||||
👉 For this, you use the [`composeStories`](#composestories) or [`composeStory`](#composestory) API. The composed Story will return a `play` method to be called **after** it has rendered.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
<CodeSnippets
|
||||
paths={[
|
||||
'react/portable-stories-jest-with-play-function.ts.mdx',
|
||||
'vue/portable-stories-jest-with-play-function.ts.mdx',
|
||||
]}
|
||||
/>
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<Callout variant="info">
|
||||
|
||||
If your play function contains assertions (e.g. `expect` calls), your test will fail when those assertions fail.
|
||||
|
||||
</Callout>
|
||||
|
||||
## Overriding globals
|
||||
|
||||
If your stories behave differently based on [globals](../essentials/toolbars-and-globals.md#globals) (e.g. rendering text in English or Spanish), you can define those global values in portable stories by overriding project annotations when composing a story:
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
<CodeSnippets
|
||||
paths={[
|
||||
'react/portable-stories-jest-override-globals.ts.mdx',
|
||||
'vue/portable-stories-jest-override-globals.ts.mdx',
|
||||
]}
|
||||
/>
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<!-- End supported renderers -->
|
||||
|
||||
</If>
|
||||
238
docs/api/portable-stories-playwright.md
Normal file
238
docs/api/portable-stories-playwright.md
Normal file
@ -0,0 +1,238 @@
|
||||
---
|
||||
title: 'Portable stories in Playwright'
|
||||
---
|
||||
|
||||
export const SUPPORTED_RENDERERS = ['react', 'vue'];
|
||||
|
||||
(⚠️ **Experimental**)
|
||||
|
||||
<If notRenderer={SUPPORTED_RENDERERS}>
|
||||
|
||||
<Callout variant="info">
|
||||
|
||||
Portable stories are currently only supported in [React](?renderer=react) and [Vue](?renderer=vue) projects.
|
||||
|
||||
</Callout>
|
||||
|
||||
<!-- End non-supported renderers -->
|
||||
|
||||
</If>
|
||||
|
||||
<If renderer={SUPPORTED_RENDERERS}>
|
||||
|
||||
Portable stories are Storybook [stories](../writing-stories/index.md) which can be used in external environments, such as [Playwright Component Tests (CT)](https://playwright.dev/docs/test-components).
|
||||
|
||||
Normally, Storybok composes a story and its [annotations](#annotations) automatically, as part of the [story pipeline](#story-pipeline). When using stories in Playwright CT, you can use the [`createTest`](#createtest) function, which extends Playwright's test functionality to add a custom `mount` mechanism, to take care of the story pipeline for you.
|
||||
|
||||
<If renderer="react">
|
||||
|
||||
<Callout variant="warning">
|
||||
|
||||
**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.
|
||||
|
||||
</Callout>
|
||||
|
||||
</If>
|
||||
|
||||
<If renderer="vue">
|
||||
|
||||
<Callout variant="info">
|
||||
|
||||
If your stories use template-based Vue components, you may need to alias the `vue` module to resolve correctly in the Playwright CT environment. You can do this via the [`ctViteConfig` property](https://playwright.dev/docs/test-components#i-have-a-project-that-already-uses-vite-can-i-reuse-the-config):
|
||||
|
||||
<details>
|
||||
<summary>Example Playwright configuration</summary>
|
||||
|
||||
```ts
|
||||
// playwright-config.ts
|
||||
import { defineConfig } from '@playwright/experimental-ct-vue';
|
||||
|
||||
export default defineConfig({
|
||||
ctViteConfig: {
|
||||
resolve: {
|
||||
alias: {
|
||||
vue: 'vue/dist/vue.esm-bundler.js',
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
</Callout>
|
||||
|
||||
</If>
|
||||
|
||||
## createTest
|
||||
|
||||
(⚠️ **Experimental**)
|
||||
|
||||
Instead of using Playwright's own `test` function, you can use Storybook's special `createTest` function to [extend Playwright's base fixture](https://playwright.dev/docs/test-fixtures#creating-a-fixture) and override the `mount` function to load, render, and play the story. This function is experimental and is subject to changes.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
<CodeSnippets
|
||||
paths={[
|
||||
'react/portable-stories-playwright-ct.ts.mdx',
|
||||
'vue/portable-stories-playwright-ct.ts.mdx',
|
||||
]}
|
||||
/>
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<Callout variant="warning">
|
||||
|
||||
Please note the [limitations of importing stories in Playwright CT](#importing-stories-in-playwright-ct).
|
||||
|
||||
</Callout>
|
||||
|
||||
### Type
|
||||
|
||||
```ts
|
||||
createTest(
|
||||
baseTest: PlaywrightFixture
|
||||
) => PlaywrightFixture
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
#### `baseTest`
|
||||
|
||||
(**Required**)
|
||||
|
||||
Type: `PlaywrightFixture`
|
||||
|
||||
The base test function to use, e.g. `test` from Playwright.
|
||||
|
||||
### Return
|
||||
|
||||
Type: `PlaywrightFixture`
|
||||
|
||||
A Storybook-specific test function with the custom `mount` mechanism.
|
||||
|
||||
## setProjectAnnotations
|
||||
|
||||
This API should be called once, before the tests run, in [`playwright/index.ts`](https://playwright.dev/docs/test-components#step-1-install-playwright-test-for-components-for-your-respective-framework). This will make sure that when `mount` is called, the project annotations are taken into account as well.
|
||||
|
||||
```ts
|
||||
// playwright/index.ts
|
||||
// Replace <your-renderer> with your renderer, e.g. react, vue3
|
||||
import { setProjectAnnotations } from '@storybook/<your-renderer>';
|
||||
import * as addonAnnotations from 'my-addon/preview';
|
||||
import * as previewAnnotations from './.storybook/preview';
|
||||
|
||||
setProjectAnnotations([previewAnnotations, addonAnnotations]);
|
||||
```
|
||||
|
||||
<Callout variant="warning">
|
||||
|
||||
Sometimes a story can require an addon's [decorator](../writing-stories/decorators.md) or [loader](../writing-stories/loaders.md) to render properly. For example, an addon can apply a decorator that wraps your story in the necessary router context. In this case, you must include that addon's `preview` export in the project annotations set. See `addonAnnotations` in the example above.
|
||||
|
||||
Note: If the addon doesn't automatically apply the decorator or loader itself, but instead exports them for you to apply manually in `.storybook/preview.js|ts` (e.g. using `withThemeFromJSXProvider` from [@storybook/addon-themes](https://github.com/storybookjs/storybook/blob/next/code/addons/themes/docs/api.md#withthemefromjsxprovider)), then you do not need to do anything else. They are already included in the `previewAnnotations` in the example above.
|
||||
|
||||
</Callout>
|
||||
|
||||
### Type
|
||||
|
||||
```ts
|
||||
(projectAnnotations: ProjectAnnotation | ProjectAnnotation[]) => void
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
#### `projectAnnotations`
|
||||
|
||||
(**Required**)
|
||||
|
||||
Type: `ProjectAnnotation | ProjectAnnotation[]`
|
||||
|
||||
A set of project [annotations](#annotations) (those defined in `.storybook/preview.js|ts`) or an array of sets of project annotations, which will be applied to all composed stories.
|
||||
|
||||
## Annotations
|
||||
|
||||
Annotations are the metadata applied to a story, like [args](../writing-stories/args.md), [decorators](../writing-stories/decorators.md), [loaders](../writing-stories/loaders.md), and [play functions](../writing-stories/play-function.md). They can be defined for a specific story, all stories for a component, or all stories in the project.
|
||||
|
||||
## Importing stories in Playwright CT
|
||||
|
||||
The code which you write in your Playwright test file is transformed and orchestrated by Playwright, where part of the code executes in Node, while other parts execute in the browser.
|
||||
|
||||
Because of this, you have to compose the stories _in a separate file than your own test file_:
|
||||
|
||||
```ts
|
||||
// Button.portable.ts
|
||||
// Replace <your-renderer> with your renderer, e.g. react, vue3
|
||||
import { composeStories } from '@storybook/<your-renderer>';
|
||||
|
||||
import * as stories from './Button.stories';
|
||||
|
||||
// This function will be executed in the browser
|
||||
// and compose all stories, exporting them in a single object
|
||||
export default composeStories(stories);
|
||||
```
|
||||
|
||||
You can then import the composed stories in your Playwright test file, as in the [example above](#createtest).
|
||||
|
||||
<Callout variant="info">
|
||||
|
||||
[Read more about Playwright's component testing](https://playwright.dev/docs/test-components#test-stories).
|
||||
|
||||
</Callout>
|
||||
|
||||
## Story pipeline
|
||||
|
||||
To preview your stories, Storybook runs a story pipeline, which includes applying project annotations, loading data, rendering the story, and playing interactions. This is a simplified version of the pipeline:
|
||||
|
||||
|
||||
|
||||
When you want to reuse a story in a different environment, however, it's crucial to understand that all these steps make a story. The portable stories API provides you with the mechanism to recreate that story pipeline in your external environment:
|
||||
|
||||
### 1. Apply project-level annotations
|
||||
|
||||
[Annotations](#annotations) come from the story itself, that story's component, and the project. The project-level annotatations are those defined in your `.storybook/preview.js` file and by addons you're using. In portable stories, these annotations are not applied automatically—you must apply them yourself.
|
||||
|
||||
👉 For this, you use the [`setProjectAnnotations`](#setprojectannotations) API.
|
||||
|
||||
### 2. Prepare, load, render, and play
|
||||
|
||||
The story pipeline includes preparing the story, [loading data](../writing-stories/loaders.md), rendering the story, and [playing interactions](../essentials/interactions.md#play-function-for-interactions). In portable stories within Playwright CT, the `mount` function takes care of these steps for you.
|
||||
|
||||
👉 For this, you use the [`createTest`](#createtest) API.
|
||||
|
||||
<Callout variant="info">
|
||||
|
||||
If your play function contains assertions (e.g. `expect` calls), your test will fail when those assertions fail.
|
||||
|
||||
</Callout>
|
||||
|
||||
## Overriding globals
|
||||
|
||||
If your stories behave differently based on [globals](../essentials/toolbars-and-globals.md#globals) (e.g. rendering text in English or Spanish), you can define those global values in portable stories by overriding project annotations when composing a story:
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
```tsx
|
||||
// Button.portable.ts
|
||||
import { test } from 'vitest';
|
||||
import { render } from '@testing-library/react';
|
||||
import { composeStory } from '@storybook/react';
|
||||
|
||||
import meta, { Primary } from './Button.stories';
|
||||
|
||||
export const PrimaryEnglish = composeStory(
|
||||
Primary,
|
||||
meta,
|
||||
{ globals: { locale: 'en' } } // 👈 Project annotations to override the locale
|
||||
);
|
||||
|
||||
export const PrimarySpanish =
|
||||
composeStory(Primary, meta, { globals: { locale: 'es' } });
|
||||
```
|
||||
|
||||
You can then use those composed stories in your Playwright test file using the [`createTest`](#createtest) function.
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<!-- End supported renderers -->
|
||||
|
||||
</If>
|
||||
298
docs/api/portable-stories-vitest.md
Normal file
298
docs/api/portable-stories-vitest.md
Normal file
@ -0,0 +1,298 @@
|
||||
---
|
||||
title: 'Portable stories in Vitest'
|
||||
---
|
||||
|
||||
export const SUPPORTED_RENDERERS = ['react', 'vue'];
|
||||
|
||||
<If notRenderer={SUPPORTED_RENDERERS}>
|
||||
|
||||
<Callout variant="info">
|
||||
|
||||
Portable stories in Vitest are currently only supported in [React](?renderer=react) and [Vue](?renderer=vue) projects.
|
||||
|
||||
</Callout>
|
||||
|
||||
<!-- End non-supported renderers -->
|
||||
|
||||
</If>
|
||||
|
||||
<If renderer={SUPPORTED_RENDERERS}>
|
||||
|
||||
Portable stories are Storybook [stories](../writing-stories/index.md) which can be used in external environments, such as [Vitest](https://vitest.dev).
|
||||
|
||||
Normally, Storybok composes a story and its [annotations](#annotations) automatically, as part of the [story pipeline](#story-pipeline). When using stories in Vitest tests, you must handle the story pipeline yourself, which is what the [`composeStories`](#composestories) and [`composeStory`](#composestory) functions enable.
|
||||
|
||||
<If renderer="react">
|
||||
|
||||
<Callout variant="warning">
|
||||
|
||||
**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 Vitest.
|
||||
|
||||
</Callout>
|
||||
|
||||
</If>
|
||||
|
||||
## composeStories
|
||||
|
||||
`composeStories` will process the component's stories you specify, compose each of them with the necessary [annotations](#annotations), and return an object containing the composed stories.
|
||||
|
||||
By default, the composed story will render the component with the [args](../writing-stories/args.md) that are defined in the story. You can also pass any props to the component in your test and those props will override the values passed in the story's args.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
<CodeSnippets
|
||||
paths={[
|
||||
'react/portable-stories-vitest-compose-stories.ts.mdx',
|
||||
'vue/portable-stories-vitest-compose-stories.ts.mdx',
|
||||
]}
|
||||
/>
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
### Type
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```ts
|
||||
(
|
||||
csfExports: CSF file exports,
|
||||
projectAnnotations?: ProjectAnnotations
|
||||
) => Record<string, ComposedStoryFn>
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
### Parameters
|
||||
|
||||
#### `csfExports`
|
||||
|
||||
(**Required**)
|
||||
|
||||
Type: CSF file exports
|
||||
|
||||
Specifies which component's stories you want to compose. Pass the **full set of exports** from the CSF file (not the default export!). E.g. `import * as stories from './Button.stories'`
|
||||
|
||||
#### `projectAnnotations`
|
||||
|
||||
Type: `ProjectAnnotation | ProjectAnnotation[]`
|
||||
|
||||
Specifies the project annotations to be applied to the composed stories.
|
||||
|
||||
This parameter is provided for convenience. You should likely use [`setProjectAnnotations`](#setprojectannotations) instead. Details about the `ProjectAnnotation` type can be found in that function's [`projectAnnotations`](#projectannotations-2) parameter.
|
||||
|
||||
This parameter can be used to [override](#overriding-globals) the project annotations applied via `setProjectAnnotations`.
|
||||
|
||||
### Return
|
||||
|
||||
Type: `Record<string, ComposedStoryFn>`
|
||||
|
||||
An object where the keys are the names of the stories and the values are the composed stories.
|
||||
|
||||
Additionally, the composed story will have the following properties:
|
||||
|
||||
| Property | Type | Description |
|
||||
| ---------- | ----------------------------------------- | --------------------------------------------------------------- |
|
||||
| storyName | `string` | The story's name |
|
||||
| args | `Record<string, any>` | The story's [args](../writing-stories/args.md) |
|
||||
| argTypes | `ArgType` | The story's [argTypes](./arg-types.md) |
|
||||
| id | `string` | The story's id |
|
||||
| parameters | `Record<string, any>` | The story's [parameters](./parameters.md) |
|
||||
| load | `() => Promise<void>` | Executes all the [loaders](#2-load-optional) for a given story |
|
||||
| play | `(context) => Promise<void> \| undefined` | Executes the [play function](#4-play-optional) of a given story |
|
||||
|
||||
## composeStory
|
||||
|
||||
You can use `composeStory` if you wish to compose a single story for a component.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
<CodeSnippets
|
||||
paths={[
|
||||
'react/portable-stories-vitest-compose-story.ts.mdx',
|
||||
'vue/portable-stories-vitest-compose-story.ts.mdx',
|
||||
]}
|
||||
/>
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
### Type
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```ts
|
||||
(
|
||||
story: Story export,
|
||||
componentAnnotations: Meta,
|
||||
projectAnnotations?: ProjectAnnotations,
|
||||
exportsName?: string
|
||||
) => ComposedStoryFn
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
### Parameters
|
||||
|
||||
#### `story`
|
||||
|
||||
(**Required**)
|
||||
|
||||
Type: `Story export`
|
||||
|
||||
Specifies which story you want to compose.
|
||||
|
||||
#### `componentAnnotations`
|
||||
|
||||
(**Required**)
|
||||
|
||||
Type: `Meta`
|
||||
|
||||
The default export from the stories file containing the [`story`](#story).
|
||||
|
||||
#### `projectAnnotations`
|
||||
|
||||
Type: `ProjectAnnotation | ProjectAnnotation[]`
|
||||
|
||||
Specifies the project annotations to be applied to the composed story.
|
||||
|
||||
This parameter is provided for convenience. You should likely use [`setProjectAnnotations`](#setprojectannotations) instead. Details about the `ProjectAnnotation` type can be found in that function's [`projectAnnotations`](#projectannotations-2) parameter.
|
||||
|
||||
This parameter can be used to [override](#overriding-globals) the project annotations applied via `setProjectAnnotations`.
|
||||
|
||||
#### `exportsName`
|
||||
|
||||
Type: `string`
|
||||
|
||||
You probably don't need this. Because `composeStory` accepts a single story, it does not have access to the name of that story's export in the file (like `composeStories` does). If you must ensure unique story names in your tests and you cannot use `composeStories`, you can pass the name of the story's export here.
|
||||
|
||||
### Return
|
||||
|
||||
Type: `ComposedStoryFn`
|
||||
|
||||
A single [composed story](#return).
|
||||
|
||||
## setProjectAnnotations
|
||||
|
||||
This API should be called once, before the tests run, typically in a [setup file](https://vitest.dev/config/#setupfiles). This will make sure that whenever `composeStories` or `composeStory` are called, the project annotations are taken into account as well.
|
||||
|
||||
```ts
|
||||
// setup-portable-stories.ts
|
||||
// Replace <your-renderer> with your renderer, e.g. react, vue3
|
||||
import { setProjectAnnotations } from '@storybook/<your-renderer>';
|
||||
import * as addonAnnotations from 'my-addon/preview';
|
||||
import * as previewAnnotations from './.storybook/preview';
|
||||
|
||||
setProjectAnnotations([previewAnnotations, addonAnnotations]);
|
||||
```
|
||||
|
||||
<Callout variant="warning">
|
||||
|
||||
Sometimes a story can require an addon's [decorator](../writing-stories/decorators.md) or [loader](../writing-stories/loaders.md) to render properly. For example, an addon can apply a decorator that wraps your story in the necessary router context. In this case, you must include that addon's `preview` export in the project annotations set. See `addonAnnotations` in the example above.
|
||||
|
||||
Note: If the addon doesn't automatically apply the decorator or loader itself, but instead exports them for you to apply manually in `.storybook/preview.js|ts` (e.g. using `withThemeFromJSXProvider` from [@storybook/addon-themes](https://github.com/storybookjs/storybook/blob/next/code/addons/themes/docs/api.md#withthemefromjsxprovider)), then you do not need to do anything else. They are already included in the `previewAnnotations` in the example above.
|
||||
|
||||
</Callout>
|
||||
|
||||
### Type
|
||||
|
||||
```ts
|
||||
(projectAnnotations: ProjectAnnotation | ProjectAnnotation[]) => void
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
#### `projectAnnotations`
|
||||
|
||||
(**Required**)
|
||||
|
||||
Type: `ProjectAnnotation | ProjectAnnotation[]`
|
||||
|
||||
A set of project [annotations](#annotations) (those defined in `.storybook/preview.js|ts`) or an array of sets of project annotations, which will be applied to all composed stories.
|
||||
|
||||
## Annotations
|
||||
|
||||
Annotations are the metadata applied to a story, like [args](../writing-stories/args.md), [decorators](../writing-stories/decorators.md), [loaders](../writing-stories/loaders.md), and [play functions](../writing-stories/play-function.md). They can be defined for a specific story, all stories for a component, or all stories in the project.
|
||||
|
||||
## Story pipeline
|
||||
|
||||
To preview your stories, Storybook runs a story pipeline, which includes applying project annotations, loading data, rendering the story, and playing interactions. This is a simplified version of the pipeline:
|
||||
|
||||
|
||||
|
||||
When you want to reuse a story in a different environment, however, it's crucial to understand that all these steps make a story. The portable stories API provides you with the mechanism to recreate that story pipeline in your external environment:
|
||||
|
||||
### 1. Apply project-level annotations
|
||||
|
||||
[Annotations](#annotations) come from the story itself, that story's component, and the project. The project-level annotatations are those defined in your `.storybook/preview.js` file and by addons you're using. In portable stories, these annotations are not applied automatically—you must apply them yourself.
|
||||
|
||||
👉 For this, you use the [`setProjectAnnotations`](#setprojectannotations) API.
|
||||
|
||||
### 2. Prepare
|
||||
|
||||
The story is prepared by running [`composeStories`](#composestories) or [`composeStory`](#composestory). You do not need to do anything for this step.
|
||||
|
||||
### 3. Load
|
||||
|
||||
**(optional)**
|
||||
|
||||
Stories can prepare data they need (e.g. setting up some mocks or fetching data) before rendering by defining [loaders](../writing-stories/loaders.md). In portable stories, the loaders are not applied automatically—you have to apply them yourself.
|
||||
|
||||
👉 For this, you use the [`composeStories`](#composestories) or [`composeStory`](#composestory) API. The composed story will return a `load` method to be called **before** it is rendered.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
<CodeSnippets
|
||||
paths={[
|
||||
'react/portable-stories-vitest-with-loaders.ts.mdx',
|
||||
'vue/portable-stories-vitest-with-loaders.ts.mdx',
|
||||
]}
|
||||
/>
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
### 4. Render
|
||||
|
||||
At this point, the story has been prepared and can be rendered. You pass it into the
|
||||
|
||||
The story has been prepared and can be rendered. To render, you pass it into the rendering mechanism of your choice (e.g. Testing Library render function, Vue test utils mount function, etc).
|
||||
|
||||
👉 For this, you use the [`composeStories`](#composestories) or [`composeStory`](#composestory) API. The composed Story is a renderable component that can be passed to your rendering mechanism.
|
||||
|
||||
### 5. Play
|
||||
|
||||
**(optional)**
|
||||
|
||||
Finally, stories can define a [play function](../essentials/interactions.md#play-function-for-interactions) to interact with the story and assert on details after it has rendered. In portable stories, the play function does not run automatically—you have to call it yourself.
|
||||
|
||||
👉 For this, you use the [`composeStories`](#composestories) or [`composeStory`](#composestory) API. The composed Story will return a `play` method to be called **after** it has rendered.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
<CodeSnippets
|
||||
paths={[
|
||||
'react/portable-stories-vitest-with-play-function.ts.mdx',
|
||||
'vue/portable-stories-vitest-with-play-function.ts.mdx',
|
||||
]}
|
||||
/>
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<Callout variant="info">
|
||||
|
||||
If your play function contains assertions (e.g. `expect` calls), your test will fail when those assertions fail.
|
||||
|
||||
</Callout>
|
||||
|
||||
## Overriding globals
|
||||
|
||||
If your stories behave differently based on [globals](../essentials/toolbars-and-globals.md#globals) (e.g. rendering text in English or Spanish), you can define those global values in portable stories by overriding project annotations when composing a story:
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
<CodeSnippets
|
||||
paths={[
|
||||
'react/portable-stories-vitest-override-globals.ts.mdx',
|
||||
'vue/portable-stories-vitest-override-globals.ts.mdx',
|
||||
]}
|
||||
/>
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<!-- End supported renderers -->
|
||||
|
||||
</If>
|
||||
BIN
docs/api/story-pipeline-playwright-ct.png
Normal file
BIN
docs/api/story-pipeline-playwright-ct.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 97 KiB |
BIN
docs/api/story-pipeline.png
Normal file
BIN
docs/api/story-pipeline.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 90 KiB |
@ -0,0 +1,27 @@
|
||||
```tsx
|
||||
// Button.test.tsx
|
||||
import { test, expect } from '@jest/globals';
|
||||
import { render, screen } from '@testing-library/react';
|
||||
// 👉 Using Next.js? Import from @storybook/nextjs instead
|
||||
import { composeStories } from '@storybook/react';
|
||||
|
||||
// Import all stories and the component annotations from the stories file
|
||||
import * as stories from './Button.stories';
|
||||
|
||||
// Every component that is returned maps 1:1 with the stories,
|
||||
// but they already contain all annotations from story, meta, and project levels
|
||||
const { Primary, Secondary } = composeStories(stories);
|
||||
|
||||
test('renders primary button with default args', () => {
|
||||
render(<Primary />);
|
||||
const buttonElement = screen.getByText('Text coming from args in stories file!');
|
||||
expect(buttonElement).not.toBeNull();
|
||||
});
|
||||
|
||||
test('renders primary button with overriden props', () => {
|
||||
// You can override props and they will get merged with values from the story's args
|
||||
render(<Primary>Hello world</Primary>);
|
||||
const buttonElement = screen.getByText(/Hello world/i);
|
||||
expect(buttonElement).not.toBeNull();
|
||||
});
|
||||
```
|
||||
@ -0,0 +1,20 @@
|
||||
```tsx
|
||||
// Button.test.tsx
|
||||
import { jest, test, expect } from '@jest/globals';
|
||||
import { render, screen } from '@testing-library/react';
|
||||
// 👉 Using Next.js? Import from @storybook/nextjs instead
|
||||
import { composeStory } from '@storybook/react';
|
||||
|
||||
import meta, { Primary } from './Button.stories';
|
||||
|
||||
test('onclick handler is called', () => {
|
||||
// Returns a story which already contains all annotations from story, meta and global levels
|
||||
const PrimaryStory = composeStory(Primary, meta);
|
||||
|
||||
const onClickSpy = jest.fn();
|
||||
render(<PrimaryStory onClick={onClickSpy} />);
|
||||
const buttonElement = screen.getByRole('button');
|
||||
buttonElement.click();
|
||||
expect(onClickSpy).toHaveBeenCalled();
|
||||
});
|
||||
```
|
||||
@ -0,0 +1,25 @@
|
||||
```tsx
|
||||
// Button.test.tsx
|
||||
import { test } from '@jest/globals';
|
||||
import { render } from '@testing-library/react';
|
||||
// 👉 Using Next.js? Import from @storybook/nextjs instead
|
||||
import { composeStory } from '@storybook/react';
|
||||
|
||||
import meta, { Primary } from './Button.stories';
|
||||
|
||||
test('renders in English', async () => {
|
||||
const PrimaryStory = composeStory(
|
||||
Primary,
|
||||
meta,
|
||||
{ globals: { locale: 'en' } }, // 👈 Project annotations to override the locale
|
||||
);
|
||||
|
||||
render(<PrimaryStory />);
|
||||
});
|
||||
|
||||
test('renders in Spanish', async () => {
|
||||
const PrimaryStory = composeStory(Primary, meta, { globals: { locale: 'es' } });
|
||||
|
||||
render(<PrimaryStory />);
|
||||
});
|
||||
```
|
||||
@ -0,0 +1,19 @@
|
||||
```tsx
|
||||
// Button.test.tsx
|
||||
import { test } from '@jest/globals';
|
||||
import { render } from '@testing-library/react';
|
||||
// 👉 Using Next.js? Import from @storybook/nextjs instead
|
||||
import { composeStory } from '@storybook/react';
|
||||
|
||||
import meta, { Primary } from './Button.stories';
|
||||
|
||||
test('applies the loaders and renders', async () => {
|
||||
const PrimaryStory = composeStory(Primary, meta);
|
||||
|
||||
// First, load the data for the story
|
||||
await PrimaryStory.load();
|
||||
|
||||
// Then, render the story
|
||||
render(<PrimaryStory />);
|
||||
});
|
||||
```
|
||||
@ -0,0 +1,19 @@
|
||||
```tsx
|
||||
// Button.test.tsx
|
||||
import { test } from '@jest/globals';
|
||||
import { render } from '@testing-library/react';
|
||||
// 👉 Using Next.js? Import from @storybook/nextjs instead
|
||||
import { composeStory } from '@storybook/react';
|
||||
|
||||
import meta, { Primary } from './Button.stories';
|
||||
|
||||
test('renders and executes the play function', async () => {
|
||||
const PrimaryStory = composeStory(Primary, meta);
|
||||
|
||||
// First, render the story
|
||||
render(<PrimaryStory />);
|
||||
|
||||
// Then, execute the play function
|
||||
await PrimaryStory.play();
|
||||
});
|
||||
```
|
||||
15
docs/snippets/react/portable-stories-playwright-ct.ts.mdx
Normal file
15
docs/snippets/react/portable-stories-playwright-ct.ts.mdx
Normal file
@ -0,0 +1,15 @@
|
||||
```tsx
|
||||
// Button.playwright.test.tsx
|
||||
import { createTest } from '@storybook/react/experimental-playwright';
|
||||
import { test as base } from '@playwright/experimental-ct-react';
|
||||
|
||||
import stories from './Button.portable';
|
||||
|
||||
const test = createTest(base);
|
||||
|
||||
test('renders primary button', async ({ mount }) => {
|
||||
// The mount function will execute all the necessary steps in the story,
|
||||
// such as loaders, render, and play function
|
||||
await mount(<stories.Primary />);
|
||||
});
|
||||
```
|
||||
@ -0,0 +1,26 @@
|
||||
```tsx
|
||||
// Button.test.tsx
|
||||
import { test, expect } from 'vitest';
|
||||
import { render, screen } from '@testing-library/react';
|
||||
import { composeStories } from '@storybook/react';
|
||||
|
||||
// Import all stories and the component annotations from the stories file
|
||||
import * as stories from './Button.stories';
|
||||
|
||||
// Every component that is returned maps 1:1 with the stories,
|
||||
// but they already contain all annotations from story, meta, and project levels
|
||||
const { Primary, Secondary } = composeStories(stories);
|
||||
|
||||
test('renders primary button with default args', () => {
|
||||
render(<Primary />);
|
||||
const buttonElement = screen.getByText('Text coming from args in stories file!');
|
||||
expect(buttonElement).not.toBeNull();
|
||||
});
|
||||
|
||||
test('renders primary button with overriden props', () => {
|
||||
// You can override props and they will get merged with values from the story's args
|
||||
render(<Primary>Hello world</Primary>);
|
||||
const buttonElement = screen.getByText(/Hello world/i);
|
||||
expect(buttonElement).not.toBeNull();
|
||||
});
|
||||
```
|
||||
@ -0,0 +1,19 @@
|
||||
```tsx
|
||||
// Button.test.tsx
|
||||
import { vi, test, expect } from 'vitest';
|
||||
import { render, screen } from '@testing-library/react';
|
||||
import { composeStory } from '@storybook/react';
|
||||
|
||||
import meta, { Primary } from './Button.stories';
|
||||
|
||||
test('onclick handler is called', () => {
|
||||
// Returns a story which already contains all annotations from story, meta and global levels
|
||||
const PrimaryStory = composeStory(Primary, meta);
|
||||
|
||||
const onClickSpy = vi.fn();
|
||||
render(<PrimaryStory onClick={onClickSpy} />);
|
||||
const buttonElement = screen.getByRole('button');
|
||||
buttonElement.click();
|
||||
expect(onClickSpy).toHaveBeenCalled();
|
||||
});
|
||||
```
|
||||
@ -0,0 +1,24 @@
|
||||
```tsx
|
||||
// Button.test.tsx
|
||||
import { test } from 'vitest';
|
||||
import { render } from '@testing-library/react';
|
||||
import { composeStory } from '@storybook/react';
|
||||
|
||||
import meta, { Primary } from './Button.stories';
|
||||
|
||||
test('renders in English', async () => {
|
||||
const PrimaryStory = composeStory(
|
||||
Primary,
|
||||
meta,
|
||||
{ globals: { locale: 'en' } }, // 👈 Project annotations to override the locale
|
||||
);
|
||||
|
||||
render(<PrimaryStory />);
|
||||
});
|
||||
|
||||
test('renders in Spanish', async () => {
|
||||
const PrimaryStory = composeStory(Primary, meta, { globals: { locale: 'es' } });
|
||||
|
||||
render(<PrimaryStory />);
|
||||
});
|
||||
```
|
||||
@ -0,0 +1,18 @@
|
||||
```tsx
|
||||
// Button.test.tsx
|
||||
import { test } from 'vitest';
|
||||
import { render } from '@testing-library/react';
|
||||
import { composeStory } from '@storybook/react';
|
||||
|
||||
import meta, { Primary } from './Button.stories';
|
||||
|
||||
test('applies the loaders and renders', async () => {
|
||||
const PrimaryStory = composeStory(Primary, meta);
|
||||
|
||||
// First, load the data for the story
|
||||
await PrimaryStory.load();
|
||||
|
||||
// Then, render the story
|
||||
render(<PrimaryStory />);
|
||||
});
|
||||
```
|
||||
@ -0,0 +1,18 @@
|
||||
```tsx
|
||||
// Button.test.tsx
|
||||
import { test } from 'vitest';
|
||||
import { render } from '@testing-library/react';
|
||||
import { composeStory } from '@storybook/react';
|
||||
|
||||
import meta, { Primary } from './Button.stories';
|
||||
|
||||
test('renders and executes the play function', async () => {
|
||||
const PrimaryStory = composeStory(Primary, meta);
|
||||
|
||||
// First, render the story
|
||||
render(<PrimaryStory />);
|
||||
|
||||
// Then, execute the play function
|
||||
await PrimaryStory.play();
|
||||
});
|
||||
```
|
||||
@ -0,0 +1,26 @@
|
||||
```ts
|
||||
// Button.test.ts
|
||||
import { test, expect } from '@jest/globals';
|
||||
import { render, screen } from '@testing-library/vue';
|
||||
import { composeStories } from '@storybook/vue3';
|
||||
|
||||
// Import all stories and the component annotations from the stories file
|
||||
import * as stories from './Button.stories';
|
||||
|
||||
// Every component that is returned maps 1:1 with the stories,
|
||||
// but they already contain all annotations from story, meta, and project levels
|
||||
const { Primary, Secondary } = composeStories(stories);
|
||||
|
||||
test('renders primary button with default args', () => {
|
||||
render(Primary);
|
||||
const buttonElement = screen.getByText('Text coming from args in stories file!');
|
||||
expect(buttonElement).not.toBeNull();
|
||||
});
|
||||
|
||||
test('renders primary button with overriden props', () => {
|
||||
// You can override props and they will get merged with values from the story's args
|
||||
render(Primary, { props: { label: 'Hello world' } });
|
||||
const buttonElement = screen.getByText(/Hello world/i);
|
||||
expect(buttonElement).not.toBeNull();
|
||||
});
|
||||
```
|
||||
19
docs/snippets/vue/portable-stories-jest-compose-story.ts.mdx
Normal file
19
docs/snippets/vue/portable-stories-jest-compose-story.ts.mdx
Normal file
@ -0,0 +1,19 @@
|
||||
```ts
|
||||
// Button.test.ts
|
||||
import { jest, test, expect } from '@jest/globals';
|
||||
import { render, screen } from '@testing-library/vue';
|
||||
import { composeStory } from '@storybook/vue3';
|
||||
|
||||
import meta, { Primary } from './Button.stories';
|
||||
|
||||
test('onclick handler is called', () => {
|
||||
// Returns a story which already contains all annotations from story, meta and global levels
|
||||
const PrimaryStory = composeStory(Primary, meta);
|
||||
|
||||
const onClickSpy = jest.fn();
|
||||
render(Primary, { props: { onClick: onClickSpy } });
|
||||
const buttonElement = screen.getByRole('button');
|
||||
buttonElement.click();
|
||||
expect(onClickSpy).toHaveBeenCalled();
|
||||
});
|
||||
```
|
||||
@ -0,0 +1,24 @@
|
||||
```ts
|
||||
// Button.test.ts
|
||||
import { test } from '@jest/globals';
|
||||
import { render } from '@testing-library/vue';
|
||||
import { composeStory } from '@storybook/vue3';
|
||||
|
||||
import meta, { Primary } from './Button.stories';
|
||||
|
||||
test('renders in English', async () => {
|
||||
const PrimaryStory = composeStory(
|
||||
Primary,
|
||||
meta,
|
||||
{ globals: { locale: 'en' } }, // 👈 Project annotations to override the locale
|
||||
);
|
||||
|
||||
render(PrimaryStory);
|
||||
});
|
||||
|
||||
test('renders in Spanish', async () => {
|
||||
const PrimaryStory = composeStory(Primary, meta, { globals: { locale: 'es' } });
|
||||
|
||||
render(PrimaryStory);
|
||||
});
|
||||
```
|
||||
18
docs/snippets/vue/portable-stories-jest-with-loaders.ts.mdx
Normal file
18
docs/snippets/vue/portable-stories-jest-with-loaders.ts.mdx
Normal file
@ -0,0 +1,18 @@
|
||||
```ts
|
||||
// Button.test.ts
|
||||
import { test } from '@jest/globals';
|
||||
import { render } from '@testing-library/vue';
|
||||
import { composeStory } from '@storybook/vue3';
|
||||
|
||||
import meta, { Primary } from './Button.stories';
|
||||
|
||||
test('applies the loaders and renders', async () => {
|
||||
const PrimaryStory = composeStory(Primary, meta);
|
||||
|
||||
// First, load the data for the story
|
||||
await PrimaryStory.load();
|
||||
|
||||
// Then, render the story
|
||||
render(PrimaryStory);
|
||||
});
|
||||
```
|
||||
@ -0,0 +1,18 @@
|
||||
```ts
|
||||
// Button.test.ts
|
||||
import { test } from '@jest/globals';
|
||||
import { render } from '@testing-library/vue';
|
||||
import { composeStory } from '@storybook/vue3';
|
||||
|
||||
import meta, { Primary } from './Button.stories';
|
||||
|
||||
test('renders and executes the play function', async () => {
|
||||
const PrimaryStory = composeStory(Primary, meta);
|
||||
|
||||
// First, render the story
|
||||
render(PrimaryStory);
|
||||
|
||||
// Then, execute the play function
|
||||
await PrimaryStory.play();
|
||||
});
|
||||
```
|
||||
15
docs/snippets/vue/portable-stories-playwright-ct.ts.mdx
Normal file
15
docs/snippets/vue/portable-stories-playwright-ct.ts.mdx
Normal file
@ -0,0 +1,15 @@
|
||||
```ts
|
||||
// Button.playwright.test.ts
|
||||
import { createTest } from '@storybook/vue3/experimental-playwright';
|
||||
import { test as base } from '@playwright/experimental-ct-vue';
|
||||
|
||||
import stories from './Button.portable';
|
||||
|
||||
const test = createTest(base);
|
||||
|
||||
test('renders primary button', async ({ mount }) => {
|
||||
// The mount function will execute all the necessary steps in the story,
|
||||
// such as loaders, render, and play function
|
||||
await mount(stories.Primary);
|
||||
});
|
||||
```
|
||||
@ -0,0 +1,26 @@
|
||||
```ts
|
||||
// Button.test.ts
|
||||
import { test, expect } from 'vitest';
|
||||
import { render, screen } from '@testing-library/vue';
|
||||
import { composeStories } from '@storybook/vue3';
|
||||
|
||||
// Import all stories and the component annotations from the stories file
|
||||
import * as stories from './Button.stories';
|
||||
|
||||
// Every component that is returned maps 1:1 with the stories,
|
||||
// but they already contain all annotations from story, meta, and project levels
|
||||
const { Primary, Secondary } = composeStories(stories);
|
||||
|
||||
test('renders primary button with default args', () => {
|
||||
render(Primary);
|
||||
const buttonElement = screen.getByText('Text coming from args in stories file!');
|
||||
expect(buttonElement).not.toBeNull();
|
||||
});
|
||||
|
||||
test('renders primary button with overriden props', () => {
|
||||
// You can override props and they will get merged with values from the story's args
|
||||
render(Primary, { props: { label: 'Hello world' } });
|
||||
const buttonElement = screen.getByText(/Hello world/i);
|
||||
expect(buttonElement).not.toBeNull();
|
||||
});
|
||||
```
|
||||
@ -0,0 +1,19 @@
|
||||
```ts
|
||||
// Button.test.ts
|
||||
import { vi, test, expect } from 'vitest';
|
||||
import { render, screen } from '@testing-library/vue';
|
||||
import { composeStory } from '@storybook/vue3';
|
||||
|
||||
import meta, { Primary } from './Button.stories';
|
||||
|
||||
test('onclick handler is called', () => {
|
||||
// Returns a story which already contains all annotations from story, meta and global levels
|
||||
const PrimaryStory = composeStory(Primary, meta);
|
||||
|
||||
const onClickSpy = vi.fn();
|
||||
render(Primary, { props: { onClick: onClickSpy } });
|
||||
const buttonElement = screen.getByRole('button');
|
||||
buttonElement.click();
|
||||
expect(onClickSpy).toHaveBeenCalled();
|
||||
});
|
||||
```
|
||||
@ -0,0 +1,24 @@
|
||||
```ts
|
||||
// Button.test.ts
|
||||
import { test } from 'vitest';
|
||||
import { render } from '@testing-library/vue';
|
||||
import { composeStory } from '@storybook/vue3';
|
||||
|
||||
import meta, { Primary } from './Button.stories';
|
||||
|
||||
test('renders in English', async () => {
|
||||
const PrimaryStory = composeStory(
|
||||
Primary,
|
||||
meta,
|
||||
{ globals: { locale: 'en' } }, // 👈 Project annotations to override the locale
|
||||
);
|
||||
|
||||
render(PrimaryStory);
|
||||
});
|
||||
|
||||
test('renders in Spanish', async () => {
|
||||
const PrimaryStory = composeStory(Primary, meta, { globals: { locale: 'es' } });
|
||||
|
||||
render(PrimaryStory);
|
||||
});
|
||||
```
|
||||
@ -0,0 +1,18 @@
|
||||
```ts
|
||||
// Button.test.ts
|
||||
import { test } from 'vitest';
|
||||
import { render } from '@testing-library/vue';
|
||||
import { composeStory } from '@storybook/vue3';
|
||||
|
||||
import meta, { Primary } from './Button.stories';
|
||||
|
||||
test('applies the loaders and renders', async () => {
|
||||
const PrimaryStory = composeStory(Primary, meta);
|
||||
|
||||
// First, load the data for the story
|
||||
await PrimaryStory.load();
|
||||
|
||||
// Then, render the story
|
||||
render(PrimaryStory);
|
||||
});
|
||||
```
|
||||
@ -0,0 +1,18 @@
|
||||
```ts
|
||||
// Button.test.ts
|
||||
import { test } from 'vitest';
|
||||
import { render } from '@testing-library/vue';
|
||||
import { composeStory } from '@storybook/vue3';
|
||||
|
||||
import meta, { Primary } from './Button.stories';
|
||||
|
||||
test('renders and executes the play function', async () => {
|
||||
const PrimaryStory = composeStory(Primary, meta);
|
||||
|
||||
// First, render the story
|
||||
render(PrimaryStory);
|
||||
|
||||
// Then, execute the play function
|
||||
await PrimaryStory.play();
|
||||
});
|
||||
```
|
||||
23
docs/toc.js
23
docs/toc.js
@ -691,6 +691,29 @@ module.exports = {
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'Portable stories',
|
||||
pathSegment: '',
|
||||
type: 'menu',
|
||||
children: [
|
||||
{
|
||||
pathSegment: 'portable-stories-jest',
|
||||
title: 'Jest',
|
||||
type: 'link',
|
||||
},
|
||||
{
|
||||
pathSegment: 'portable-stories-playwright',
|
||||
title: 'Playwright',
|
||||
type: 'link',
|
||||
},
|
||||
{
|
||||
pathSegment: 'portable-stories-vitest',
|
||||
title: 'Vitest',
|
||||
type: 'link',
|
||||
},
|
||||
],
|
||||
},
|
||||
|
||||
{
|
||||
pathSegment: 'new-frameworks',
|
||||
title: 'Frameworks',
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user