ibrahimbougaoua/filament-rating-star

This is my package filament-rating-star

v1.0.4 2024-09-24 08:05 UTC

This package is auto-updated.

Last update: 2024-12-04 20:29:52 UTC


README

Latest Version on Packagist GitHub Code Style Action Status Total Downloads

Star rating field & Star column.

Support us

"Buy Me A Coffee"

Youtube Video

Installation

You can install the package via composer:

composer require ibrahimbougaoua/filament-rating-star

You can publish the config file with:

php artisan vendor:publish --tag="filament-rating-star-config"

This is the contents of the published config file:

return [
    'stars' => [
        'star1' => '1',
        'star2' => '2',
        'star3' => '3',
        'star4' => '4',
        'star5' => '5',
    ]
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="filament-rating-star-views"

Usage

With Form :

use IbrahimBougaoua\FilamentRatingStar\Forms\Components\RatingStar;

return $form
    ->schema([
        Section::make()
            ->schema([
                RatingStar::make('rating')
                ->label('Rating')
            ])
        ])

With Table :

use IbrahimBougaoua\FilamentRatingStar\Columns\Components\RatingStar;

return $table
    ->columns([
        RatingStar::make('rating')
    ])

With Infolist :

use IbrahimBougaoua\FilamentRatingStar\Entries\Components\RatingStar;

return $infolist
    ->schema([
        RatingStar::make('rating')
    ])

You can use the size method to customize the size of the stars:

use IbrahimBougaoua\FilamentRatingStar\Columns\Components\RatingStar;

return $table
    ->columns([
        RatingStar::make('rating')
            ->size('sm')
    ])

Supported sizes are xs, sm, md, lg and xl.

Testing

composer test

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.