https://github.com/tappnetwork/filament-value-range-filter
A value range filter for Laravel Filament.
https://github.com/tappnetwork/filament-value-range-filter
filament filamentphp filter laravel plugin range value
Last synced: 7 months ago
JSON representation
A value range filter for Laravel Filament.
- Host: GitHub
- URL: https://github.com/tappnetwork/filament-value-range-filter
- Owner: TappNetwork
- License: mit
- Created: 2024-06-20T00:40:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-06T17:04:29.000Z (8 months ago)
- Last Synced: 2025-07-22T01:52:24.222Z (7 months ago)
- Topics: filament, filamentphp, filter, laravel, plugin, range, value
- Language: PHP
- Homepage:
- Size: 846 KB
- Stars: 20
- Watchers: 4
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Filament Value Range Filter
[](https://packagist.org/packages/tapp/filament-value-range-filter)
[](https://packagist.org/packages/tapp/filament-value-range-filter)
A value range filter for Filament table builder.
## Version Compatibility
Filament | Filament Value Range Filter
:---------|:---------------------------
3.x | 1.x
4.x | 2.x
## Installation
You can install the package via composer:
### For Filament 3
```bash
composer require tapp/filament-value-range-filter:"^1.0"
```
### For Filament 4
```bash
composer require tapp/filament-value-range-filter:"^2.0"
```
Optionally, you can publish the translations files with:
```bash
php artisan vendor:publish --tag="filament-value-range-filter-translations"
```
## Appareance
**Filter Indicators**
## Usage
### Filter
Add to your Filament resource:
```php
use Tapp\FilamentValueRangeFilter\Filters\ValueRangeFilter;
public static function table(Table $table): Table
{
return $table
//...
->filters([
ValueRangeFilter::make('project_value')
->currency(),
ValueRangeFilter::make('estimated_hours'),
// ...
])
}
```
### Options
#### Currency
You may use the `->currency()` method to format the values on placeholder and filter indicator as currency. The default currency format is `USD`.
```php
ValueRangeFilter::make('project_value')
->currency(),
```
**Change the currency format**
The `->currencyCode()` and `->locale()` methods can be used to change the currency format.
You can pass one of the [ISO 4217 currency codes](https://www.iban.com/currency-codes) to the `->currencyCode()` method.
```php
ValueRangeFilter::make('project_value')
->currency()
->currencyCode('EUR')
->locale('fr'),
```
**Currency value**
When using currency values, the filter assumes that the value stored on database that will be compared with the provided value on filter is in the smallest unit of the currency (e.g., cents for USD). Therefore, the value provided in the filter is by default multiplied by 100 to be compared with the value stored in the database.
If the values stored in your database are not in the currency's smallest unit and you do not need the value provided in the filter to be multiplied by 100, pass 'false' to the `->currencyInSmallestUnit()` method:
```php
ValueRangeFilter::make('project_value')
->currency()
->currencyInSmallestUnit(false),
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
If you discover any security-related issues, please email `security@tappnetwork.com`.
## Credits
- [Tapp Network](https://github.com/TappNetwork)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.