Add a progress bar column to your Filament tables.
This package provides a ProgessColumn that can be used to display a progress bar in a Filament table.
Installation
You can install the package via Composer:
composer require ryangjchandler/filament-progress-column
If you're not using the filament/admin package, you should also add the following line to the top of your CSS:
@import '../../vendor/ryangjchandler/filament-progress-column/resources/dist/progress.css'
Optionally, you can publish the views using
php artisan vendor:publish --tag="filament-progress-column-views"
Usage
Add the ProgressColumn to your table:
use RyanChandler\FilamentProgressColumn\ProgressColumn;
protected function getTableColumns(): array
{
return [
ProgressColumn::make('progress'),
];
}
This will render a progress bar and used the value of $record->progress as the current progress.
Dynamic progress calculation
If you wish to calculate the progress dynamically, provide a Closure to the ProgressColumn::progress() method.
protected function getTableColumns(): array
{
return [
ProgressColumn::make('progress')
->progress(function ($record) {
return ($record->rows_complete / $record->total_rows) * 100;
}),
];
}
Polling
If you would like your progress bar to update after a period of time, call the ProgressBar::poll() method and provide a valid modifier string for the wire:poll directive.
protected function getTableColumns(): array
{
return [
ProgressColumn::make('progress')
->poll('5s')
];
}
This will result in a wire:poll.5s directive being added to the column and the value of your progress bar will update every 5 seconds.
Dynamic polling
There might be scenarios where you only want to poll if some condition is met. This can be achieved by returning ?string from a Closure.
protected function getTableColumns(): array
{
return [
ProgressColumn::make('progress')
->poll(function ($record) {
return $record->progress < 100 ? '5s' : null;
})
];
}
Now the progress bar will only be updated every 5 seconds if the progress is less than 100.
Colors
By default, the progress bar will be the same as your primary color. If you wish to change this, provide a new string to ProgressBar::color().
protected function getTableColumns(): array
{
return [
ProgressColumn::make('progress')
->color('warning'),
];
}
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
License
The MIT License (MIT). Please see License File for more information.
24 Dec 6, 2022
13 Jan 20, 2022
11 Sep 20, 2022
5 Nov 24, 2022
5 May 30, 2022
6 Jun 15, 2023
11 Aug 26, 2022
14.7k Dec 30, 2022
16 Aug 23, 2022
7 Jul 25, 2022
41 Jan 2, 2023
5 Jun 12, 2023
62 Dec 31, 2022
39 Dec 21, 2022
69 Jan 4, 2023