ashwin-nath-m / filament-range-field

Provides the missing range field for the Filament forms.

The missing range field for the Filament forms.

Installation

You can install the package via composer:

"repositories": [
    {
        "type":"package",
        "package": {
            "name": "ashwin-nath-m/filament-range-field",
            "version":"v1.0.0",
            "source": {
                "url": "https://github.com/ashwin-nath-m/filament-range-field.git",
                "type": "git",
                "reference":"v1.0.0"
            }
        }
    }
],
    "require": {
          "ashwin-nath-m/filament-range-field": "v1.0.0"
    }

Publish the assets:

php artisan vendor:publish --tag="filament-range-field-assets"

Optionally, you can publish the views using

php artisan vendor:publish --tag="filament-range-field-views"

Basic usage

By default the range is used to get value from 0 to 100.

use Yepsua\Filament\Forms\Components\RangeSlider

...
    protected function getFormSchema(): array
    {
        return [
            ...
            RangeSlider::make('range')
            ...
        ];
    }
...

Defining the steps:

use Yepsua\Filament\Forms\Components\RangeSlider

...
    protected function getFormSchema(): array
    {
        return [
            ...
            RangeSlider::make('range')->steps([
                'A', // should get value: 1 for the A
                'B', // should get value: 2 for the B
                'C', // should get value: 3 for the C
                'D'  // should get value: 4 for the D
            ])
            ...
        ];
    }
...

Associative Array:

use Yepsua\Filament\Forms\Components\RangeSlider

...
    protected function getFormSchema(): array
    {
        return [
            ...
            RangeSlider::make('range')->steps([
                '25'  => 'A', // should get value: 25  for the A
                '50'  => 'B', // should get value: 50  for the B
                '75'  => 'C', // should get value: 75  for the C
                '100' => 'D'  // should get value: 100 for the D
            ])
            ...
        ];
    }
...

Hide the Step List:

use Yepsua\Filament\Forms\Components\RangeSlider

...
    protected function getFormSchema(): array
    {
        return [
            ...
            RangeSlider::make('range')->steps([
                'A',
                'B',
                'C',
                'D'
            ])->displaySteps(false)
            ...
        ];
    }
...

📕 Note: The step value is defined by the first item in the steps array, Ex. => [25, 50, 75, 100] the step value should be 25. However if you need to define any other step value you can use the setter step.

    RangeSlider::make('range')->steps([
        0 => '0',
        25 => '25',
        50 => '50',
        75 => '75',
        100 => '100'
    ])->step(25)
    ...

The same case applies for the min and max setters:

    RangeSlider::make('range')->min(25)->max(75)->step(5)

Testing

composer test

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

• Omar Yepez
• All Contributors

License

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