Laravel Filament SEO

https://github.com/ralphjsmit/laravel-filament-seo
Admin
A convenient helper package that combines Laravel SEO with Filament Admin and Forms, providing a...
Tokens:11,237
Snippets:77
Trust Score:9.7
License:MIT
Update:6 days ago
Show doc for...
Tokens:
Raw
### Install laravel-filament-seo via Composer

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/README.md

Run this command to install the package. It will also require ralphjsmit/laravel-seo if not already installed. After installation, configure the seo.php config file as per the main package documentation.

```shell
composer require ralphjsmit/laravel-filament-seo
```

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

### Create Post Livewire component with Filament Forms

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/README.md

Example of using the package with stand-alone Filament Forms. This Livewire component creates a new post, wrapping the SEO component in a Card. Remember to call saveRelationships() after creating the model.

```php
<?php

namespace App\Http\Livewire;

use App\Models\Post;
use Filament\Forms\Components\Card;
use Filament\Forms\Components\TextInput;
use Filament\Forms\Concerns\InteractsWithForms;
use Filament\Forms\Contracts\HasForms;
use Illuminate\Contracts\View\View;
use Illuminate\Database\Eloquent\Model;
use Livewire\Component;
use RalphJSmit\Filament\SEO\SEO;

class CreatePost extends Component implements HasForms
{
    use InteractsWithForms;

    public array $data = [];

    public function mount(): void
    {
        $this->form->fill();
    }

    public function render(): View
    {
        return view('livewire.create-post');
    }

    protected function getFormSchema(): array
    {
        return [
            TextInput::make('title'),
            Card::make([
                SEO::make()
            ]),
        ];
    }

    protected function getFormStatePath(): ?string
    {
        return 'data';
    }

    protected function getFormModel(): Model|string|null
    {
        return Post::class;
    }

    public function submitForm()
    {
        $post = Post::create($this->form->getState());

        /** Do not forget this step. */
        $this->form->model($post)->saveRelationships();
    }
}
```

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

### Edit Post Livewire component with Filament Forms

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/README.md

Example of a Livewire component for editing a post using the package with Filament Forms. It fills the form with the post's title and updates the post on submit.

```php
<?php

namespace App\Http\Livewire;

use App\Models\Post;
use Filament\Forms\Components\TextInput;
use Filament\Forms\Concerns\InteractsWithForms;
use Filament\Forms\Contracts\HasForms;
use Illuminate\Contracts\View\View;
use Illuminate\Database\Eloquent\Model;
use Livewire\Component;
use RalphJSmit\Filament\SEO\SEO;
use RalphJSmit\Filament\SEO\Tests\Fixtures\Models\Post;

class EditPost extends Component implements HasForms
{
    use InteractsWithForms;

    public Post $post;

    public function mount(): void
    {
        $this->form->fill([
            'title' => $this->post->title,
        ]);
    }

    public function render(): View
    {
        return view('livewire.edit-post');
    }

    protected function getFormSchema(): array
    {
        return [
            TextInput::make('title'),
            SEO::make(),
        ];
    }

    protected function getFormModel(): Model|string|null
    {
        return $this->post;
    }

    public function submitForm()
    {
        $this->post->update(
            $this->form->getState(),
        );
    }
}
```

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

### Add SEO field to Filament Admin Resource

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/README.md

Example of using the package in classic Filament Admin. Add SEO::make() to the form schema to enable SEO fields for both creating and editing posts.

```php
<?php

namespace App\Filament\Resources;

use App\Filament\Resources;
use App\Models\Post;
use Filament\Forms\Components\TextInput;
use Filament\Resources\Form;
use Filament\Resources\Resource;
use Filament\Resources\Table;
use RalphJSmit\Filament\SEO\SEO;

class PostResource extends Resource
{
    protected static ?string $model = Post::class;
    
    protected static ?string $slug = 'posts';

    protected static ?string $recordTitleAttribute = 'title';

    protected static ?string $navigationGroup = 'Blog';

    protected static ?string $navigationIcon = 'heroicon-o-document-text';

    protected static ?int $navigationSort = 0;

    public static function form(Form $form): Form
    {
        return $form->schema([
            TextInput::make('title'),
            SEO::make(),
        ]);
    }

    public static function table(Table $table): Table
    {
        return $table->columns([ /* */ ]);
    }

    public static function getPages(): array
    {
        return [
            'index' => Resources\PostResource\Pages\ListPosts::route('/'),
            'create' => Resources\PostResource\Pages\CreatePost::route('/create'),
            'edit' => Resources\PostResource\Pages\EditPost::route('{record}/edit'),
        ];
    }
}
```

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

### Add SEO component to Filament form

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/README.md

Use the SEO::make() component within a Filament resource form schema to automatically handle getting and saving SEO data to the seo() relationship without additional configuration.

```php
use Filament\Resources\Form;
use RalphJSmit\Filament\SEO\SEO;

public static function form(Form $form): Form
{
    return $form->schema([
        SEO::make(),
       // .. Your other fields
    ]);
}
```

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

### configurePackage method signature

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/_autodocs/api-reference/filamentseoserviceprovider.md

The exact signature of the configurePackage method, copied verbatim from src/FilamentSEOServiceProvider.php. It takes a Package object and returns void, configuring the package by reference.

```php
public function configurePackage(Package $package): void
```

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

### SEO::make() full method body

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/_autodocs/api-reference/seo.md

Complete implementation of the static factory. Builds a Group with TextInput, Textarea, and Select fields for SEO metadata. Handles state hydration and persistence via afterStateHydrated and saveRelationshipsUsing.

```php
public static function make(array $only = ['title', 'author', 'description', 'robots']): Group
{
    return Group::make(
        Arr::only([
            'title' => TextInput::make('title')
                ->translateLabel()
                ->label(__('filament-seo::translations.title'))
                ->helperText(function (?string $state): string {
                    return (string) Str::of(strlen($state))
                        ->append(' / ')
                        ->append(60 . ' ')
                        ->append(Str::of(__('filament-seo::translations.characters'))->lower());
                })
                ->reactive()
                ->columnSpan(2),
            'author' => TextInput::make('author')
                ->translateLabel()
                ->label(__('filament-seo::translations.author'))
                ->columnSpan(2),
            'description' => Textarea::make('description')
                ->translateLabel()
                ->label(__('filament-seo::translations.description'))
                ->helperText(function (?string $state): string {
                    return (string) Str::of(strlen($state))
                        ->append(' / ')
                        ->append(160 . ' ')
                        ->append(Str::of(__('filament-seo::translations.characters'))->lower());
                })
                ->reactive()
                ->columnSpan(2),
            'robots' => Select::make('robots')
                ->label(__('filament-seo::translations.robots'))
                ->options([
                    'index, follow' => 'Index, Follow',
                    'index, nofollow' => 'Index, Nofollow',
                    'noindex, follow' => 'Noindex, Follow',
                    'noindex, nofollow' => 'Noindex, Nofollow',
                ]),

        ], $only)
    )
        ->afterStateHydrated(function (Group $component, ?Model $record) use ($only): void {
            $component->getChildSchema()->fill(
                $record?->seo?->only($only) ?: []
            );
        })
        ->statePath('seo')
        ->dehydrated(false)
        ->saveRelationshipsUsing(function (Model $record, array $state) use ($only): void {
            $state = collect($state)->only($only)->map(fn ($value) => $value ?: null)->all();

            if ($record->seo && $record->seo->exists) {
                $record->seo->update($state);
            } else {
                $record->seo()->create($state);
            }
        });
}
```

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

### FilamentSEOServiceProvider::configurePackage()

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/_autodocs/index.md

Public method to configure the package. It is called by the package service provider and receives a Package instance for configuration.

```APIDOC
## FilamentSEOServiceProvider::configurePackage()

### Description
Public method to configure the package. It is called by the package service provider and receives a Package instance for configuration.

### Method
Public method

### Signature
`public function configurePackage(Package $package): void`

### Parameters
- **$package** (Package) - Required - The package instance to configure.

### Return Value
- **void** - No return value.
```

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

### Import SEO class

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/_autodocs/api-reference/seo.md

Import the SEO class for use in Filament forms.

```php
use RalphJSmit\Filament\SEO\SEO;
```

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

### SEO::make()

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/_autodocs/api-reference/seo.md

Static factory method that returns a Filament Group component for managing SEO metadata fields. It binds to the 'seo' relationship and handles reading and persisting SEO data internally.

```APIDOC
## `SEO::make()`

### Description
Static factory method that returns a Filament Group component for managing SEO metadata fields. It binds to the 'seo' relationship and handles reading and persisting SEO data internally.

### Method
`SEO::make()`

### Signature
```php
public static function make(array $only = ['title', 'author', 'description', 'robots']): Group
```

### Parameters
- `$only` (array) - Optional - Whitelist of SEO model attributes to render/edit. Allowed keys: `title`, `author`, `description`, `robots`. Unknown keys are silently discarded. Order of rendered fields is fixed: `title → author → description → robots`.

### Return Type
`Filament\Schemas\Components\Group` - A Filament schema Group component. Embed in any Filament `schema()` array. State path is `seo`, exposing `data.seo.{title|author|description|robots}`.

### Usage Example
```php
use RalphJSmit\Filament\SEO\SEO;

// In a Filament form schema:
SEO::make()
```
```

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

### SEO::make()

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/_autodocs/index.md

Static factory method that creates a Filament form Group component for SEO fields. It accepts an optional array of field names to include, defaulting to title, author, description, and robots.

```APIDOC
## SEO::make()

### Description
Static factory method that creates a Filament form Group component for SEO fields. It accepts an optional array of field names to include, defaulting to title, author, description, and robots.

### Method
Static method

### Signature
`public static function make(array $only = ['title', 'author', 'description', 'robots']): Group`

### Parameters
- **$only** (array) - Optional - List of SEO field names to include. Defaults to `['title', 'author', 'description', 'robots']`.

### Return Value
- **Group** - A Filament form Group component.

### Usage Example
```php
use RalphJSmit\Filament\SEO\SEO;

SEO::make();
```
```

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

### Basic use in Filament Admin Resource

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/_autodocs/api-reference/seo.md

Place SEO::make() in a Filament Resource's form to enable SEO fields for both create and edit pages without additional wiring. The model must use the HasSEO trait.

```php
<?php

namespace App\Filament\Resources;

use App\Filament\Resources\PostResource\Pages;
use App\Models\Post;
use Filament\Resources\Form;
use Filament\Resources\Resource;
use Filament\Forms\Components\TextInput;
use RalphJSmit\Filament\SEO\SEO;

class PostResource extends Resource
{
    protected static ?string $model = Post::class;

    public static function form(Form $form): Form
    {
        return $form->schema([
            TextInput::make('title'),
            SEO::make(),
            // .. other fields
        ]);
    }

    public static function getPages(): array
    {
        return [
            'index' => Pages\ListPosts::route('/'),
            'create' => Pages\CreatePost::route('/create'),
            'edit' => Pages\EditPost::route('{record}/edit'),
        ];
    }
}
```

```php
use Illuminate\Database\Eloquent\Model;
use RalphJSmit\Laravel\SEO\Support\HasSEO;

class Post extends Model
{
    use HasSEO;
}
```

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

### Manual provider registration in config/app.php

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/_autodocs/api-reference/filamentseoserviceprovider.md

Shows how to manually register the service provider in config/app.php under 'providers' when auto-discovery is disabled via extra.laravel.dont-discover. The provider class is added to the providers array.

```php
'providers' => [
    // ...
    RalphJSmit\Filament\SEO\FilamentSEOServiceProvider::class,
],
```

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

### Restrict managed fields with $only

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/_autodocs/api-reference/seo.md

Pass an array of field names to SEO::make() to render only those fields; other SEO attributes are skipped on hydration and left untouched on save.

```php
use RalphJSmit\Filament\SEO\SEO;

return $form->schema([
    SEO::make(['title', 'description']), // author and robots are omitted
]);
```

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

### Stand-alone Filament Forms - creating a record (Livewire)

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/_autodocs/api-reference/seo.md

When using SEO outside a Resource, the relationship must be saved explicitly after the record is created. The submitForm() method calls saveRelationships() to trigger saveRelationshipsUsing().

```php
<?php

namespace App\Http\Livewire;

use App\Models\Post;
use Filament\Forms\Components\Card;
use Filament\Forms\Components\TextInput;
use Filament\Forms\Concerns\InteractsWithForms;
use Filament\Forms\Contracts\HasForms;
use Illuminate\Contracts\View\View;
use Illuminate\Database\Eloquent\Model;
use Livewire\Component;
use RalphJSmit\Filament\SEO\SEO;

class CreatePost extends Component implements HasForms
{
    use InteractsWithForms;

    public array $data = [];

    public function mount(): void
    {
        $this->form->fill();
    }

    public function render(): View
    {
        return view('livewire.create-post'); // {{ $this->form }}
    }

    protected function getFormSchema(): array
    {
        return [
            TextInput::make('title'),
            Card::make([
                SEO::make(),
            ]),
        ];
    }

    protected function getFormStatePath(): ?string
    {
        return 'data';
    }

    protected function getFormModel(): Model|string|null
    {
        return Post::class;
    }

    public function submitForm(): void
    {
        $post = Post::create($this->form->getState());

        // Do not forget this step: it triggers saveRelationshipsUsing().
        $this->form->model($post)->saveRelationships();
    }
}
```

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

### SEO::make(array $only)

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/_autodocs/configuration.md

Creates a Filament form Group containing SEO fields. The $only parameter whitelists which SEO attributes to render and persist.

```APIDOC
## SEO::make(array $only)

### Description
Creates a Filament form Group containing SEO fields. The `$only` parameter whitelists which SEO attributes to render and persist.

### Method
Static factory method

### Signature
```php
public static function make(array $only = ['title', 'author', 'description', 'robots']): Group
```

### Parameters
#### Parameters
- **$only** (array) - Optional - Whitelist of SEO attributes to render and persist. Effective keys: `title`, `author`, `description`, `robots`. Any other keys are filtered out and have no effect. Field render order is fixed (`title → author → description → robots`), independent of `$only` order.

### Return Value
Returns a Filament `Group` instance containing the selected SEO fields.

### Behavior
- Only the listed fields are built into the returned `Group` (via `Arr::only($map, $only)`).
- Hydration fills only those fields from `$record->seo->only($only)`.
- Persistence writes only those attributes: `collect($state)->only($only)` — restricted attributes are left untouched on the existing SEO model and omitted from `create()`.

### Notes
- The character-count thresholds (`60` for title, `160` for description), the `reactive()` flags, the `columnSpan(2)` values, the `statePath('seo')`, and the `dehydrated(false)` behavior are all hard-coded in `src/SEO.php` and not configurable.
- The `robots` field is a `Select` with fixed stored values and labels (not translatable).
```

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

### FilamentSEOServiceProvider class declaration

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/_autodocs/api-reference/filamentseoserviceprovider.md

The full service provider class that extends Spatie\LaravelPackageTools\PackageServiceProvider. It configures the package with name 'laravel-filament-seo' and registers translations via hasTranslations(). No migrations, config, routes, or additional bindings are declared.

```php
<?php

namespace RalphJSmit\Filament\SEO;

use Spatie\LaravelPackageTools\Package;
use Spatie\LaravelPackageTools\PackageServiceProvider;

class FilamentSEOServiceProvider extends PackageServiceProvider
{
    public function configurePackage(Package $package): void
    {
        $package
            ->name('laravel-filament-seo')
            ->hasTranslations();
    }
}
```

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

### Stand-alone Filament Forms - editing a record

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/_autodocs/api-reference/seo.md

For editing, bind the form to the existing model instance. Note that SEO::make() sets statePath('seo'), so the submittable state is namespaced under 'seo' (e.g., data.seo.title).

```php
class EditPost extends Component implements HasForms
{
    use InteractsWithForms;

    public Post $post;
    public array $data = [];

    public function mount(): void
    {
        $this->form->fill([
            'title' => $this->post->title,
        ]);
    }

    protected function getFormSchema(): array
    {
        return [
            TextInput::make('title'),
            SEO::make(),
        ];
    }

    protected function getFormModel(): Model|string|null
    {
        return $this->post;
    }

    protected function getFormStatePath(): ?string
    {
        return 'data';
    }

    public function submitForm(): void
    {
        $this->post->update($this->form->getState());
    }
}
```

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

### Composer extra.laravel auto-discovery configuration

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/_autodocs/api-reference/filamentseoserviceprovider.md

The composer.json extra.laravel block that registers the service provider for Laravel auto-discovery. It includes the provider class and an empty aliases array, so no manual registration in config/app.php is needed unless auto-discovery is disabled.

```json
"extra": {
    "laravel": {
        "providers": [
            "RalphJSmit\\Filament\\SEO\\FilamentSEOServiceProvider"
        ],
        "aliases": []
    }
}
```

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

### SEO::make() return type Group

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/_autodocs/types.md

Public static method returning a Filament Group component. The $only parameter defaults to ['title', 'author', 'description', 'robots'].

```php
public static function make(array $only = ['title', 'author', 'description', 'robots']): Group
```

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

### Model using HasSEO trait

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/_autodocs/types.md

Required for SEO::make() to work. The form model must use the HasSEO trait from ralphjsmit/laravel-seo (^1.7) to satisfy the record contract.

```php
use RalphJSmit\Laravel\SEO\Support\HasSEO;

class Post extends Model
{
    use HasSEO;
}
```

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

### Use HasSEO trait on Eloquent Model

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/README.md

Add the HasSEO trait to your Eloquent model to enable SEO functionality. This is required before using the SEO::make() helper.

```php
class Post extends Model
{
    use HasSEO;
}
```

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

### saveRelationshipsUsing closure with Model and array

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/_autodocs/types.md

Closure registered via ->saveRelationshipsUsing(...) in SEO::make(). Receives a Model record and state array.

```php
->saveRelationshipsUsing(function (Model $record, array $state) use ($only): void {
```

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

### afterStateHydrated closure with Group and ?Model

Source: https://github.com/ralphjsmit/laravel-filament-seo/blob/main/_autodocs/types.md

Closure registered via ->afterStateHydrated(...) in SEO::make(). Receives the Group component and optional Model record.

```php
->afterStateHydrated(function (Group $component, ?Model $record) use ($only): void {
```
Tokens:
Raw