Skip to content

Latest commit

 

History

History
132 lines (90 loc) · 4.04 KB

README.md

File metadata and controls

132 lines (90 loc) · 4.04 KB
Raw

Filament Price Filter

Latest Version on Packagist GitHub Code Style Action Status Total Downloads

thumbnail

A simple and customizable price filter for FilamentPHP, allowing users to easily refine results based on specified price ranges.

Installation

You can install the package via composer:

composer require codewithdennis/filament-price-filter

Make sure you add the following to your tailwind.config.js file. You will need to create a theme if you haven't already.

'./vendor/codewithdennis/filament-price-filter/resources/**/*.blade.php'

You can publish the config file with:

php artisan vendor:publish --tag="filament-price-filter-config"

This is the contents of the published config file:

<?php

return [
    'currency' => 'USD',
    'cents' => true,
];

Usage

Note

Global settings can be overridden by passing the desired values to the PriceFilter::make('price') method.

By default, the currency is set to USD globally, but you can change it per filter to any currency you want.

PriceFilter::make('price')
    ->currency(currency: 'EUR')

The filter will use the locale that is used in the application config('app.locale'), but you can also set a custom locale.

PriceFilter::make('price')
    ->currency(locale: 'NL'),

A good practice is to save your currency as cents but if you saved it as a whole number you can disable the cents.

PriceFilter::make('price')
    ->currency(cents: false),

If you want to use a range slider instead of an input field you can enable it.

PriceFilter::make('price')
    ->slider()

Set the minimum and maximum values for the filter.

PriceFilter::make('price')
    ->min(100)
    ->max(1000)

If you want to grab the min, max values from the database you can use the min and max methods. Here is an example of how you can use it with caching.

Note

Flexible cache is a caching helper method that is introduced in Laravel 11.23.0, you can also use the default cache function.

->min(fn () => Cache::flexible('min_price', [30, 60], function () {
    return Order::min('price') / 100; // Divide by 100 if you saved it as cents
}))
->max(fn () => Cache::flexible('max_price', [30, 60], function () {
    return Order::max('price') / 100; // Divide by 100 if you saved it as cents
}))

The step value is used to determine the interval between each value in the filter.

PriceFilter::make('price')
    ->step(100)

By default, the label will be the name of the filter, for example PriceFilter::make('total_price') will have a label of Total price to and Total price from. You can change the label to whatever you want.

PriceFilter::make('price')
    ->label('Shipping price')

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.