Blade UI Kit 项目教程

1. 项目目录结构及介绍

Blade UI Kit 是一个用于 Laravel Blade 视图的渲染组件集合，适用于 TALL 技术栈。以下是项目的目录结构及其介绍：

blade-ui-kit/
├── src/
│   ├── Components/
│   │   ├── Alert.php
│   │   ├── Button.php
│   │   └── ...
│   ├── Contracts/
│   │   ├── Component.php
│   │   └── ...
│   ├── Facades/
│   │   ├── BladeUI.php
│   │   └── ...
│   ├── Providers/
│   │   ├── BladeUIKitServiceProvider.php
│   │   └── ...
│   └── ...
├── resources/
│   ├── views/
│   │   ├── components/
│   │   │   ├── alert.blade.php
│   │   │   ├── button.blade.php
│   │   │   └── ...
│   └── ...
├── config/
│   ├── blade-ui-kit.php
│   └── ...
├── tests/
│   ├── Feature/
│   │   ├── ComponentTest.php
│   │   └── ...
│   └── ...
├── composer.json
├── README.md
└── ...

目录结构说明：

• src/: 包含项目的核心代码，包括组件、接口、门面和服务提供者等。
  • Components/: 存放各个 UI 组件的 PHP 类文件。
  • Contracts/: 定义组件的接口。
  • Facades/: 提供组件的门面类。
  • Providers/: 包含服务提供者，用于注册组件和服务。
• resources/: 存放视图文件和其他资源文件。
  • views/components/: 存放 Blade 组件的视图文件。
• config/: 存放项目的配置文件。
• tests/: 包含项目的测试文件。
• composer.json: 项目的 Composer 依赖配置文件。
• README.md: 项目的说明文档。

2. 项目启动文件介绍

Blade UI Kit 的启动文件主要位于 src/Providers/BladeUIKitServiceProvider.php。该文件负责注册组件和服务，并将其绑定到 Laravel 的服务容器中。

namespace BladeUIKit\Providers;

use Illuminate\Support\ServiceProvider;
use BladeUIKit\Components\Alert;
use BladeUIKit\Components\Button;

class BladeUIKitServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $this->loadViewsFrom(__DIR__.'/../resources/views', 'blade-ui-kit');

        $this->publishes([
            __DIR__.'/../resources/views' => resource_path('views/vendor/blade-ui-kit'),
        ], 'views');

        $this->publishes([
            __DIR__.'/../config/blade-ui-kit.php' => config_path('blade-ui-kit.php'),
        ], 'config');

        $this->loadBladeComponents();
    }

    protected function loadBladeComponents()
    {
        $this->callAfterResolving(BladeCompiler::class, function (BladeCompiler $blade) {
            $blade->component(Alert::class, 'alert');
            $blade->component(Button::class, 'button');
            // 其他组件...
        });
    }
}

启动文件说明：

• boot(): 加载视图文件、发布配置文件和视图文件到项目中。
• loadBladeComponents(): 注册 Blade 组件，使其可以在视图中使用。

3. 项目配置文件介绍

Blade UI Kit 的配置文件位于 config/blade-ui-kit.php。该文件包含了组件的默认配置选项。

return [
    'components' => [
        'alert' => [
            'type' => 'info',
            'dismissible' => true,
        ],
        'button' => [
            'type' => 'primary',
            'size' => 'md',
        ],
        // 其他组件配置...
    ],
];

配置文件说明：

• components: 定义各个组件的默认配置选项。
  • alert: 定义 alert 组件的默认类型和是否可关闭。
  • button: 定义 button 组件的默认类型和大小。

通过修改配置文件，可以自定义组件的默认行为和样式。