Search by

levgenij / filament-translatable

Levgenij

Automatic translation support for Filament Resources based on levgenij/laravel-translatable

Package info

github.com/Levgenij/filament-translatable

Homepage

pkg:composer/levgenij/filament-translatable

Statistics

Installs: 149

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

3.1.1 2026-10-04 21:19 UTC

This package is auto-updated.

Last update: 2026-10-04 21:20:30 UTC


README

Latest Version on Packagist License

Seamless multilingual support for Filament Resources with automatic translatable field generation based on levgenij/laravel-translatable.

Filament Translatable Screenshot

πŸ“¦ Version Compatibility

Please install the version that matches your Filament version:

Filament Version Package Version Branch Installation
Filament v5.x ^2.0 main composer require levgenij/filament-translatable:^2.0
Filament v3/v4 ^1.0 v1 composer require levgenij/filament-translatable:^1.0

Note: This documentation is for Filament v5. If you are using Filament v3 or v4, please switch to the v1 documentation.

Features

  • Zero Configuration - Translatable fields are detected automatically from the model
  • Language Tabs - Fields are grouped into tabs for each locale
  • Locale Badges - Visual indicators next to field labels: Title [EN]
  • Missing Translation Badge - Locale tabs with only blank fields are marked with a badge
  • Clean Form Schema - No wrappers or special syntax needed
  • Single Locale Mode - No tabs or badges when only one locale is configured
  • Filament 5 - Built for Filament 5 (Schema API)

Requirements

  • PHP 8.2+
  • Laravel 11+
  • Filament 5.0+
  • levgenij/laravel-translatable 3.0+

Installation

Install the package via Composer:

composer require levgenij/filament-translatable

The package will auto-register its service provider.

Publish Configuration (Optional)

php artisan vendor:publish --tag=filament-translatable-config

Quick Start

1. Configure Your Model

Your model must use the Translatable trait from levgenij/laravel-translatable:

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Levgenij\LaravelTranslatable\Translatable;

class Category extends Model
{
    use Translatable;

    protected $fillable = [
        'parent_id',
        'is_active',
        'sort',
        // Translatable fields must also be in fillable
        'title',
        'slug',
        'description',
    ];

    /**
     * Translatable attributes.
     */
    public array $translatable = [
        'title',
        'slug',
        'description',
        'meta_title',
        'meta_description',
    ];
}

2. Add Trait to Resource

<?php

namespace App\Filament\Resources;

use Filament\Schemas\Schema;
use Filament\Schemas\Components\Section;
use Filament\Forms\Components\TextInput;
use Filament\Forms\Components\Textarea;
use Filament\Forms\Components\Toggle;
use Filament\Forms\Components\Select;
use Filament\Resources\Resource;
use Levgenij\FilamentTranslatable\Concerns\TranslatableResource;

class CategoryResource extends Resource
{
    use TranslatableResource;

    protected static ?string $model = Category::class;

    public static function form(Schema $schema): Schema
    {
        return $schema->components([
            Section::make()->schema([
                // Translatable fields (detected from $model->translatable)
                TextInput::make('title')
                    ->label('Title')
                    ->required(),

                TextInput::make('slug')
                    ->label('Slug'),

                Textarea::make('description')
                    ->label('Description'),

                // Non-translatable fields (remain unchanged)
                Toggle::make('is_active')
                    ->label('Active'),

                Select::make('parent_id')
                    ->label('Parent Category')
                    ->options(fn () => Category::pluck('title', 'id')),
            ]),
        ]);
    }
}

3. Add Trait to Create/Edit Pages

CreateRecord:

<?php

namespace App\Filament\Resources\CategoryResource\Pages;

use App\Filament\Resources\CategoryResource;
use Filament\Resources\Pages\CreateRecord;
use Levgenij\FilamentTranslatable\Concerns\HasTranslatableFields;

class CreateCategory extends CreateRecord
{
    use HasTranslatableFields;

    protected static string $resource = CategoryResource::class;
}

EditRecord:

<?php

namespace App\Filament\Resources\CategoryResource\Pages;

use App\Filament\Resources\CategoryResource;
use Filament\Resources\Pages\EditRecord;
use Levgenij\FilamentTranslatable\Concerns\HasTranslatableFields;

class EditCategory extends EditRecord
{
    use HasTranslatableFields;

    protected static string $resource = CategoryResource::class;
}

That's it! Your form will now automatically display translatable fields in language tabs.

Configuration

Locales

By default, the package reads locales from config/translatable.php (the parent package). You can override this in config/filament-translatable.php:

<?php

return [
    // Detailed format
    'locales' => [
        'en' => ['name' => 'En', 'native' => 'English'],
        'uk' => ['name' => 'Uk', 'native' => 'ΡƒΠΊΡ€Π°Ρ—Π½ΡΡŒΠΊΠ°'],
        'de' => ['name' => 'De', 'native' => 'Deutsch'],
    ],

    // Or simple array format
    'locales' => ['en', 'uk', 'de'],
];

Badge Style

Customize the locale badge appearance:

'badge_style' => 'display: inline-flex; padding: 2px 6px; font-size: 10px; background-color: #3b82f6; color: white; border-radius: 4px;',

Tab Label Format

Placeholders: {CODE} (uppercase locale code), {code} (lowercase locale code), {name} (native locale name).

'tab_label_format' => '{CODE} - {name}',

Missing Translation Badge

A locale tab whose fields are all blank gets a badge with a "No translation" tooltip. Blank is decided by the same Blank Values rules as saving, applied to the field state with casts (a RichEditor document is checked as HTML). Field callbacks that run only on save, such as dehydrateStateUsing() or dehydrated(false), are not applied to the badge.

'missing_translation_badge' => [
    'enabled' => true,
    'label' => 'β€’',
    // Any Filament color name
    'color' => 'warning',
],

The marked tab also gets a data-missing-translation attribute. Filament adds the tab attributes to the tab button, the overflow dropdown item and the tab panel, so target the button to restyle the badge:

.fi-tabs-item[data-missing-translation] > .fi-badge {
    /* ... */
}

The tooltip text comes from the filament-translatable::translations.missing_translation translation key (English and Ukrainian are included). Override it with php artisan lang:publish or in lang/vendor/filament-translatable/{locale}/translations.php.

Blank Values

A locale whose fields are all blank is not stored, and on edit its existing row is removed. Define what counts as blank:

'blank' => [
    // Set to true to treat HTML markup without text ("<p></p>", "<p><br></p>") as blank.
    // An empty RichEditor submits "<p></p>", so enable this when forms use it.
    'strip_tags' => false,
    // Used with strip_tags: tags that count as content even without text
    'content_tags' => ['img', 'iframe', 'video', 'audio', 'embed', 'object', 'svg'],
    // Characters ignored when looking for text (non-breaking space, zero-width space)
    'invisible_characters' => ["\u{00A0}", "\u{200B}"],
],

With strip_tags enabled, RichEditor custom blocks (<div data-type="customBlock">) and mentions (<span data-type="mention">) have no text, so a locale with only them is blank. Add div or span to content_tags when forms use them.

The same rules are available as TranslatableSchemaTransformer::isBlank($value).

How It Works

Architecture

src/
β”œβ”€β”€ Concerns/
β”‚   β”œβ”€β”€ TranslatableResource.php      # Trait for Resource class
β”‚   └── HasTranslatableFields.php     # Trait for Create/Edit pages
β”œβ”€β”€ Support/
β”‚   └── TranslatableSchemaTransformer.php  # Form schema transformation
└── FilamentTranslatableServiceProvider.php

Data Flow

  1. Resource - The TranslatableResource trait provides the getTranslatableAttributes() method that reads the model's $translatable property.

  2. Page - The HasTranslatableFields trait intercepts the form() method and transforms the schema:

    • Finds fields that exist in $model->translatable
    • Groups them into language tabs (when multiple locales)
    • Adds locale badges to labels
    • Non-translatable fields remain unchanged
  3. Loading - The edit form shows only stored translation rows. A locale without a stored row stays empty: no fallback locale and no model accessors are applied.

  4. Saving - The trait automatically:

    • Extracts translation data from the form
    • Saves them via $model->saveTranslation($locale, $data)
    • Skips a locale whose fields are all blank (see Blank Values) and deletes its existing row

Form Data Structure

Data in the form is stored in this structure:

[
    // Non-translatable
    'is_active' => true,
    'parent_id' => 1,

    // Translatable
    'translations' => [
        'en' => [
            'title' => 'English Title',
            'slug' => 'english-title',
            'description' => 'English description',
        ],
        'uk' => [
            'title' => 'Ukrainian Title',
            'slug' => 'ukrainian-title',
            'description' => 'Ukrainian description',
        ],
    ],
]

UI Behavior

Multiple Languages

When multiple languages are configured, translatable fields are grouped into tabs:

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚  [EN - English]  [UK - ΡƒΠΊΡ€Π°Ρ—Π½ΡΡŒΠΊΠ°]              β”‚
β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€
β”‚  Title [EN]                                     β”‚
β”‚  β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”   β”‚
β”‚  β”‚ Product Name                             β”‚   β”‚
β”‚  β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜   β”‚
β”‚                                                 β”‚
β”‚  Description [EN]                               β”‚
β”‚  β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”   β”‚
β”‚  β”‚ Product description text...              β”‚   β”‚
β”‚  β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜   β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

β”‚  Is Active                                      β”‚
β”‚  [βœ“]                                            β”‚

Single Language

When only one language is configured:

  • Tabs are not shown
  • Badges are not shown
  • Fields are displayed normally

Advanced Usage

Overriding mutateFormDataBeforeFill

If you need additional logic when filling the form:

class EditCategory extends EditRecord
{
    use HasTranslatableFields;

    protected function mutateFormDataBeforeFill(array $data): array
    {
        // First call parent method to load translations
        $data = parent::mutateFormDataBeforeFill($data);

        // Your additional logic
        $data['custom_field'] = $this->record->computeSomething();

        return $data;
    }
}

Overriding mutateFormDataBeforeCreate/Save

class CreateCategory extends CreateRecord
{
    use HasTranslatableFields;

    protected function mutateFormDataBeforeCreate(array $data): array
    {
        // Your logic before creation
        if (! empty($data['image'])) {
            $data['image'] = $this->processImage($data['image']);
        }

        return $data;
    }
}

Custom Validation

Validation works as expected. Field rules are copied to every locale tab.

unique() on a translatable field checks the translations table and is scoped to the field locale. With ignoreRecord: true the edited record's own translation is ignored:

use Filament\Schemas\Schema;
use Filament\Forms\Components\TextInput;

public static function form(Schema $schema): Schema
{
    return $schema->components([
        TextInput::make('slug')
            ->required()
            ->maxLength(255)
            ->unique(ignoreRecord: true), // unique per locale in categories_translations
    ]);
}

The rule is only rewritten when it targets the model table and the field's own column (the default, or column set to the attribute name). With another table or column, or with a rule object passed to rule(), the rule is used as written.

Database Structure

The package works with levgenij/laravel-translatable which uses separate translation tables:

categories                    categories_translations
β”Œβ”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”   β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”
β”‚ id β”‚ is_active β”‚ parent β”‚   β”‚ category_id β”‚ locale β”‚ title          β”‚ slug  β”‚
β”œβ”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€   β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€
β”‚ 1  β”‚ true      β”‚ null   β”‚   β”‚ 1           β”‚ en     β”‚ Electronics    β”‚ elec  β”‚
β”‚ 2  β”‚ true      β”‚ 1      β”‚   β”‚ 1           β”‚ uk     β”‚ Π•Π»Π΅ΠΊΡ‚Ρ€ΠΎΠ½Ρ–ΠΊΠ°    β”‚ elek  β”‚
β””β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”˜   β”‚ 2           β”‚ en     β”‚ Phones         β”‚ phone β”‚
                              β”‚ 2           β”‚ uk     β”‚ Π’Π΅Π»Π΅Ρ„ΠΎΠ½ΠΈ       β”‚ tel   β”‚
                              β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”˜

Troubleshooting

Fields are not transformed

Make sure that:

  1. Resource has use TranslatableResource;
  2. Page has use HasTranslatableFields;
  3. Model has $translatable property with correct fields
  4. Model uses use Levgenij\LaravelTranslatable\Translatable

Translations are not saved

Make sure that:

  1. Table {table}_translations exists
  2. Fields are in model's $fillable
  3. Fields are in model's $translatable

Error "Call to undefined method saveTranslation"

Model does not use the Levgenij\LaravelTranslatable\Translatable trait.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security-related issues, please email levgenij@example.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.