README

This package adds a way to make all filament inputs translatable. It uses the spatie/laravel-translatable package in the back.

Installation

First install and configure your model(s) to use the spatie/laravel-translatable package.

You can install the package via composer:

composer require zakafk/filament-translatable-select

Add the plugin to your desired Filament panel:

use Zakafk\FilamentTranslatableSelect\Filament\Plugins\FilamentTranslatableSelectPlugin;

class FilamentPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // ...
            ->plugins([
                FilamentTranslatableSelectPlugin::make(),
            ]);
    }
}

You can specify the supported locales:

use Zakafk\FilamentTranslatableSelect\Filament\Plugins\FilamentTranslatableSelectPlugin;

class FilamentPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // ...
            ->plugins([
                FilamentTranslatableSelectPlugin::make()
                    ->supportedLocales([
                        'en' => 'English',
                        'ka' => 'Georgia',
                    ])
                    ->setLocaleHidden(false),
            ]);
    }
}

By default, the package will use the app.locale if you don't specify the locales.

Combining with the official spatie-laravel-translatable-plugin?

This package is a replacement for the official on the create and edit pages only. If you are already using the official package, you will have to delete the use Translatable trait and the LocaleSwitcher header action from those pages:

-use Filament\Actions\LocaleSwitcher;
-use Filament\Resources\Pages\EditRecord\Concerns\Translatable;

class EditPage extends EditRecord
{
-    use Translatable;

    protected function getHeaderActions(): array
    {
        return [
-            LocaleSwitcher::make(),
            DeleteAction::make(),
        ];
    }
}

Usage

You can simply add ->translatable() to any field to make it translatable.

use Filament\Forms\Components\TextInput;

TextInput::make('name')
    ->label('Name')
    ->translatable(),

Disable translations dynamically

If you want to disable translations dynamically, you can set the first parameter of the ->translatable() function to true or false.

use Filament\Forms\Components\TextInput;

TextInput::make('name')
    ->label('Name')
    ->translatable(false),

Overwrite locales

If you want to overwrite the locales on a specific field you can set the locales through the second parameter of the ->translatable() function.

use Filament\Forms\Components\TextInput;

TextInput::make('name')
    ->label('Name')
    ->translatable(true, ['en' => 'English', 'ka' => 'Georgia', 'fr' => 'French']),

Locale specific validation rules

You can add locale specific validation rules with the third parameter of the ->translatable() method.

use Filament\Forms\Components\TextInput;

TextInput::make('name')
    ->label('Name')
    ->translatable(true, null, [
        'en' => ['required', 'string', 'max:255'],
        'ka' => ['nullable', 'string', 'max:255'],
    ]);

Good to know / caveats

->translatable() must be the last call in the chain. It does not return the field: it substitutes it with a Filament\Schemas\Components\Flex that holds one clone of the field per locale plus the locale selector.

// ✅ correct
TextInput::make('name')->label('Name')->maxLength(255)->translatable()

// ❌ throws BadMethodCallException — Flex has no maxLength()
TextInput::make('name')->translatable()->maxLength(255)

Everything chained before ->translatable() is applied to the field itself and is therefore copied to every locale clone. columnSpan() and columnStart() are additionally forwarded to the wrapping Flex, so the field keeps its place in the grid.

Every locale is always rendered and dehydrated. Switching locales is a purely client-side operation (Filament's visibleJs()), so it costs no network request and never drops the values of the locales that are off screen.

Validation errors of hidden locales stay visible. Each locale clone gets a validationAttribute suffixed with the locale (e.g. Name (English)), errors of a locale that is not on screen are summarised underneath the field, and the locale selector marks affected locales with a ⚠.

The active locale lives in the form state under __translatable_locale_{field}. It is never dehydrated, so it never reaches your model.

Translations

The locale selector is labelled for screen readers only. If you need to translate or override that label, publish the language files:

php artisan vendor:publish --tag="filament-translatable-select-translations"

Laravel support

Laravel Version	Package version
^11.0	^1.0.2, ^2.0.0
^10.0	^1.0.0, ^2.0.0

Changelog

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

License

MIT License (MIT). Read the License File for more information.

zakafk / filament-translatable-select

Package info

Security

Statistics