rankbeam / laravel-seo-filament
Filament 4/5 form components for the Rankbeam Laravel SEO core - SEO section with live character counters, search-snippet preview, and manual-vs-fallback indicators.
Requires
- php: ^8.2
- filament/filament: ^4.0|^5.0
- rankbeam/laravel-seo: ^2.0 || ^3.0
Requires (Dev)
- laravel/pint: ^1.0
- orchestra/testbench: ^9.0|^10.0|^11.0
- pestphp/pest: ^3.0
This package is auto-updated.
Last update: 2026-07-04 09:44:12 UTC
README
Filament form components for the Rankbeam Laravel SEO core (rankbeam/laravel-seo).
Adds a complete, production-pattern SEO section to any Filament resource form:
- SEO title & description with live character counters — thresholds (60/160) come from
the core
SEOWarningEvaluator, so the admin UI and the audit layer can never disagree. - Canonical URL field (empty = automatic canonical, query string stripped).
- Robots directive select (empty = site default).
- Social sharing image upload (og:image / twitter:image).
- Editorial live preview with a Google SERP tab and a social card tab — title, description and URL update as you type, social-image dimensions are checked against the shared thresholds (min 200×200 / ideal 1200×630), and a broken remote image degrades to a placeholder instead of breaking the form. Mirrors the resolver's fallback chain.
- Manual-vs-fallback indicators: a per-field panel showing the effective value and the resolver layer that produced it (Manual / Content fallback / Model-type default / Global default / Site config / Derived from URL).
Values persist to the core package's seo_meta record via the HasSEO trait's
relationship — no extra columns on your tables.
Requirements
| Dependency | Version |
|---|---|
| PHP | 8.2 – 8.4 |
| Filament | 4.x or 5.x (both tested in CI; the test suite passes unchanged on both) |
| Core package | rankbeam/laravel-seo ^2.0 || ^3.0 |
Core 2 installs are supported under this constraint: when the newer
seoMetaForLocale() helper is not available, the forms hydrate through the
older seoMeta() relation.
Installation
composer require rankbeam/laravel-seo-filament
Installing this package pulls in the core (rankbeam/laravel-seo). If you have
not set the core up yet:
php artisan vendor:publish --tag=seo-config php artisan migrate
Contributing / local development: the repo consumes the core via a sibling path repository (
../laravel-seo); CI checks out both repositories side by side.
Usage
The model behind your resource must use the core HasSEO trait:
use Rankbeam\Seo\Traits\HasSEO; class Post extends Model { use HasSEO; }
Then add the section to the resource — two lines:
use Rankbeam\Seo\Filament\Concerns\HasSEOFields; class PostResource extends Resource { use HasSEOFields; // 1 public static function form(Schema $schema): Schema { return $schema->components([ TextInput::make('title'), // ... static::seoSection(), // 2 ]); } }
static::seoSection(['title', 'description']) limits the section to a subset of fields
(title, description, focus_keywords, canonical, robots, og_image).
The tabbed Google/social preview is shown by default. Pass showPreview: false to omit it
(the source-indicators panel is unaffected):
static::seoSection(showPreview: false); // or SEOFields::make(showPreview: false)
Without the trait, SEOFields::make() returns the same section directly.
Upgrading: the preview view was replaced by the tabbed editor. If you published the package views, refresh or remove the stale copy — see
UPGRADING.md.
Structured data (optional)
Add a second, optional section so editors can attach schema.org JSON-LD without code:
static::seoSchemaSection(), // or SEOSchemaFields::make()
It writes into the core seo_meta.schema_jsonld column and is pure UI binding over the
core schema builders — a one-toggle automatic breadcrumb
(BreadcrumbSchema::fromModelAncestors()) plus a repeater of FAQ (FAQSchema) and
Product (ProductSchema) blocks. Every built document is validated by the core
SchemaValidator; a malformed block (e.g. a Product with no offer) is rejected on save.
Schema it can't represent (a hand-authored @graph, an exotic @type, richer Product
fields) is preserved verbatim. See the
Filament fields guide for details.
Testing
composer update --with "filament/filament:~4.0" && vendor/bin/pest # Filament 4 leg composer update --with "filament/filament:~5.0" && vendor/bin/pest # Filament 5 leg
The suite covers render, live counter states, create + edit save round-trips
(including og:image upload), field clearing, URL validation, source-indicator
attribution for every resolver layer, focus-keyword round-trips, the editorial
preview (SERP + social tabs, the showPreview opt-out, the server-side preview
payload — manual-vs-fallback image source, known-local dimension measurement,
remote-image deferral, and shared-threshold warnings), and the structured-data
editor (FAQ / Product build + round-trip, automatic breadcrumb, validation
rejection, optimistic-concurrency reconciliation, and custom-schema preservation).
Testbench note (provider order)
If you boot Filament in orchestra/testbench yourself, register Filament's
SupportServiceProvider before LivewireServiceProvider. Filament rebinds Livewire's
DataStore (which drops Livewire's registered instance); only Livewire's later mechanism
registration pins the resolved override as the shared instance. Package discovery produces
this order naturally in a real app — a hand-rolled provider list might not. The symptom of
getting it wrong is ViewErrorBag::put(): Argument #2 ($bag) must be of type MessageBag, null given on every Livewire test.
License
MIT — see LICENSE.md.