Download the PHP package tonning/bladebook without Composer
On this page you can find all versions of the php package tonning/bladebook. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tonning/bladebook
More information about tonning/bladebook
Files in tonning/bladebook
Package bladebook
Short Description Storybook for Blade components
License MIT
Homepage https://github.com/tonning/bladebook
Informations about the package bladebook
WORK IN PROGRESS
Not ready for production just yet.
Storybook for Blade components
To come.
Installation
You can install the package via composer:
You need to publish the assets to your applications public/vendor
directory:
You are free to also publish the config file:
Discover Bladebook components
Creating Bladebook components
After you've created your normal Blade components you need to write some simple wrappers around them in order for them to be visible in the Bladebook UI. Let's say you've already created a simple Blade card component.
app/Views/Components/Layouts/Card.php
resources/views/components.layouts.card.blade.php
Register books
To register a book, you need to provide three (3) pieces of information;
- The name of the book
- The Blade component namespace that your components use
- And the namespace where you Bladebook components live (usually
App\Http\Bladebook
)
This is usually done register
method in your service provider i.e. AppServiceProvider
:
Styles and Scripts
Normally you application has it's own set of styles and scripts that are needed to render your components correctly. You can register the paths to these so Bladebook is able to display your components as intended.
Auth
You can lockdown access to Bladebook's UI by defining a gate in one of your service provider's boot
method. AuthServiceProvider
is a good place to put it.
Bladebook's UI is always available in your local environment.
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Kristoffer Tonning
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of bladebook with dependencies
graham-campbell/markdown Version ^14.0
haydenpierce/class-finder Version ^0.4.3
illuminate/contracts Version ^8.37 || ^9.0
livewire/livewire Version ^2.4
symfony/var-exporter Version ^5.2 || ^6.2