README

Livewire 组件，用于依赖和/或可搜索的选择输入

预览

安装

您可以通过 Composer 安装此包

composer require asantibanez/livewire-select

需求

此包在底层使用 livewire/livewire (https://laravel-livewire.com/)。

它还使用 TailwindCSS (https://tailwind.org.cn/) 进行基本样式。

在使用此组件之前，请确保包含这两个依赖项。

用法

为了使用此组件，您必须创建一个新的 Livewire 组件，该组件从 LivewireSelect 扩展

您可以使用 make:livewire 命令创建一个新的组件。例如。

php artisan make:livewire CarModelSelect

在 CarModelSelect 类中，不要从基本的 Livewire Component 类扩展，而是从 LivewireSelect 类扩展。同时删除 render 方法。您将有一个类似以下代码段的类。

class CarModelSelect extends LivewireSelect
{
    //
}

在这个类中，您必须重写以下方法来为您的选择输入提供选项

public function options($searchTerm = null) : Collection 
{
    //
}

options() 必须返回一个具有至少以下键的键值数组集合：value 和 description。例如

public function options($searchTerm = null) : Collection 
{
    return collect([
        [
            'value' => 'honda',
            'description' => 'Honda',
        ],
        [
            'value' => 'mazda',
            'description' => 'Mazda',
        ],
        [
            'value' => 'tesla',
            'description' => 'Tesla',
        ],       
    ]);
}

要在视图中渲染组件，只需使用 Livewire 标签或包含语法即可

<livewire:car-brand-select
   name="car_brand_id"
   :value="$initialValue" // optional
   placeholder="Choose a Car Brand" // optional
/>

您将在屏幕上看到一个选择输入，它具有您定义的值的自定义样式

这里没有什么花哨的。现在，让我们使另一个选择输入依赖于其值。

创建另一个组件，按照上述相同的过程。在这种情况下，我们将创建一个 CarModelSelect，其 options() 方法如下。

// In CarModelSelect component
public function options($searchTerm = null) : Collection 
{
    $modelsByBrand = [
        'tesla' => [
            ['value' => 'Model S', 'description' => 'Model S'],
            ['value' => 'Model 3', 'description' => 'Model 3'],
            ['value' => 'Model X', 'description' => 'Model X'],
        ],
        'honda' => [
            ['value' => 'CRV', 'description' => 'CRV'],
            ['value' => 'Pilot', 'description' => 'Pilot'],
        ],
        'mazda' => [
            ['value' => 'CX-3', 'description' => 'CX-3'],
            ['value' => 'CX-5', 'description' => 'CX-5'],
            ['value' => 'CX-9', 'description' => 'CX-9'],
        ],
    ];

    $carBrandId = $this->getDependingValue('car_brand_id');

    if ($this->hasDependency('car_brand_id') && $carBrandId != null) {
        return collect(data_get($modelsByBrand, $carBrandId, []));
    }

    return collect([
        ['value' => 'Model S', 'description' => 'Tesla - Model S'],
        ['value' => 'Model 3', 'description' => 'Tesla - Model 3'],
        ['value' => 'Model X', 'description' => 'Tesla - Model X'],
        ['value' => 'CRV', 'description' => 'Honda - CRV'],
        ['value' => 'Pilot', 'description' => 'Honda - Pilot'],
        ['value' => 'CX-3', 'description' => 'Mazda - CX-3'],
        ['value' => 'CX-5', 'description' => 'Mazda - CX-5'],
        ['value' => 'CX-9', 'description' => 'Mazda - CX-9'],
    ]);
}

并在视图中按如下方式定义它

<livewire:car-model-select
    name="car_model_id"
    placeholder="Choose a Car Model"
    :depends-on="['car_brand_id']"
/>

通过这两个代码段，我们定义了一个选择输入，它通过 depends-on 具有名称 car_brand_id 的另一个选择输入。通过此定义，我们告诉我们的组件监听对 car_brand_id 输入的任何更新并通知更改。

注意在 options() 方法中使用了另外两个辅助方法：getDependingValue 和 hasDependency。

getDependingValue('token') 将返回另一个字段的值，在本例中为 car_brand_id。如果 car_brand_id 没有值，则返回 null。

hasDependency('token') 允许我们检查我们的组件是否指定为依赖于其他组件的值。这允许我们通过检查布局中是否指定了依赖项来重用组件。

例如，如果我们定义了没有 :depends-on 属性的同义组件，我们可以使用该组件并返回所有车型。

<livewire:car-model-select
    name="car_model_id"
    placeholder="Choose a Car Model"
/>

它看起来可能像这样

可搜索的输入

您可以在组件上定义 searchable 属性来更改输入的行为。使用 :searchable="true"，您的组件将更改其行为以允许搜索在 options() 方法中返回的选项。

<livewire:car-model-select
   name="car_model_id"
   placeholder="Choose a Car Model"
   :searchable="true"
/>

您的输入将看起来像这样

要过滤下拉菜单中的选项，您可以在 options() 方法中使用 $searchTerm 参数。

自定义 UI

// TODO 😬

高级行为

// TODO 😬

AlpineJs 支持

添加 AlpineJs 以实现箭头键导航、回车键选择、回车/空格键重置。 😎

测试

composer test

变更日志

有关最近更改的更多信息，请参阅 CHANGELOG。

贡献

有关详细信息，请参阅 CONTRIBUTING。

安全

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

鸣谢

许可协议

MIT 许可协议 (MIT)。有关更多信息，请参阅许可文件。

tustin / livewire-select

维护者

详细信息