Available Filters
LaraGrid provides several filter classes out of the box:
BaseFilter: This is the abstract base class for all filter types. It defines the basic structure and methods that all filters must have. It has methods like
setBuilderwhich sets a closure that modifies the query builder based on the filter's value.TextFilter: This class extends
BaseFilterand is used for filtering text fields. It sets the filtration type by default toLIKEand filter type toTEXT.
use BoredProgrammers\LaraGrid\Filters\TextFilter;
Column::make('name', 'Name')->setFilter(TextFilter::make()),SelectFilter: This class extends
BaseFilterand is used for filtering select fields. It sets the filtration type by default toEQUALand filter type toSELECT. It also has methods to set options for the select filter.
use BoredProgrammers\LaraGrid\Filters\SelectFilter;
Column::make('status', 'Status')
->setFilter(
SelectFilter::make()->setOptions([
'active' => 'Active',
'inactive' => 'Inactive',
])
),DateFilter: This class extends
BaseFilterand is used for filtering date fields. It sets the filtration type bu default toDATE_BETWEENand filter type toDATE.
use BoredProgrammers\LaraGrid\Filters\DateFilter;
Column::make('created_at', 'Created At')->setFilter(DateFilter::make()),BooleanFilter: This class extends
SelectFilterand is used for filtering boolean fields. It sets predefined options for boolean values.
use BoredProgrammers\LaraGrid\Filters\BooleanFilter;
Column::make('is_active', 'Is Active')->setFilter(BooleanFilter::make()),Filter Types
LaraGrid defines an enum class FilterType that lists the types of filters available: TEXT, SELECT, and DATE.
Filtration Types
LaraGrid defines an enum class FiltrationType that lists the types of filtrations available: LIKE, EQUAL, and DATE_BETWEEN.
Last updated
Was this helpful?