Filament How It Works

https://github.com/jeffersongoncalves/filament-how-it-works
Admin
Filament How It Works is a Filament panel plugin that provides an administrative CRUD interface to...
Tokens:1,281
Snippets:21
Trust Score:9.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install filament-how-it-works via Composer

Source: https://github.com/jeffersongoncalves/filament-how-it-works/blob/3.x/README.md

Install the package via Composer. Requires PHP and a Filament 5.x panel.

```bash
composer require jeffersongoncalves/filament-how-it-works:"^3.0"
```

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

### Publish filament-how-it-works config

Source: https://github.com/jeffersongoncalves/filament-how-it-works/blob/3.x/README.md

Publish the package configuration file to customize navigation group and resource classes.

```bash
php artisan vendor:publish --tag="filament-how-it-works-config"
```

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

### Run tests with composer test

Source: https://github.com/jeffersongoncalves/filament-how-it-works/blob/3.x/README.md

Run the package test suite.

```bash
composer test
```

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

### Default config for filament-how-it-works

Source: https://github.com/jeffersongoncalves/filament-how-it-works/blob/3.x/README.md

Default configuration file content. Set the navigation group label and map the 'step' resource to the StepResource class.

```php
return [
    'navigation_group' => 'How It Works',

    'resources' => [
        'step' => \JeffersonGoncalves\FilamentHowItWorks\Resources\Steps\StepResource::class,
    ],
];
```

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

### Register FilamentHowItWorksPlugin in panel provider

Source: https://github.com/jeffersongoncalves/filament-how-it-works/blob/3.x/README.md

Register the plugin in your Filament panel provider. The Steps resource uses translatable fields, so also register the filament-translatable plugin in the same panel.

```php
use JeffersonGoncalves\FilamentHowItWorks\FilamentHowItWorksPlugin;

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

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

### Register FilamentHowItWorksPlugin with navigationGroup

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

Registers the Filament How It Works plugin in a panel and sets its navigation group to 'Homepage'. Add this to the plugins() array in your PanelProvider.

```php
use JeffersonGoncalves\FilamentHowItWorks\FilamentHowItWorksPlugin;

FilamentHowItWorksPlugin::make()
    ->navigationGroup('Homepage');
```

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

### Override Step resource via config/filament-how-it-works.php

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

Overrides the default Step resource by specifying a custom resource class in the config file. The 'step' key maps to the resource class to use.

```php
// config/filament-how-it-works.php
return [
    'resources' => [
        'step' => \App\Filament\Resources\Steps\CustomStepResource::class,
    ],
];
```

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

### Set navigation group fluently

Source: https://github.com/jeffersongoncalves/filament-how-it-works/blob/3.x/README.md

Fluently set a custom navigation group label for the plugin.

```php
FilamentHowItWorksPlugin::make()->navigationGroup('Homepage');
```
Tokens:
Raw