mirror of
https://github.com/storybookjs/storybook.git
synced 2025-04-05 16:11:33 +08:00
Minor adjustments
This commit is contained in:
jonniebigodes
parent
d88c49b974
commit
0217bf9837
@ -1,47 +1,4 @@
|
||||
# Storybook for Preact <!-- omit in toc -->
|
||||
# Storybook for Preact & Vite
|
||||
|
||||
## Requirements
|
||||
|
||||
- [Preact](https://preactjs.com/) >= 10.x
|
||||
- [Storybook](https://storybook.js.org/) >= 7.x
|
||||
|
||||
## Getting Started
|
||||
|
||||
### In a project without Storybook
|
||||
|
||||
Follow the prompts after running this command in your Preact project's root directory:
|
||||
|
||||
```bash
|
||||
npx storybook@latest init
|
||||
```
|
||||
|
||||
[More on getting started with Storybook](https://storybook.js.org/docs/get-started/install?renderer=preact)
|
||||
|
||||
### 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
|
||||
```
|
||||
|
||||
#### Manual migration
|
||||
|
||||
Install the framework:
|
||||
|
||||
```bash
|
||||
yarn add --dev @storybook/preact-vite
|
||||
```
|
||||
|
||||
Update your `main.js` to change the framework property:
|
||||
|
||||
```js
|
||||
// .storybook/main.js
|
||||
export default {
|
||||
// ...
|
||||
framework: {
|
||||
name: '@storybook/preact-vite', // <- Change this
|
||||
options: {},
|
||||
},
|
||||
};
|
||||
```
|
||||
See [documentation](https://storybook.js.org/docs/get-started/frameworks/preact-vite?renderer=preact) for installation instructions, usage examples, APIs, and more.
|
||||
`;
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
```js filename=".storybook/main.js" renderer="react" language="js"
|
||||
```js filename=".storybook/main.js" renderer="preact" language="js"
|
||||
export default {
|
||||
// ...
|
||||
// framework: '@storybook/preact-webpack5', 👈 Remove this
|
||||
@ -6,7 +6,7 @@ export default {
|
||||
};
|
||||
```
|
||||
|
||||
```ts filename=".storybook/main.ts" renderer="react" language="ts"
|
||||
```ts filename=".storybook/main.ts" renderer="preact" language="ts"
|
||||
import { StorybookConfig } from '@storybook/preact-vite';
|
||||
|
||||
const config: StorybookConfig = {
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
```shell renderer="react" language="js" packageManager="npm"
|
||||
```shell renderer="preact" language="js" packageManager="npm"
|
||||
npm install --save-dev @storybook/preact-vite
|
||||
```
|
||||
|
||||
```shell renderer="react" language="js" packageManager="pnpm"
|
||||
```shell renderer="preact" language="js" packageManager="pnpm"
|
||||
pnpm add --save-dev @storybook/preact-vite
|
||||
```
|
||||
|
||||
```shell renderer="react" language="js" packageManager="yarn"
|
||||
```shell renderer="preact" language="js" packageManager="yarn"
|
||||
yarn add --dev @storybook/preact-vite
|
||||
```
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Storybook for Preact & Vite
|
||||
sidebar:
|
||||
order: 13
|
||||
order: 3
|
||||
title: Preact & Vite
|
||||
---
|
||||
|
||||
@ -11,7 +11,7 @@ Storybook for Preact & Vite is a [framework](../../contribute/framework.mdx) tha
|
||||
* 🪄 Zero config
|
||||
* 💫 and more!
|
||||
|
||||
<If notRenderer="Preact">
|
||||
<If notRenderer="preact">
|
||||
<Callout variant="info">
|
||||
Storybook for Preact & Vite is only supported in [Preact](?renderer=preact) projects.
|
||||
</Callout>
|
||||
@ -30,7 +30,7 @@ Storybook for Preact & Vite is a [framework](../../contribute/framework.mdx) tha
|
||||
|
||||
### In a project without Storybook
|
||||
|
||||
Follow the prompts after running this command in your React project's root directory:
|
||||
Follow the prompts after running this command in your Preact project's root directory:
|
||||
|
||||
{/* prettier-ignore-start */}
|
||||
|
||||
@ -72,14 +72,6 @@ Storybook for Preact & Vite is a [framework](../../contribute/framework.mdx) tha
|
||||
|
||||
{/* prettier-ignore-end */}
|
||||
|
||||
## Run the Setup Wizard
|
||||
|
||||
If all goes well, you should see a setup wizard that will help you get started with Storybook introducing you to the main concepts and features, including how the UI is organized, how to write your first story, and how to test your components' response to various inputs utilizing [controls](../../essentials/controls.mdx).
|
||||
|
||||
|
||||
|
||||
If you skipped the wizard, you can always run it again by adding the `?path=/onboarding` query parameter to the URL of your Storybook instance, provided that the example stories are still available.
|
||||
|
||||
## API
|
||||
|
||||
### Options
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Storybook for React Native Web
|
||||
sidebar:
|
||||
order: 5
|
||||
order: 6
|
||||
title: React Native Web
|
||||
---
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Storybook for React & Vite
|
||||
sidebar:
|
||||
order: 3
|
||||
order: 4
|
||||
title: React & Vite
|
||||
---
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Storybook for React & Webpack
|
||||
sidebar:
|
||||
order: 4
|
||||
order: 5
|
||||
title: React & Webpack
|
||||
---
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Storybook for Svelte & Vite
|
||||
sidebar:
|
||||
order: 7
|
||||
order: 8
|
||||
title: Svelte & Vite
|
||||
---
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Storybook for Svelte & Webpack
|
||||
sidebar:
|
||||
order: 8
|
||||
order: 9
|
||||
title: Svelte & Webpack
|
||||
---
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Storybook for SvelteKit
|
||||
sidebar:
|
||||
order: 6
|
||||
order: 7
|
||||
title: SvelteKit
|
||||
---
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Storybook for Vue & Vite
|
||||
sidebar:
|
||||
order: 9
|
||||
order: 10
|
||||
title: Vue & Vite
|
||||
---
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Storybook for Vue & Webpack
|
||||
sidebar:
|
||||
order: 10
|
||||
order: 11
|
||||
title: Vue & Webpack
|
||||
---
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Storybook for Web components & Vite
|
||||
sidebar:
|
||||
order: 11
|
||||
order: 12
|
||||
title: Web components & Vite
|
||||
---
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Storybook for Web components & Webpack
|
||||
sidebar:
|
||||
order: 12
|
||||
order: 13
|
||||
title: Web components & Webpack
|
||||
---
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user