jplhomer/blade-library

此包已被弃用且不再维护。没有建议的替代包。

在浏览器中开发您的 Blade 组件。


README

Latest Version on Packagist GitHub Tests Action Status Total Downloads

Blade Library screenshot

安装

您可以通过 composer 安装此包

composer require jplhomer/blade-library

然后,使用以下命令发布资产、配置和视图

php artisan blade-library:install

接下来,您可能希望将您的应用程序 CSS 样式表包含在组件示例中,或自定义 Blade Library 中使用的徽标。

编辑发布到您的 resources/views/vendor/library/partials 目录中的 head.blade.phplogo.blade.php 文件。

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

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

使用

使用 @story Blade 部分来定义组件中的故事

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

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

然后,打开您的应用程序,在 /library 路由中查看它们。

命名故事

您可以通过将它们传递给 @story 指令来为故事分配名称

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

故事书

除了在组件中直接定义故事外,您还可以创建一个专门的 book,为您的组件提供文档和额外的故事示例。

首先,在您的 resources/views/books 目录中创建一个与您的组件名称匹配的文件

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

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

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

当您提供一个故事 book 时,它将与在您的组件中直接定义的任何故事合并。

测试

composer test

变更日志

请参阅 CHANGELOG 了解最近更改的详细信息。

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全性

如果您发现任何安全相关的问题,请通过电子邮件 jplhomer@gmail.com 而不是使用问题跟踪器。

鸣谢

许可

MIT 许可证 (MIT)。请参阅 许可文件 了解更多信息。