sensiolabs / storybook-bundle
Bundle to use Storybook with Symfony UX packages.
Installs: 6 646
Dependents: 0
Suggesters: 0
Security: 0
Stars: 43
Watchers: 7
Forks: 5
Open Issues: 5
Language:TypeScript
Requires
- php: >=8.1
- symfony/console: ^6.4|^7.0
- symfony/filesystem: ^6.4|^7.0
- symfony/twig-bundle: ^6.4|^7.0
Requires (Dev)
- phpstan/phpstan: ^1.10
- symfony/asset-mapper: ^6.4|^7.0
- symfony/browser-kit: ^6.4|^7.0
- symfony/css-selector: ^6.4|^7.0
- symfony/framework-bundle: ^6.4|^7.0
- symfony/phpunit-bridge: ^6.4|^7.0
- symfony/stimulus-bundle: ^2.16
- symfony/ux-live-component: ^2.16
- symfony/ux-twig-component: 2.16
- symfonycasts/sass-bundle: ^0.5.1
- symfonycasts/tailwind-bundle: ^0.5.0
Conflicts
This package is auto-updated.
Last update: 2024-12-10 08:29:44 UTC
README
This bundle provides a basic integration for Storybook into a Symfony application using Twig Components.
DISCLAIMER:
This bundle is under active development. Some features may not work as expected and the current documentation may be incomplete.
Table of Content
- Installation
- Getting Started
- Configuration
- Storybook Features
- Stories
- Addons
- Args Processors
- Component Mock
- Static Build
Installation
To install the bundle into your project run:
composer require sensiolabs/storybook-bundle
Initialize Storybook in your project:
bin/console storybook:init
This will create basic configuration files and add required dependencies to your package.json.
Install new dependencies with:
npm install
Ensure your Symfony server is running on the same address defined in your main.ts configuration file. Then run the Storybook dev server with:
npm run storybook
License
MIT License (MIT): see LICENSE.