cooper / filament-dcat-filters
Bring Dcat Admin's powerful filter features to Filament - including Scope filters, Range filters, SelectTable, and more quick filters
Fund package maintenance!
myxiaoao
Installs: 0
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 0
Forks: 1
Open Issues: 0
pkg:composer/cooper/filament-dcat-filters
Requires
- php: ^8.3
- filament/filament: ^4.0 || ^5.0
Requires (Dev)
- laravel/pint: ^1.0
- nunomaduro/larastan: ^3.0
- orchestra/testbench: ^10.0
- pestphp/pest: ^4.0
- pestphp/pest-plugin-arch: ^4.0
- pestphp/pest-plugin-laravel: ^4.0
- phpstan/phpstan: ^2.0
- phpstan/phpstan-deprecation-rules: ^2.0
This package is auto-updated.
Last update: 2026-01-21 01:22:27 UTC
README
Filament Dcat Filters
Bring Dcat Admin's powerful filter features to Filament
Built with PHP 8.3+ for Laravel 12 and Filament v4/v5
A modern collection of enhanced filters inspired by Dcat Admin, combining intuitive UI components with powerful filtering capabilities for Filament admin panels.
English Documentation | δΈζζζ‘£
Features
Core Filters
- π― Scope Filter - Tab-style quick filters for common queries
- π Range Filter - Simplified date/number range filtering (3 lines of code!)
- π Date Component Filter - Filter by year, month, or day separately
- π SelectTable Filter - Modal table selector with search and pagination
- π Modal Select Filter - Dcat Admin style modal with full table display
- π’ Between Filter - Numeric range filtering shortcut
- π Hidden Filter - URL parameter-based filtering without UI
Quick Filters
- β‘ LIKE Filter - Text search with wildcard control (supports NOT LIKE)
- π IN Filter - Multiple value selection (supports NOT IN)
- π’ Comparison Filter - Comparison operators (>, <, >=, <=, =, !=)
- β Boolean Filter - True/false/all toggle for boolean fields
- π Null Filter - NULL/NOT NULL value filtering
- π Enum Filter - Auto-generate options from PHP 8.1+ Enum classes
- π FullText Filter - Search across multiple fields simultaneously
- π Relative Date Filter - Pre-defined date range shortcuts
Specialized Filters
- ποΈ JSON Filter - Query JSON/JSONB columns with path access
- π·οΈ FindInSet Filter - Query comma-separated values using FIND_IN_SET
- π€ Regex Filter - Pattern matching with regular expressions
- π± InputMask Filter - Formatted input with masks (phone, credit card, etc.)
- π GeoLocation Filter - Geographic proximity filtering with Haversine formula
- π Filter Group - Combine filters with AND/OR logic
Advanced Features
- π Reset All Filters - One-click reset button for all active filters
- πΎ Filter State Persistence - Remember filter states across sessions
- π URL Query Parameter Sync - Shareable filter URLs without page reload
- π Cascading Select Filter - Dynamic dependent dropdowns
- βΏ Accessibility Support - ARIA labels and keyboard navigation
- π Filter Presets - Save and load filter combinations
- π’ Scope Badge Counts - Display record counts on scope tabs
- π€ Filter Export/Import - Share filter configurations via URL or JSON
Additional Features
- π¨ Highly Customizable - Extensive customization options for each filter
- π± Mobile Friendly - Responsive design for all screen sizes
- π Bilingual Docs - Complete English and Chinese documentation
- β Fully Tested - Comprehensive test coverage with 461 tests
Version Compatibility
| Filament | Filament Dcat Filters | PHP | Laravel |
|---|---|---|---|
| 5.x | 1.x | ^8.3 | ^12.0 |
| 4.x | 1.x | ^8.3 | ^12.0 |
Installation
You can install the package via composer:
composer require cooper/filament-dcat-filters
Optionally, you can publish the config file:
php artisan vendor:publish --tag="filament-dcat-filters-config"
Optionally, you can publish the views:
php artisan vendor:publish --tag="filament-dcat-filters-views"
Quick Start
Scope Filter
Perfect for quick filtering with tab-style buttons:
use Cooper\FilamentDcatFilters\Filters\ScopeFilter; ScopeFilter::make('status') ->scopes([ 'all' => 'All', 'active' => 'Active', 'inactive' => 'Inactive', ])
View detailed documentation β
Range Filter
Simplified date/number range filtering:
use Cooper\FilamentDcatFilters\Filters\RangeFilter; RangeFilter::make('created_at')->datetime()
View detailed documentation β
SelectTable Filter
Modal table selector with search and pagination:
use Cooper\FilamentDcatFilters\Filters\SelectTableFilter; SelectTableFilter::make('user_id') ->relationship('user', 'name') ->multiple()
View detailed documentation β
Date Component Filter
Filter by year, month, or day components:
use Cooper\FilamentDcatFilters\Filters\DateComponentFilter; DateComponentFilter::make('created_at')->year() DateComponentFilter::make('birth_date')->month() DateComponentFilter::make('published_at')->day()
View detailed documentation β
Modal Select Filter
Dcat Admin style modal with full table display:
use Cooper\FilamentDcatFilters\Filters\ModalSelectFilter; ModalSelectFilter::make('user_id') ->model(User::class, 'name', 'id') ->dialogTitle('Select User') ->displayColumns(['id' => 'ID', 'name' => 'Name', 'email' => 'Email']) ->searchable(['name', 'email']) ->multiple()
View detailed documentation β
Quick Filters
Built-in filters for common operations:
use Cooper\FilamentDcatFilters\Filters\{LikeFilter, InFilter, ComparisonFilter, BetweenFilter}; // LIKE search (with NOT LIKE support) LikeFilter::make('title'), LikeFilter::make('spam_keywords')->notLike(), // Exclude matches // IN array (with NOT IN support) InFilter::make('category_id') ->options(Category::pluck('name', 'id')->toArray()), InFilter::make('blocked_users')->notIn(), // Exclude selected // Comparison (>, <, =, >=, <=, !=) ComparisonFilter::make('views')->gte()->label('Minimum Views'), // Between (numeric range) BetweenFilter::make('price')->label('Price Range'),
View detailed documentation β
Boolean Filter
Dedicated true/false/all toggle for boolean fields:
use Cooper\FilamentDcatFilters\Filters\BooleanFilter; BooleanFilter::make('is_active') ->label('Status') ->trueLabel('Active') ->falseLabel('Inactive') // Quick presets BooleanFilter::active() // is_active field BooleanFilter::published() // is_published field BooleanFilter::enabled() // is_enabled field
Null Filter
Filter for NULL or NOT NULL values:
use Cooper\FilamentDcatFilters\Filters\NullFilter; NullFilter::make('deleted_at') ->nullLabel('Not Deleted') ->notNullLabel('Deleted') // Quick presets NullFilter::deleted() // deleted_at field NullFilter::assigned() // Check if field is assigned NullFilter::empty() // Check if field is empty/filled
Enum Filter
Auto-generate options from PHP 8.1+ Enum classes:
use Cooper\FilamentDcatFilters\Filters\EnumFilter; EnumFilter::make('status') ->enum(OrderStatus::class) ->multiple() ->exclude([OrderStatus::Cancelled])
FullText Filter
Search across multiple fields simultaneously:
use Cooper\FilamentDcatFilters\Filters\FullTextFilter; FullTextFilter::make('search') ->searchIn(['name', 'email', 'phone']) ->placeholder('Search users...') ->minLength(2) ->debounce(300)
Relative Date Filter
Pre-defined date range shortcuts:
use Cooper\FilamentDcatFilters\Filters\RelativeDateFilter; RelativeDateFilter::make('created_at') ->only(['today', 'yesterday', 'last_7_days', 'last_30_days', 'this_month']) // Quick presets RelativeDateFilter::common() // Common date ranges RelativeDateFilter::weekly() // Week/month focused RelativeDateFilter::reporting() // Quarter/year focused
Hidden Filter
URL parameter-based filtering (no UI):
use Cooper\FilamentDcatFilters\Filters\HiddenFilter; // Pre-filter by tenant HiddenFilter::make('tenant_id') ->default(auth()->user()->tenant_id) ->eq()
View detailed documentation β
Reset All Filters
Add a one-click reset button:
use Cooper\FilamentDcatFilters\Concerns\HasResetFilters; class ListUsers extends ListRecords { use HasResetFilters; protected function getHeaderActions(): array { return [ $this->getResetFiltersAction(), ]; } }
View detailed documentation β
Filter State Persistence
Remember filter states across sessions:
use Cooper\FilamentDcatFilters\Concerns\HasFilterPersistence; class ListUsers extends ListRecords { use HasFilterPersistence; protected string $filterPersistenceKey = 'users-list-filters'; }
View detailed documentation β
URL Query Parameter Sync
Shareable filter URLs:
use Cooper\FilamentDcatFilters\Concerns\SyncsFiltersToUrlWithoutHistory; class ListUsers extends ListRecords { use SyncsFiltersToUrlWithoutHistory; }
View detailed documentation β
Cascading Select Filter
Dynamic dependent dropdowns:
use Cooper\FilamentDcatFilters\Filters\CascadingSelectFilter; CascadingSelectFilter::make('location') ->levels([ 'country' => [ 'label' => 'Country', 'options' => fn () => Country::pluck('name', 'id'), ], 'state' => [ 'label' => 'State', 'options' => fn ($country) => State::where('country_id', $country)->pluck('name', 'id'), 'dependsOn' => 'country', ], 'city' => [ 'label' => 'City', 'options' => fn ($state) => City::where('state_id', $state)->pluck('name', 'id'), 'dependsOn' => 'state', ], ])
View detailed documentation β
Documentation
Core Filters
- π Scope Filter - Tab-style quick filters
- π Range Filter - Date/number range filtering
- π Date Component Filter - Year/Month/Day filtering
- π SelectTable Filter - Modal table selector
- π Modal Select Filter - Dcat Admin style modal table selector
- π Quick Filters - LIKE, IN, GT, LT, BETWEEN filters
Specialized Filters
- π JSON Filter - Query JSON/JSONB columns with path access
- π FindInSet Filter - Query comma-separated values
- π Regex Filter - Pattern matching with regular expressions
- π InputMask Filter - Formatted input with masks
- π GeoLocation Filter - Geographic proximity filtering
- π Filter Group - Combine filters with AND/OR logic
Advanced Features
- π Reset All Filters - One-click reset functionality
- π Filter State Persistence - Session-based filter memory
- π URL Query Parameter Sync - Shareable filter URLs
- π Cascading Select Filter - Dynamic dependent dropdowns
- π Accessibility - ARIA labels and keyboard support
- π Advanced Features - API support, Hidden filters
- π Concerns (Traits) - Filter presets, badge counts, export/import
Guides & References
- π Usage Examples - Complete working examples
- π Demo Guide - Interactive demonstrations
- π Comparison with Dcat Admin - Feature comparison
- π Package Structure - Package architecture
- π Documentation Structure - Documentation organization
- π Future Improvements - Roadmap and planned features
Facade Usage
You can also use the Facade for quick access:
use Cooper\FilamentDcatFilters\Facades\FilamentDcatFilters; FilamentDcatFilters::scopeFilter('status')->scopes([...]); FilamentDcatFilters::rangeFilter('created_at')->datetime();
Testing
composer test
Code Quality
# Format code composer format # Static analysis composer analyse
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
If you discover any security-related issues, please email myxiaoao@gmail.com.
Credits
- Cooper
- Inspired by Dcat Admin
- All Contributors
License
The MIT License (MIT). Please see License File for more information.