Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ralphjsmit/laravel-filament-seo
A package to combine the power of Laravel SEO and Filament Admin.
https://github.com/ralphjsmit/laravel-filament-seo
Last synced: 3 months ago
JSON representation
A package to combine the power of Laravel SEO and Filament Admin.
- Host: GitHub
- URL: https://github.com/ralphjsmit/laravel-filament-seo
- Owner: ralphjsmit
- License: mit
- Created: 2022-02-04T08:55:36.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-08T04:47:15.000Z (4 months ago)
- Last Synced: 2024-07-19T13:03:13.713Z (4 months ago)
- Language: PHP
- Homepage:
- Size: 13.6 MB
- Stars: 117
- Watchers: 1
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
- awesome-filament - ralphjsmit/laravel-filament-seo - A package to combine the power of Laravel SEO and Filament Admin. (Integrations)
README
# Combine the power of Laravel SEO and Filament PHP.
This package is a **convenient helper for using the [laravel-seo](https://github.com/ralphjsmit/laravel-seo) package** with [Filament Admin and Forms](https://filamentphp.com).
It provides a simple component that returns a Filament fieldgroup to modify the `title`, `author` and `description` fields of the SEO model. It automatically **takes care of getting and saving all the data** to the `seo()` relationship, and you can thus use it anywhere, **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
]);
}
```
Here's an example of how the `SEO` component looks like:
## Installation
First, install the packages:
```shell
composer require ralphjsmit/laravel-filament-seo
```
This will the require the `ralphjsmit/laravel-seo` as well if you didn't have that installed. Be sure to [check out the documentation of the main package](https://github.com/ralphjsmit/laravel-seo) and configure the values in the special `seo.php` config file!
Next, make sure that the **Eloquent Model** you're editing **uses the `HasSEO` trait**:
```php
class Post extends Model
{
use HasSEO;
}
```
Now the **`SEO::make()` helper is available to use anywhere** you want. Below are several examples how to use it:
### In Filament Admin
This is an example of **using this package in the classic [Filament Admin](https://filamentphp.com/docs/2.x/admin/installation)**.
It works for **both creating and editing posts**:
```php
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'),
];
}
}
```
### With Filament Forms
You can also **use this package with the stand-alone [Filament Forms](https://filamentphp.com/docs/2.x/forms/installation)** package.
This is a simple example of **how to setup a Livewire component that creates a new post**. In this example, I wrapped the `SEO` component in a Card.
```php
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();
}
}
```
And here's an example of how a **Livewire component for editing a post** might like like:
```php
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(),
);
}
}
```
## General
🐞 If you spot a bug, please submit a detailed issue and I'll try to fix it as soon as possible.
🔐 If you discover a vulnerability, please review [our security policy](../../security/policy).
🙌 If you want to contribute, please submit a pull request. All PRs will be fully credited. If you're unsure whether I'd accept your idea, feel free to contact me!
🙋♂️ [Ralph J. Smit](https://ralphjsmit.com)