Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

storybook-solidjs-vite

storybookjs28.6kMIT1.0.0-beta.7TypeScript support: included

Storybook for SolidJS and Vite: Develop SolidJS in isolation with Hot Reloading.

storybook

readme

Storybook SolidJS

This is a framework to allow using Storybook with SolidJS.

Features

  • <input checked="" disabled="" type="checkbox"> JS and TS integration with Storybook CLI
  • <input checked="" disabled="" type="checkbox"> Fine grained updates in storybook controls
  • <input checked="" disabled="" type="checkbox"> Compatible with @storybook/addon-interactions
  • <input checked="" disabled="" type="checkbox"> Compatible with @storybook/test
  • <input checked="" disabled="" type="checkbox"> Code snippets generation in docs view mode
  • <input disabled="" type="checkbox"> Automatic story actions
  • <input disabled="" type="checkbox"> Full props table with description in docs view mode
  • <input disabled="" type="checkbox"> SolidJS docs in the official Storybook website

Notes about pending features ⏳

  • Automatic story actions: Feature under research. For now actions can be implemented manually by using the @storybook/addon-actions API.

  • Full props table with description in docs view mode: Feature under research. For now, props are rendered partially in the docs view table with a blank description.

  • SolidJS docs in the official Storybook website: It's still pending to add documentation about Storybook stories definitions using SolidJS.

Setup

In an existing Solid project, run npx storybook@latest init (Storybook 8+ is required)

See the Storybook Docs for the best documentation on getting started with Storybook.

License

MIT License