jplhomer/blade-library

This package is abandoned and no longer maintained. No replacement package was suggested.

Develop your Blade components in-browser.

v0.0.2 2020-07-21 13:32 UTC

Requires

• php: ^7.4
• illuminate/filesystem: ^7.18
• livewire/livewire: ^1.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.16
• orchestra/testbench: ^5.0
• phpunit/phpunit: ^9.0
• psalm/plugin-laravel: ^1.2
• vimeo/psalm: ^3.11

MIT

• Josh Larson

• jplhomer
• blade-library

README

Installation

You can install the package via composer:

composer require jplhomer/blade-library

Then, publish assets, configuration, and views with:

php artisan blade-library:install

Next, you'll want to include your app's CSS stylesheet's in your component examples, or customize the logo used in Blade Library.

Edit the head.blade.php and logo.blade.php files published to your resources/views/vendor/library/partials directory.

<!-- resources/views/vendor/library/partials/head.blade.php -->

<link rel="stylesheet" href="{{ mix('css/app.css') }}" />

Usage

Use the @story Blade partial to define stories in your components:

<!-- views/components/button.blade.php -->
<button>{{ $slot }}</button>

@story
<x-button>Example</x-button>
@endstory

Then, open up your app and view them at the /library route.

Named stories

You can assign stories names by passing them to the @story directive:

@story('My Story')
<x-button>Example</x-button>
@endstory

Story Books

In addition to defining stories inline in your components, you can also create a dedicated book to provide documentation and additional story examples for your components.

First, create a file matching the name of your component within your resources/views/books directory:

<!-- resources/views/books/button.blade.php -->

<p>Buttons are the foundation of our app:</p>

@story
<x-button>Click Me</x-button>
@endstory

When you provide a book of stories, it will be merged with any stories defined inline in your components.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Josh Larson
• All Contributors

License

The MIT License (MIT). Please see License File for more information.