https://github.com/ibrahimbougaoua/filaprogress

The Progress Management Package for FilamentPHP provides a flexible and easy-to-use solution for tracking and visualizing progress within Filament admin panels.
https://github.com/ibrahimbougaoua/filaprogress

Last synced: about 2 months ago
JSON representation

The Progress Management Package for FilamentPHP provides a flexible and easy-to-use solution for tracking and visualizing progress within Filament admin panels.

• Host: GitHub
• URL: https://github.com/ibrahimbougaoua/filaprogress
• Owner: ibrahimBougaoua
• License: mit
• Created: 2024-09-03T08:11:09.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-12T09:37:39.000Z (3 months ago)
• Last Synced: 2024-09-12T20:48:03.115Z (3 months ago)
• Language: Blade
• Homepage:
• Size: 39.1 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Progress indicators

[![Latest Version on Packagist](https://img.shields.io/packagist/v/ibrahim-bougaoua/filaprogress.svg?style=flat-square)](https://packagist.org/packages/ibrahim-bougaoua/filaprogress)

[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/ibrahim-bougaoua/filaprogress/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/ibrahim-bougaoua/filaprogress/actions?query=workflow%3Arun-tests+branch%3Amain)

[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/ibrahim-bougaoua/filaprogress/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/ibrahim-bougaoua/filaprogress/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)

[![Total Downloads](https://img.shields.io/packagist/dt/ibrahim-bougaoua/filaprogress.svg?style=flat-square)](https://packagist.org/packages/ibrahim-bougaoua/filaprogress)

The Progress Management Package for FilamentPHP provides a flexible and easy-to-use solution for tracking and visualizing progress within Filament admin panels. It includes custom Filament components for displaying linear and circular progress indicators directly in your admin interface. This package is designed to seamlessly integrate with Filament's existing tools, offering dynamic and customizable progress bars and circles to represent task completion, project milestones, or any metric that requires visual progress tracking. Perfect for enhancing the user experience in admin dashboards with intuitive, real-time progress displays.

## Support us

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://buymeacoffee.com/ibrahimbougaoua)

Youtube Video




[![Total Downloads](https://raw.githubusercontent.com/filamentphp/filamentphp.com/dec76a6d43253f6e5947b3bcb99370c5a2509760/content/plugins/images/ibrahim-bougaoua-filaprogress.jpg)](https://packagist.org/packages/ibrahim-bougaoua/filaprogress)

## Installation

You can install the package via composer:

```bash

composer require ibrahim-bougaoua/filaprogress

```

Optionally, you can publish the views using

```bash

php artisan vendor:publish --tag="filaprogress-views"

```

## Usage

```php

// For infolist

use IbrahimBougaoua\FilaProgress\Infolists\Components\CircleProgressEntry;

use IbrahimBougaoua\FilaProgress\Infolists\Components\ProgressBarEntry;

return $infolist

    ->schema([

        CircleProgressEntry::make('circle')

            ->getStateUsing(function ($record) {

                $total = $record->items()->count();

                $progress = $record->countPaidItems();

                return [

                    'total' => $total,

                    'progress' => $progress,

                ];

            })

            ->hideProgressValue(),

        ProgressBarEntry::make('bar')

            ->getStateUsing(function ($record) {

                $total = $record->items()->count();

                $progress = $record->countPaidItems();

                return [

                    'total' => $total,

                    'progress' => $progress,

                ];

            })

            ->hideProgressValue(),

```

```php

// For table

use IbrahimBougaoua\FilaProgress\Tables\Columns\CircleProgress;

use IbrahimBougaoua\FilaProgress\Tables\Columns\ProgressBar;

return $table

    ->columns([

        CircleProgress::make('circle')

            ->getStateUsing(function ($record) {

                $total = $record->items()->count();

                $progress = $record->countPaidItems();

                return [

                    'total' => $total,

                    'progress' => $progress,

                ];

            })

            ->hideProgressValue(),

        ProgressBar::make('bar')

            ->getStateUsing(function ($record) {

                $total = $record->items()->count();

                $progress = $record->countPaidItems();

                return [

                    'total' => $total,

                    'progress' => $progress,

                ];

            })

            ->hideProgressValue(),

```

## Testing

```bash

composer test

```

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [Ibrahim Bougaoua](https://github.com/Ibrahim Bougaoua)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.