README

为依赖项和/或可搜索的选择输入提供 Livewire 组件

预览

安装

您可以通过 composer 安装此包

composer require asantibanez/livewire-select

要求

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

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

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

用法

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

您可以使用 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）。请参阅许可证文件以获取更多信息。

wdarins / livewire-select

维护者

详情