Skip to main content

​
Introduction

Often, you will want to use a select field instead of a checkbox. This is especially true when you want to filter a column based on a set of pre-defined options that the user can choose from. To do this, you can create a filter using the SelectFilter class:
The options() that are passed to the filter are the same as those that are passed to the select field.
options() is a UI affordance, not an authorization boundary. The list constrains what the dropdown displays, but the submitted value is not checked against it before the filter runs. A user tampering with the Livewire request can submit any value to the filter’s state — apply() will pass it straight into whereIn/where on the query.If you are using options() to hide certain values from a group of users (for example, hiding archived from non-admins), scope the table query itself instead — for example with modifyQueryUsing() or a global scope on the resource — so the restricted rows are never reachable regardless of what the filter submits.

​
Customizing the column used by a select filter

Select filters do not require a custom query() method. The column name used to scope the query is the name of the filter. To customize this, you may use the attribute() method:

​
Multi-select filters

These allow the user to select multiple options to apply the filter to their table. For example, a status filter may present the user with a few status options to pick from and filter the table using. When the user selects multiple options, the table will be filtered to show records that match any of the selected options. You can enable this behavior using the multiple() method:

​
Relationship select filters

Select filters are also able to automatically populate themselves based on a relationship. For example, if your table has a author relationship with a name column, you may use relationship() to filter the records belonging to an author:

​
Searching select filter options

You may enable a search input to allow easier access to many options, using the searchable() method:

​
Preloading the select filter relationship options

If you’d like to populate the searchable options from the database when the page is loaded, instead of when the user searches, you can use the preload() method:

​
Filtering empty relationships

By default, upon selecting an option, all records that have an empty relationship will be excluded from the results. If you want to introduce an additional “None” option for the user to select, which will include all records that do not have a relationship, you can use the hasEmptyOption() argument of the relationship() method:
You can rename the “None” option using the emptyRelationshipOptionLabel() method:

​
Customizing relationship option labels

You can use getOptionLabelFromRecordUsing() to customize each option’s label using its related record. The default active-filter indicator uses the same labels:
This also works with multiple(). The callback is evaluated by the filter’s select field, so it can use the same utility injection as other select fields.

​
Customizing the select filter relationship query

You may customize the database query that retrieves options using the third parameter of the relationship() method:

​
Disable placeholder selection

You can remove the placeholder (null option), which disables the filter so all options are applied, using the selectablePlaceholder() method:

​
Applying select filters by default

You may set a select filter to be enabled by default, using the default() method. If using a single select filter, the default() method accepts a single option value. If using a multiple() select filter, the default() method accepts an array of option values: