The minimal UI component playground
npm install astrobookThe minimal UI component playground
Astrobook is a UI component playground that supports multiple frameworks including React, Vue, Preact, Svelte, Solid, Lit, and Astro. It offers a unified environment to develop, test, and showcase components.
- An example of using multiple UI rendering frameworks (React, Preact, Vue, Svelte, Solid, Lit, Astro) with Astrobook.
Online demo: astrobook.pages.dev
[![Open in StackBlitz][stackblitz_badge]][example_playground]
- An example of using custom tags with Astrobook.
[![Open in StackBlitz][stackblitz_badge]][example_custom_head]
- An example that shows how to add Astrobook into an existing Astro project.
[![Open in StackBlitz][stackblitz_badge]][example_mixed]
- An example of using TailwindCSS with Astrobook.
[![Open in StackBlitz][stackblitz_badge]][example_tailwindcss]
- An example of using UnoCSS with Astrobook.
[![Open in StackBlitz][stackblitz_badge]][example_unocss]
- An example of using PandaCSS with Astrobook.
[![Open in StackBlitz][stackblitz_badge]][example_pandacss]
> [!NOTE]
> Astrobook supports various frameworks. We use React as an example here. Check the Astro docs for other integrations.
1. Install the packages
``bash`
npm install astro @astrojs/react astrobook
2. Create astro.config.mjs and add the astrobook integration
`js
// astro.config.mjs
import { defineConfig } from 'astro/config'
import react from '@astrojs/react'
import astrobook from 'astrobook'
// https://astro.build/config
export default defineConfig({
integrations: [react(), astrobook()],
})
`
3. Add scripts to your package.json
`json`
"scripts": {
"dev": "astro dev",
"build": "astro build"
}
4. Write stories. Astrobook scans all .stories.{ts,tsx,js,jsx,mts,mjs} files. It's compatible with a limited subset of Storybook's Component Story Format v3. In particular, args and decorators properties are supported. Every component story file consists of a required default export and one or more named exports.
`ts
// src/components/Button.stories.ts
import { Button, type ButtonProps } from './Button.tsx'
export default {
component: Button,
}
export const PrimaryButton = {
args: { variant: 'primary' } satisfies ButtonProps,
}
export const SecondaryButton = {
args: { variant: 'secondary' } satisfies ButtonProps,
}
`
5. Run npm run dev and open http://localhost:4321 to see your stories.
Decorators are objects that have a property for the component and the props that will be passed to it on render. This component must have a _slot_ for children to be rendered. Currently, decorators only support styling changes and are not able to change a component's context or any client-side behaviors. Any decorators are rendered into HTML by Astro and sent to the client.
You can use decorators to wrap a component with a custom style.
For example, this is a React decorator that adds a green border to a component and an Astro decorator that adds a red border to a component.
`tsx
// ReactGreenBorderDecorator.tsx
import type { ComponentChildren } from 'react'
export function GreenBorderDecorator({
width = 2,
children,
}: {
width?: number
children?: ComponentChildren
}) {
return
}}>{children}astro
`In your stories, you can use the decorators like this:
tsx
// Button.stories.tsx
import { Button, type ButtonProps } from './Button.tsx'
import { GreenBorderDecorator } from './ReactGreenBorderDecorator.tsx'
import RedBorderDecorator from './AstroRedBorderDecorator.astro'export default {
component: Button,
}
export const PrimaryButton = {
args: { variant: 'primary' } satisfies ButtonProps,
decorators: [
{ component: GreenBorderDecorator, props: { width: 10 } },
{ component: RedBorderDecorator },
],
}
`This will render the button, wrapped in a red border, which is then wrapped in a green border.
$3
Stories named the same as their module will get automatically hoisted up to replace their parent component in the UI, if they're the only story exported from their module.
This helps avoid redundant nesting in the sidebar (e.g.
):`ts
// Button.stories.tsimport { Button as ButtonComponent } from './Button.tsx'
export default {
component: ButtonComponent,
}
// Single named export.
// Export name matches module name (Button.stories.ts)
export const Button = {}
`This story will not get nested to
in the UI, but simply Button.Options
$3
You can use the
directory option to specify the directory to scan for stories. The default directory is current working directory.`js
// astro.config.mjs
import { defineConfig } from 'astro/config'
import astrobook from 'astrobook'export default defineConfig({
integrations: [
astrobook({
directory: 'src/components',
}),
/ ...other integrations /
],
})
`$3
You can run Astrobook as a standalone app. You can also add it to your existing Astro project. In the latter case, you can use the
option to specify the subpath of Astrobook.`js
// astro.config.mjs
import { defineConfig } from 'astro/config'
import astrobook from 'astrobook'export default defineConfig({
integrations: [
astrobook({
subpath: '/playground',
}),
],
})
`In the example above, Astrobook will be available at
.Notice that the
subpath option is relative to your Astro project's base path. For example, if you configure both Astro's base and astrobook's subpath, like so:`js
// astro.config.mjs
import { defineConfig } from 'astro/config'
import astrobook from 'astrobook'export default defineConfig({
base: '/docs',
integrations: [
astrobook({
subpath: '/playground',
}),
],
})
`Your Astro project will be available at
and Astrobook will be available at http://localhost:4321/docs/playground.$3
You can customize the styles by using the
css option to specify the CSS files to be imported into your Astrobook site.`js
// astro.config.mjs
import { defineConfig } from 'astro/config'
import astrobook from 'astrobook'export default defineConfig({
integrations: [
astrobook({
css: [
// Relative path to your custom CSS file
'./src/styles/custom.css',
],
}),
],
})
`$3
You can further customize your Astrobook project by providing a custom
options. It's a path to an Astro component that includes custom tags to the of your Astrobook site. It should only include elements permitted inside , like , js
// astro.config.mjs
import { defineConfig } from 'astro/config'
import astrobook from 'astrobook'export default defineConfig({
integrations: [
astrobook({
// Relative path to your custom head component
head: './src/components/CustomHead.astro',
}),
],
})
`$3
You can set the title for your website.
js
// astro.config.mjs
import { defineConfig } from 'astro/config'
import astrobook from 'astrobook'export default defineConfig({
integrations: [
astrobook({
title: 'My Components Playground',
}),
],
})
`Advanced
$3
You can enable Astrobook only on development by using the
to conditionally include the integration. This is useful when you
want to include Astrobook in your existing Astro project but don't want to build
it in production.`js
// astro.config.mjs
import { defineConfig } from 'astro/config'
import astrobook from 'astrobook'// https://astro.build/config
export default defineConfig({
integrations: [
// On development, Astrobook is available at http://localhost:4321/astrobook.
// On production, Astrobook is not included.
process.env.NODE_ENV === 'development'
? astrobook({ subpath: '/astrobook' })
: null,
],
})
`$3
If you're running Astrobook in an iframe, you can toggle the theme via a message.
js
const theme = 'light' // or "dark"
iframe.contentWindow.postMessage({ type: 'astrobook:set-theme', theme }, '*')
``- ProseKit
MIT
[stackblitz_badge]: https://developer.stackblitz.com/img/open_in_stackblitz.svg
[example_playground]: https://stackblitz.com/github/ocavue/astrobook/tree/master/examples/playground
[example_unocss]: https://stackblitz.com/github/ocavue/astrobook/tree/master/examples/unocss
[example_pandacss]: https://stackblitz.com/github/ocavue/astrobook/tree/master/examples/pandacss
[example_tailwindcss]: https://stackblitz.com/github/ocavue/astrobook/tree/master/examples/tailwindcss
[example_custom_head]: https://stackblitz.com/github/ocavue/astrobook/tree/master/examples/custom-head
[example_mixed]: https://stackblitz.com/github/ocavue/astrobook/tree/master/examples/mixed