mirror of
https://github.com/storybookjs/storybook.git
synced 2025-04-06 06:31:27 +08:00
Merge pull request #26329 from storybookjs/framework-doc-sveltekit
Docs: Add `sveltekit` framework doc
This commit is contained in:
Kyle Gach
parent
a77dfbeeb7
commit
c5cf84f6a1
@ -1,190 +1,6 @@
|
||||
# Storybook for SvelteKit <!-- omit in toc -->
|
||||
# Storybook for SvelteKit
|
||||
|
||||
Our goal is to help you use the tools you love together with Storybook. That’s why Storybook has zero-config support for SvelteKit with the `@storybook/sveltekit` package.
|
||||
|
||||
Check out our [Frameworks API](https://storybook.js.org/blog/framework-api/) announcement for what this all means for you and our continued efforts to make Storybook a seamless integration for any project.
|
||||
|
||||
## Table of Contents <!-- omit in toc -->
|
||||
|
||||
- [Supported features](#supported-features)
|
||||
- [Requirements](#requirements)
|
||||
- [Getting Started](#getting-started)
|
||||
- [In a project without Storybook](#in-a-project-without-storybook)
|
||||
- [In a project with Storybook](#in-a-project-with-storybook)
|
||||
- [Automatic migration](#automatic-migration)
|
||||
- [Manual migration](#manual-migration)
|
||||
- [How to mock](#how-to-mock)
|
||||
- [Mocking links](#mocking-links)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [Error: `ERR! SyntaxError: Identifier '__esbuild_register_import_meta_url__' has already been declared` when starting Storybook](#error-err-syntaxerror-identifier-__esbuild_register_import_meta_url__-has-already-been-declared-when-starting-storybook)
|
||||
- [Acknowledgements](#acknowledgements)
|
||||
|
||||
## Supported features
|
||||
|
||||
All Svelte language features are supported out of the box, as Storybook uses the Svelte compiler underneath.
|
||||
However SvelteKit has some [Kit-specific modules](https://kit.svelte.dev/docs/modules) that currently aren't supported. It's on our roadmap to support most of them soon:
|
||||
|
||||
| **Module** | **Status** | **Note** |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [`$app/environment`](https://kit.svelte.dev/docs/modules#$app-environment) | ✅ Supported | `version` is always empty in Storybook. |
|
||||
| [`$app/forms`](https://kit.svelte.dev/docs/modules#$app-forms) | ✅ Supported | See [How to mock](#how-to-mock) |
|
||||
| [`$app/navigation`](https://kit.svelte.dev/docs/modules#$app-navigation) | ✅ Supported | See [How to mock](#how-to-mock) |
|
||||
| [`$app/paths`](https://kit.svelte.dev/docs/modules#$app-paths) | ✅ Supported | Requires SvelteKit 1.4.0 or newer |
|
||||
| [`$app/stores`](https://kit.svelte.dev/docs/modules#$app-stores) | ✅ Supported | See [How to mock](#how-to-mock) |
|
||||
| [`$env/dynamic/private`](https://kit.svelte.dev/docs/modules#$env-dynamic-private) | ⛔ Not supported | They are meant to only be available server-side, and Storybook renders all components on the client. |
|
||||
| [`$env/dynamic/public`](https://kit.svelte.dev/docs/modules#$env-dynamic-public) | 🚧 Partially supported | Only supported in development mode. Storybook is built as a static app with no server-side API so cannot dynamically serve content. |
|
||||
| [`$env/static/private`](https://kit.svelte.dev/docs/modules#$env-static-private) | ⛔ Not supported | They are meant to only be available server-side, and Storybook renders all components on the client. |
|
||||
| [`$env/static/public`](https://kit.svelte.dev/docs/modules#$env-static-public) | ✅ Supported | |
|
||||
| [`$lib`](https://kit.svelte.dev/docs/modules#$lib) | ✅ Supported | |
|
||||
| [`$service-worker`](https://kit.svelte.dev/docs/modules#$service-worker) | ⛔ Not supported | They are only meant to be used in service workers |
|
||||
| [`@sveltejs/kit/*`](https://kit.svelte.dev/docs/modules#sveltejs-kit) | ✅ Supported | |
|
||||
|
||||
This is just the beginning. We're close to adding basic support for many of the SvelteKit features. Longer term we're planning on making it an even better experience to [build](https://storybook.js.org/docs/svelte/writing-stories), [test](https://storybook.js.org/docs/svelte/writing-tests) and [document](https://storybook.js.org/docs/svelte/writing-docs) all the SvelteKit goodies like [pages](https://kit.svelte.dev/docs/routing), [forms](https://kit.svelte.dev/docs/form-actions) and [layouts](https://kit.svelte.dev/docs/routing#layout) in Storybook, while still integrating with all the addons and workflows you know and love.
|
||||
|
||||
## Requirements
|
||||
|
||||
- [SvelteKit](https://kit.svelte.dev/) >= 1.0.0 (not including beta versions)
|
||||
- [Storybook](https://storybook.js.org/) >= 7.x
|
||||
|
||||
## Getting Started
|
||||
|
||||
### In a project without Storybook
|
||||
|
||||
Run the following command in your SvelteKit project's root directory, and follow the prompts:
|
||||
|
||||
```bash
|
||||
npx storybook@latest init
|
||||
```
|
||||
|
||||
[More on getting started with Storybook](https://storybook.js.org/docs/svelte/get-started/install)
|
||||
|
||||
### In a project with Storybook
|
||||
|
||||
This framework is designed to work with Storybook 7. If you’re not already using v7, upgrade with this command:
|
||||
|
||||
```bash
|
||||
npx storybook@latest upgrade
|
||||
```
|
||||
|
||||
#### Automatic migration
|
||||
|
||||
When running the `upgrade` command above you should get a prompt asking you to migrate to `@storybook/sveltekit`, which should handle everything for you. In some cases it can't migrate for you, eg. if your existing Storybook setup is based on Webpack. In such cases, refer to the manual migration below.
|
||||
|
||||
Storybook 7.0 automatically loads your Vite config, and by extension your Svelte config. If you had a `svelteOptions` property in `.storybook/main.js` the automigration will have removed it, as it is no longer supported.
|
||||
|
||||
#### Manual migration
|
||||
|
||||
Install the framework:
|
||||
|
||||
```bash
|
||||
yarn add -D @storybook/sveltekit
|
||||
```
|
||||
|
||||
Update your `main.js` to change the framework property:
|
||||
|
||||
```js
|
||||
// .storybook/main.js
|
||||
export default {
|
||||
...
|
||||
framework: '@storybook/sveltekit',
|
||||
};
|
||||
```
|
||||
|
||||
Storybook 7.0 automatically loads your Vite config, and by extension your Svelte config. If you have a `svelteOptions` property in `.storybook/main.js` you need to remove that. See [Troubleshooting](#error-about-__esbuild_register_import_meta_url__-when-starting-storybook) below.
|
||||
|
||||
Remove any redundant dependencies, if you have them:
|
||||
|
||||
```bash
|
||||
yarn remove @storybook/svelte-vite
|
||||
yarn remove @storybook/svelte-webpack5
|
||||
yarn remove storybook-builder-vite
|
||||
yarn remove @storybook/builder-vite
|
||||
```
|
||||
|
||||
## How to mock
|
||||
|
||||
To mock a SvelteKit import you can set it on `parameters.sveltekit_experimental`:
|
||||
|
||||
```ts
|
||||
export const MyStory = {
|
||||
parameters: {
|
||||
sveltekit_experimental: {
|
||||
stores: {
|
||||
page: {
|
||||
data: {
|
||||
test: 'passed',
|
||||
},
|
||||
},
|
||||
navigating: {
|
||||
route: {
|
||||
id: '/storybook',
|
||||
},
|
||||
},
|
||||
updated: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
You can add the name of the module you want to mock to `parameters.sveltekit_experimental` (in the example above we are mocking the `stores` module which correspond to `$app/stores`) and then pass the following kind of objects:
|
||||
|
||||
| Module | Path in parameters | Kind of objects |
|
||||
| ------------------------------------------------- | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `import { page } from "$app/stores"` | `parameters.sveltekit_experimental.stores.page` | A Partial of the page store |
|
||||
| `import { navigating } from "$app/stores"` | `parameters.sveltekit_experimental.stores.navigating` | A Partial of the navigating store |
|
||||
| `import { updated } from "$app/stores"` | `parameters.sveltekit_experimental.stores.updated` | A boolean representing the value of updated (you can also access `check()` which will be a noop) |
|
||||
| `import { goto } from "$app/navigation"` | `parameters.sveltekit_experimental.navigation.goto` | A callback that will be called whenever goto is called, in no function is provided an action will be logged to the Actions panel |
|
||||
| `import { pushState } from "$app/navigation"` | `parameters.sveltekit_experimental.navigation.pushState` | A callback that will be called whenever pushState is called, in no function is provided an action will be logged to the Actions panel |
|
||||
| `import { replaceState } from "$app/navigation"` | `parameters.sveltekit_experimental.navigation.replaceState` | A callback that will be called whenever replaceState is called, in no function is provided an action will be logged to the Actions panel |
|
||||
| `import { invalidate } from "$app/navigation"` | `parameters.sveltekit_experimental.navigation.invalidate` | A callback that will be called whenever invalidate is called, in no function is provided an action will be logged to the Actions panel |
|
||||
| `import { invalidateAll } from "$app/navigation"` | `parameters.sveltekit_experimental.navigation.invalidateAll` | A callback that will be called whenever invalidateAll is called, in no function is provided an action will be logged to the Actions panel |
|
||||
| `import { afterNavigate } from "$app/navigation"` | `parameters.sveltekit_experimental.navigation.afterNavigate` | An object that will be passed to the afterNavigate function (which will be invoked onMount) called |
|
||||
| `import { enhance } from "$app/forms"` | `parameters.sveltekit_experimental.forms.enhance` | A callback that will called when a form with `use:enhance` is submitted |
|
||||
|
||||
All the other functions are still exported as `noop` from the mocked modules so that your application will still work.
|
||||
|
||||
### Mocking links
|
||||
|
||||
The default link-handling behavior (ie. clicking an `<a />` tag with an `href` attribute) is to log an action to the Actions panel.
|
||||
|
||||
You can override this by setting an object on `parameter.sveltekit_experimental.hrefs`, where the keys are strings representing an href and the values are objects typed as `{ callback: (href, event) => void, asRegex?: boolean }`.
|
||||
|
||||
If you have an `<a />` tag inside your code with the `href` attribute that matches one or more of the links defined (treated as regex based on the `asRegex` property) the corresponding `callback` will be called.
|
||||
|
||||
Example:
|
||||
|
||||
```ts
|
||||
export const MyStory = {
|
||||
parameters: {
|
||||
sveltekit_experimental: {
|
||||
hrefs: {
|
||||
'/basic-href': (to, event) => {
|
||||
console.log(to, event);
|
||||
},
|
||||
'/root.*': {
|
||||
callback: (to, event) => {
|
||||
console.log(to, event);
|
||||
},
|
||||
asRegex: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Error: `ERR! SyntaxError: Identifier '__esbuild_register_import_meta_url__' has already been declared` when starting Storybook
|
||||
|
||||
> When starting Storybook after upgrading to v7.0, it breaks with the following error:
|
||||
>
|
||||
> ```
|
||||
> ERR! SyntaxError: Identifier '__esbuild_register_import_meta_url__' has already been declared
|
||||
> ```
|
||||
|
||||
You'll get this error when manually upgrading from 6.5 to 7.0. You need to remove the `svelteOptions` property in `.storybook/main.js`, as that is not supported by Storybook 7.0 + SvelteKit. The property is also not necessary anymore because the Vite and Svelte configurations are loaded automatically in Storybook 7.0.
|
||||
See [documentation](https://storybook.js.org/docs/8.0/get-started/sveltekit?renderer=svelte) for installation instructions, usage examples, APIs, and more.
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
|
||||
342
docs/get-started/sveltekit.md
Normal file
342
docs/get-started/sveltekit.md
Normal file
@ -0,0 +1,342 @@
|
||||
---
|
||||
title: Storybook for SvelteKit
|
||||
---
|
||||
|
||||
export const SUPPORTED_RENDERER = 'svelte';
|
||||
|
||||
Storybook for SvelteKit is a [framework](../contribute/framework.md) that makes it easy to develop and test UI components in isolation for [SvelteKit](https://kit.svelte.dev/) applications. It includes:
|
||||
|
||||
- 🪄 Zero config
|
||||
- 🧩 Easily mock many Kit modules
|
||||
- 🔗 Automatic link handling
|
||||
- 💫 and more!
|
||||
|
||||
<If notRenderer={SUPPORTED_RENDERER}>
|
||||
|
||||
<Callout variant="info">
|
||||
|
||||
Storybook for SvelteKit is only supported in [Svelte](?renderer=svelte) projects.
|
||||
|
||||
</Callout>
|
||||
|
||||
<!-- End non-supported renderers -->
|
||||
|
||||
</If>
|
||||
|
||||
<If renderer={SUPPORTED_RENDERER}>
|
||||
|
||||
## Requirements
|
||||
|
||||
- SvelteKit ≥ 1.0
|
||||
- Storybook ≥ 8.0
|
||||
|
||||
## Getting started
|
||||
|
||||
### In a project without Storybook
|
||||
|
||||
Follow the prompts after running this command in your Sveltekit project's root directory:
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
<CodeSnippets
|
||||
paths={[
|
||||
'common/init-command.npx.js.mdx',
|
||||
'common/init-command.yarn.js.mdx',
|
||||
'common/init-command.pnpm.js.mdx',
|
||||
]}
|
||||
/>
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
[More on getting started with Storybook.](./install.md)
|
||||
|
||||
### In a project with Storybook
|
||||
|
||||
This framework is designed to work with Storybook 7+. If you’re not already using v7, upgrade with this command:
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
<CodeSnippets
|
||||
paths={[
|
||||
'common/storybook-upgrade.npm.js.mdx',
|
||||
'common/storybook-upgrade.pnpm.js.mdx',
|
||||
'common/storybook-upgrade.yarn.js.mdx'
|
||||
]}
|
||||
/>
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
#### Automatic migration
|
||||
|
||||
When running the `upgrade` command above, you should get a prompt asking you to migrate to `@storybook/sveltekit`, which should handle everything for you. In case that auto-migration does not work for your project, refer to the manual migration below.
|
||||
|
||||
#### Manual migration
|
||||
|
||||
First, install the framework:
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
<CodeSnippets
|
||||
paths={[
|
||||
'svelte/sveltekit-install.npm.js.mdx',
|
||||
'svelte/sveltekit-install.pnpm.js.mdx',
|
||||
'svelte/sveltekit-install.yarn.js.mdx'
|
||||
]}
|
||||
/>
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
Then, update your `.storybook/main.js|ts` to change the framework property:
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
<CodeSnippets
|
||||
paths={[
|
||||
'svelte/sveltekit-add-framework.js.mdx',
|
||||
'svelte/sveltekit-add-framework.ts.mdx'
|
||||
]}
|
||||
/>
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
Finally, these packages are now either obsolete or part of `@storybook/sveltekit`, so you no longer need to depend on them directly. You can remove them (`npm uninstall`, `yarn remove`, `pnpm remove`) from your project:
|
||||
|
||||
- `@storybook/svelte-vite`
|
||||
- `@storybook/svelte-webpack5`
|
||||
- `storybook-builder-vite`
|
||||
- `@storybook/builder-vite`
|
||||
|
||||
## Supported features
|
||||
|
||||
All Svelte language features are supported out of the box, as the Storybook framework uses the Svelte compiler directly.
|
||||
However, SvelteKit has some [Kit-specific modules](https://kit.svelte.dev/docs/modules) that aren't supported. Here's a breakdown of what will and will not work within Storybook:
|
||||
|
||||
| Module | Status | Note |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [`$app/environment`](https://kit.svelte.dev/docs/modules#$app-environment) | ✅ Supported | `version` is always empty in Storybook. |
|
||||
| [`$app/forms`](https://kit.svelte.dev/docs/modules#$app-forms) | ⚠️ **Experimental** | See [How to mock](#how-to-mock). |
|
||||
| [`$app/navigation`](https://kit.svelte.dev/docs/modules#$app-navigation) | ⚠️ **Experimental** | See [How to mock](#how-to-mock). |
|
||||
| [`$app/paths`](https://kit.svelte.dev/docs/modules#$app-paths) | ✅ Supported | Requires SvelteKit 1.4.0 or newer. |
|
||||
| [`$app/stores`](https://kit.svelte.dev/docs/modules#$app-stores) | ⚠️ **Experimental** | See [How to mock](#how-to-mock). |
|
||||
| [`$env/dynamic/public`](https://kit.svelte.dev/docs/modules#$env-dynamic-public) | 🚧 Partially supported | Only supported in development mode. Storybook is built as a static app with no server-side API, so it cannot dynamically serve content. |
|
||||
| [`$env/static/public`](https://kit.svelte.dev/docs/modules#$env-static-public) | ✅ Supported | |
|
||||
| [`$lib`](https://kit.svelte.dev/docs/modules#$lib) | ✅ Supported | |
|
||||
| [`@sveltejs/kit/*`](https://kit.svelte.dev/docs/modules#sveltejs-kit) | ✅ Supported | |
|
||||
| [`$env/dynamic/private`](https://kit.svelte.dev/docs/modules#$env-dynamic-private) | ⛔ Not supported | This is a server-side feature, and Storybook renders all components on the client. |
|
||||
| [`$env/static/private`](https://kit.svelte.dev/docs/modules#$env-static-private) | ⛔ Not supported | This is a server-side feature, and Storybook renders all components on the client. |
|
||||
| [`$service-worker`](https://kit.svelte.dev/docs/modules#$service-worker) | ⛔ Not supported | This is a service worker feature, which does not apply to Storybook. |
|
||||
|
||||
## How to mock
|
||||
|
||||
To mock a SvelteKit import you can define it within `parameters.sveltekit_experimental`:
|
||||
|
||||
```ts
|
||||
// MyComponent.stories.svelte
|
||||
export const MyStory = {
|
||||
parameters: {
|
||||
sveltekit_experimental: {
|
||||
stores: {
|
||||
page: {
|
||||
data: {
|
||||
test: 'passed',
|
||||
},
|
||||
},
|
||||
navigating: {
|
||||
route: {
|
||||
id: '/storybook',
|
||||
},
|
||||
},
|
||||
updated: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
The [available parameters](#parameters) are documented in the API section, below.
|
||||
|
||||
### Mocking links
|
||||
|
||||
The default link-handling behavior (e.g. when clicking an `<a href="..." />` element) is to log an action to the [Actions panel](../essentials/actions.md).
|
||||
|
||||
You can override this by assigning an object to `parameters.sveltekit_experimental.hrefs`, where the keys are strings representing an href and the values define your mock. For example:
|
||||
|
||||
```ts
|
||||
// MyComponent.stories.svelte
|
||||
export const MyStory = {
|
||||
parameters: {
|
||||
sveltekit_experimental: {
|
||||
hrefs: {
|
||||
'/basic-href': (to, event) => {
|
||||
console.log(to, event);
|
||||
},
|
||||
'/root.*': {
|
||||
callback: (to, event) => {
|
||||
console.log(to, event);
|
||||
},
|
||||
asRegex: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
See the [API reference](#hrefs) for more information.
|
||||
|
||||
## Writing native Svelte stories
|
||||
|
||||
Storybook provides a Svelte addon maintained by the community, enabling you to write stories for your Svelte components using the template syntax. You'll need to take some additional steps to enable this feature.
|
||||
|
||||
Run the following command to install the addon.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
<CodeSnippets
|
||||
paths={[
|
||||
'svelte/svelte-csf-addon-install.yarn.js.mdx',
|
||||
'svelte/svelte-csf-addon-install.npm.js.mdx',
|
||||
'svelte/svelte-csf-addon-install.pnpm.js.mdx',
|
||||
]}
|
||||
/>
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<Callout variant="info">
|
||||
|
||||
The community actively maintains the Svelte CSF addon but still lacks some features currently available in the official Storybook Svelte framework support. For more information, see [the addon's documentation](https://github.com/storybookjs/addon-svelte-csf).
|
||||
|
||||
</Callout>
|
||||
|
||||
## API
|
||||
|
||||
### Parameters
|
||||
|
||||
This framework contributes the following [parameters](../writing-stories/parameters.md) to Storybook, under the `sveltekit_experimental` namespace:
|
||||
|
||||
#### `forms`
|
||||
|
||||
Type: `{ enhance: () => void }`
|
||||
|
||||
Provides mocks for the [`$app/forms`](https://kit.svelte.dev/docs/modules#$app-forms) module.
|
||||
|
||||
##### `forms.enhance`
|
||||
|
||||
Type: `() => void`
|
||||
|
||||
A callback that will be called when a form with [`use:enhance`](https://kit.svelte.dev/docs/form-actions#progressive-enhancement-use-enhance) is submitted.
|
||||
|
||||
#### `hrefs`
|
||||
|
||||
Type: `Record<[path: string], (to: string, event: MouseEvent) => void | { callback: (to: string, event: MouseEvent) => void, asRegex?: boolean }>`
|
||||
|
||||
If you have an `<a />` tag inside your code with the `href` attribute that matches one or more of the links defined (treated as regex based if the `asRegex` property is `true`) the corresponding `callback` will be called. If no matching `hrefs` are defined, an action will be logged to the [Actions panel](../essentials/actions.md). See [Mocking links](#mocking-links) for an example.
|
||||
|
||||
#### `navigation`
|
||||
|
||||
Type: See [SvelteKit docs](https://kit.svelte.dev/docs/modules#$app-navigation)
|
||||
|
||||
Provides mocks for the [`$app/navigation`](https://kit.svelte.dev/docs/modules#$app-navigation) module.
|
||||
|
||||
##### `navigation.goto`
|
||||
|
||||
Type: See [SvelteKit docs](https://kit.svelte.dev/docs/modules#$app-navigation-goto)
|
||||
|
||||
A callback that will be called whenever [`goto`](https://kit.svelte.dev/docs/modules#$app-navigation-goto) is called. If no function is provided, an action will be logged to the [Actions panel](../essentials/actions.md).
|
||||
|
||||
##### `navigation.pushState`
|
||||
|
||||
Type: See [SvelteKit docs](https://kit.svelte.dev/docs/modules#$app-navigation-pushstate)
|
||||
|
||||
A callback that will be called whenever [`pushState`](https://kit.svelte.dev/docs/modules#$app-navigation-pushstate) is called. If no function is provided, an action will be logged to the [Actions panel](../essentials/actions.md).
|
||||
|
||||
##### `navigation.replaceState`
|
||||
|
||||
Type: See [SvelteKit docs](https://kit.svelte.dev/docs/modules#$app-navigation-replacestate)
|
||||
|
||||
A callback that will be called whenever [`replaceState`](https://kit.svelte.dev/docs/modules#$app-navigation-replacestate) is called. If no function is provided, an action will be logged to the [Actions panel](../essentials/actions.md).
|
||||
|
||||
##### `navigation.invalidate`
|
||||
|
||||
Type: See [SvelteKit docs](https://kit.svelte.dev/docs/modules#$app-navigation-invalidate)
|
||||
|
||||
A callback that will be called whenever [`invalidate`](https://kit.svelte.dev/docs/modules#$app-navigation-invalidate) is called. If no function is provided, an action will be logged to the [Actions panel](../essentials/actions.md).
|
||||
|
||||
##### `navigation.invalidateAll`
|
||||
|
||||
Type: See [SvelteKit docs](https://kit.svelte.dev/docs/modules#$app-navigation-invalidateall)
|
||||
|
||||
A callback that will be called whenever [`invalidateAll`](https://kit.svelte.dev/docs/modules#$app-navigation-invalidateall) is called. If no function is provided, an action will be logged to the [Actions panel](../essentials/actions.md).
|
||||
|
||||
##### `navigation.afterNavigate`
|
||||
|
||||
Type: See [SvelteKit docs](https://kit.svelte.dev/docs/modules#$app-navigation-afternavigate)
|
||||
|
||||
An object that will be passed to the [`afterNavigate`](https://kit.svelte.dev/docs/modules#$app-navigation-afternavigate) function, which will be invoked when the `onMount` event fires.
|
||||
|
||||
#### `stores`
|
||||
|
||||
Type: See [SvelteKit docs](https://kit.svelte.dev/docs/modules#$app-stores)
|
||||
|
||||
Provides mocks for the [`$app/stores`](https://kit.svelte.dev/docs/modules#$app-stores) module.
|
||||
|
||||
##### `stores.navigating`
|
||||
|
||||
Type: See [SvelteKit docs](https://kit.svelte.dev/docs/modules#$app-stores-navigating)
|
||||
|
||||
A partial version of the [`navigating`](https://kit.svelte.dev/docs/modules#$app-stores-navigating) store.
|
||||
|
||||
##### `stores.page`
|
||||
|
||||
Type: See [SvelteKit docs](https://kit.svelte.dev/docs/modules#$app-stores-page)
|
||||
|
||||
A partial version of the [`page`](https://kit.svelte.dev/docs/modules#$app-stores-page) store.
|
||||
|
||||
##### `stores.updated`
|
||||
|
||||
Type: boolean
|
||||
|
||||
A boolean representing the value of [`updated`](https://kit.svelte.dev/docs/modules#$app-stores-updated) (you can also access `updated.check()` which will be a no-op).
|
||||
|
||||
### Options
|
||||
|
||||
You can pass an options object for additional configuration if needed:
|
||||
|
||||
```js
|
||||
// .storybook/main.js
|
||||
import * as path from 'path';
|
||||
|
||||
export default {
|
||||
// ...
|
||||
framework: {
|
||||
name: '@storybook/sveltekit',
|
||||
options: {
|
||||
// ...
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
The available options are:
|
||||
|
||||
#### `builder`
|
||||
|
||||
Type: `Record<string, any>`
|
||||
|
||||
Configure options for the [framework's builder](../api/main-config-framework.md#optionsbuilder). For Sveltekit, available options can be found in the [Vite builder docs](../builders/vite.md).
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Error when starting Storybook
|
||||
|
||||
When starting Storybook after upgrading to v7.0, it may quit with the following error:
|
||||
|
||||
```sh
|
||||
ERR! SyntaxError: Identifier '__esbuild_register_import_meta_url__' has already been declared
|
||||
```
|
||||
|
||||
This can occur when manually upgrading from 6.5 to 7.0. To resolve it, you'll need to remove the `svelteOptions` property in `.storybook/main.js`, as that is not supported (and no longer necessary) in Storybook 7+ with SvelteKit.
|
||||
|
||||
<!-- End supported renderers -->
|
||||
|
||||
</If>
|
||||
8
docs/snippets/svelte/sveltekit-add-framework.js.mdx
Normal file
8
docs/snippets/svelte/sveltekit-add-framework.js.mdx
Normal file
@ -0,0 +1,8 @@
|
||||
```js
|
||||
// .storybook/main.js
|
||||
export default {
|
||||
// ...
|
||||
framework: '@storybook/sveltekit', // 👈 Add this
|
||||
// svelteOptions: { ... }, 👈 Remove this
|
||||
};
|
||||
```
|
||||
12
docs/snippets/svelte/sveltekit-add-framework.ts.mdx
Normal file
12
docs/snippets/svelte/sveltekit-add-framework.ts.mdx
Normal file
@ -0,0 +1,12 @@
|
||||
```ts
|
||||
// .storybook/main.ts
|
||||
import { StorybookConfig } from '@storybook/nextjs';
|
||||
|
||||
const config: StorybookConfig = {
|
||||
// ...
|
||||
framework: '@storybook/sveltekit', // 👈 Add this
|
||||
// svelteOptions: { ... }, 👈 Remove this
|
||||
};
|
||||
|
||||
export default config;
|
||||
```
|
||||
3
docs/snippets/svelte/sveltekit-install.npm.js.mdx
Normal file
3
docs/snippets/svelte/sveltekit-install.npm.js.mdx
Normal file
@ -0,0 +1,3 @@
|
||||
```shell
|
||||
npm install --save-dev @storybook/sveltekit
|
||||
```
|
||||
3
docs/snippets/svelte/sveltekit-install.pnpm.js.mdx
Normal file
3
docs/snippets/svelte/sveltekit-install.pnpm.js.mdx
Normal file
@ -0,0 +1,3 @@
|
||||
```shell
|
||||
pnpm install --save-dev @storybook/sveltekit
|
||||
```
|
||||
3
docs/snippets/svelte/sveltekit-install.yarn.js.mdx
Normal file
3
docs/snippets/svelte/sveltekit-install.yarn.js.mdx
Normal file
@ -0,0 +1,3 @@
|
||||
```shell
|
||||
yarn add --dev @storybook/sveltekit
|
||||
```
|
||||
@ -43,6 +43,11 @@ module.exports = {
|
||||
title: 'React & Webpack',
|
||||
type: 'link',
|
||||
},
|
||||
{
|
||||
pathSegment: 'sveltekit',
|
||||
title: 'SvelteKit',
|
||||
type: 'link',
|
||||
},
|
||||
{
|
||||
pathSegment: 'svelte-vite',
|
||||
title: 'Svelte & Vite',
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user