Filament Plugin Core

https://github.com/jeffersongoncalves/filament-plugin-core

Admin

Filament Plugin Core provides shared base classes and helpers for Filament plugins to eliminate...

Tokens:783

Snippets:12

Trust Score:9.8

License:MIT

Update:1 month ago

Show doc for...

Tokens:

Raw

### Install filament-plugin-core via Composer

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

Install the package via Composer. Requires PHP 8.2+, Laravel 11.0+, and Filament 5.x (3.x branch).

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

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

### Create a service provider with render hooks

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

Extend BasePackageServiceProvider to configure the package and register render hooks. The registerRenderHooks method collapses render-hook closures into a simple hook-to-view mapping.

```php
use Filament\View\PanelsRenderHook;
use JeffersonGoncalves\FilamentPluginCore\BasePackageServiceProvider;
use Spatie\LaravelPackageTools\Package;

class MyServiceProvider extends BasePackageServiceProvider
{
    public function configurePackage(Package $package): void
    {
        $package->name('my-plugin')->hasTranslations();
    }

    public function packageRegistered(): void
    {
        $this->registerRenderHooks([
            PanelsRenderHook::HEAD_START => 'my-plugin::script',
        ]);
    }
}

```

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

### Run tests with composer test

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

Run the package test suite.

```bash
composer test
```

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

### Create a plugin by extending BasePlugin

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

Extend BasePlugin to create a Filament plugin. Only declare getId(); the make()/get() factory pair and no-op register()/boot() are inherited.

```php
use JeffersonGoncalves\FilamentPluginCore\BasePlugin;

class MyPlugin extends BasePlugin
{
    public function getId(): string
    {
        return 'my-plugin';
    }
}

```

Tokens:

Raw