Filament Benefit

https://github.com/jeffersongoncalves/filament-benefit
Admin
Filament Benefit is a Filament panel plugin that provides an admin UI and CRUD resource for managing...
Tokens:1,167
Snippets:22
Trust Score:9.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install filament-benefit via Composer

Source: https://github.com/jeffersongoncalves/filament-benefit/blob/3.x/README.md

Install the package via Composer. Requires PHP and a Filament panel (version 5.x for package 3.x).

```bash
composer require jeffersongoncalves/filament-benefit:"^3.0"
```

--------------------------------

### Publish filament-benefit config

Source: https://github.com/jeffersongoncalves/filament-benefit/blob/3.x/README.md

Publish the package configuration file.

```bash
php artisan vendor:publish --tag="filament-benefit-config"
```

--------------------------------

### Run tests with composer test

Source: https://github.com/jeffersongoncalves/filament-benefit/blob/3.x/README.md

Run the package test suite.

```bash
composer test
```

--------------------------------

### Set navigation group fluently

Source: https://github.com/jeffersongoncalves/filament-benefit/blob/3.x/README.md

Configure the plugin fluently by setting a custom navigation group.

```php
FilamentBenefitPlugin::make()->navigationGroup('Perks');
```

--------------------------------

### Default filament-benefit config file

Source: https://github.com/jeffersongoncalves/filament-benefit/blob/3.x/README.md

Default configuration file content. Shows the navigation group and the Benefit resource class.

```php
return [
    'navigation_group' => 'Benefits',

    'resources' => [
        'benefit' => \JeffersonGoncalves\FilamentBenefit\Resources\Benefits\BenefitResource::class,
    ],
];
```

--------------------------------

### Register FilamentBenefitPlugin with navigation group

Source: https://github.com/jeffersongoncalves/filament-benefit/blob/3.x/resources/boost/skills/filament-benefit-development/SKILL.md

Add the FilamentBenefitPlugin to a Filament panel and set a custom navigation group. Use this in the panel's plugins() array.

```php
use JeffersonGoncalves\FilamentBenefit\FilamentBenefitPlugin;

FilamentBenefitPlugin::make()
    ->navigationGroup('Perks');
```

--------------------------------

### Register FilamentBenefitPlugin in panel provider

Source: https://github.com/jeffersongoncalves/filament-benefit/blob/3.x/README.md

Register the plugin in your Filament panel provider. The Benefit resource requires a filament-translatable plugin instance to be registered in the same panel.

```php
use JeffersonGoncalves\FilamentBenefit\FilamentBenefitPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            FilamentBenefitPlugin::make(),
        ]);
}
```

--------------------------------

### Override Benefit resource class via config

Source: https://github.com/jeffersongoncalves/filament-benefit/blob/3.x/resources/boost/skills/filament-benefit-development/SKILL.md

Configure the custom resource class for the Benefit resource in config/filament-benefit.php. This overrides the default resource.

```php
// config/filament-benefit.php
return [
    'resources' => [
        'benefit' => \App\Filament\Resources\Benefits\CustomBenefitResource::class,
    ],
];
```
Tokens:
Raw