tomatophp / filament-translations
Manage your translation with DB and cache, you can scan your languages tags like trans(), __(), and get the string inside and translate them use UI.
Fund package maintenance!
3x1io
Installs: 5 854
Dependents: 3
Suggesters: 0
Security: 0
Stars: 42
Watchers: 2
Forks: 16
Open Issues: 0
Requires
- php: ^8.1|^8.2
- filament/filament: ^3.2
- filament/notifications: ^3.2
- maatwebsite/excel: ^3.1
- spatie/laravel-translation-loader: ^2.7
- tomatophp/console-helpers: ^1.1
- tomatophp/filament-developer-gate: ^1.0
- tomatophp/filament-translation-component: ^1.0
Requires (Dev)
- laravel/pint: ^1.18
- livewire/livewire: ^2.10|^3.0
- nunomaduro/larastan: ^2.9
- orchestra/testbench: ^9.5
- pestphp/pest: ^2.36
- pestphp/pest-plugin-laravel: ^2.4
- pestphp/pest-plugin-livewire: ^2.1
- phpstan/extension-installer: ^1.4
- phpstan/phpstan-deprecation-rules: ^1.2
- phpstan/phpstan-phpunit: ^1.4
This package is auto-updated.
Last update: 2024-11-08 20:59:17 UTC
README
Filament Translations Manager
Manage your translation with DB and cache, you can scan your languages tags like trans()
, __()
, and get the string inside and translate them use UI.
this plugin is build in spatie/laravel-translation-loader
Screenshots
Installation
composer require tomatophp/filament-translations
now run install command
php artisan filament-translations:install
Finally register the plugin on /app/Providers/Filament/AdminPanelProvider.php
$panel->plugin(\TomatoPHP\FilamentTranslations\FilamentTranslationsPlugin::make())
Extensions
Allow Create Button to Create New Language
If you want to allow the user to create a new language, you need to add the following to your panel provider:
$panel->plugin(\TomatoPHP\FilamentTranslations\FilamentTranslationsPlugin::make()->allowCreate())
Allow Clear All Translations Button
If you want to allow the user to clear all translations, you need to add the following to your panel provider:
$panel->plugin(\TomatoPHP\FilamentTranslations\FilamentTranslationsPlugin::make()->allowClearTranslations())
Use Language Switcher
we move language switcher to another package you can check it Filament Language Switcher
Scan Using Command Line
You can scan your project to get all the languages tags and save them to the database
php artisan filament-translations:import
Change Scan to work on Queue
In your config file just change the use_queue_on_scan
to true
'use_queue_on_scan' => true,
Custom Import Command
You can create your own command to import the translations, add your custom import class to the config file like this:
'path_to_custom_import_command' => ImportTranslations::class,
This command will automatically run when you click on the "Scan For New Languages" button in the UI.
Custom Excel Import
You can create your own Excel import to import the translations, add your custom import class to the config file like this:
'path_to_custom_excel_import' => CustomTranslationImport::class,
The import class is based on the Laravel Excel package. You can check the documentation here. This import will automatically run when you click on the "Import" button in the UI.
Custom Excel Export
You can create your own Excel export to export the translations in your own format, add your custom export class to the config file like this:
'path_to_custom_excel_export' => CustomTranslationExport::class,
The export class is based on the Laravel Excel package. You can check the documentation here. This import will automatically run when you click on the "Export" button in the UI.
Show or hide buttons in the UI
You can show or hide the buttons in the UI by changing the config file. By default, all buttons are shown.
'show_import_button' => true, 'show_export_button' => false, 'show_scan_button' => false ,
Custom Resource
You can create your own resource to show the translations in the UI, add your custom resource class to the config file like this:
'translation_resource' => CustomResource::class,
This is especially useful when you want to have complete control over the UI but still want to use the translations package. Think about implementing a check on user roles when using shouldRegisterNavigation
in your custom resource.
Translation Translations Resource Hooks
we have add a lot of hooks to make it easy to attach actions, columns, filters, etc
Table Columns
use TomatoPHP\FilamentTranslations\Filament\Resources\TranslationResource\Table\TranslationTable; public function boot() { TranslationTable::register([ \Filament\Tables\Columns\TextColumn::make('something') ]); }
Table Actions
use TomatoPHP\FilamentTranslations\Filament\Resources\TranslationResource\Table\TranslationActions; public function boot() { TranslationActions::register([ \Filament\Tables\Actions\ReplicateAction::make() ]); }
Table Filters
use TomatoPHP\FilamentTranslations\Filament\Resources\TranslationResource\Table\TranslationFilters; public function boot() { TranslationFilters::register([ \Filament\Tables\Filters\SelectFilter::make('something') ]); }
Table Bulk Actions
use TomatoPHP\FilamentTranslations\Filament\Resources\TranslationResource\Table\TranslationBulkActions; public function boot() { TranslationBulkActions::register([ \Filament\Tables\BulkActions\DeleteAction::make() ]); }
From Components
use TomatoPHP\FilamentTranslations\Filament\Resources\TranslationResource\Form\TranslationForm; public function boot() { TranslationForm::register([ \Filament\Forms\Components\TextInput::make('something') ]); }
Page Actions
use TomatoPHP\FilamentTranslations\Filament\Resources\TranslationResource\Actions\ManagePageActions; use TomatoPHP\FilamentTranslations\Filament\Resources\TranslationResource\Actions\EditPageActions; use TomatoPHP\FilamentTranslations\Filament\Resources\TranslationResource\Actions\ViewPageActions; use TomatoPHP\FilamentTranslations\Filament\Resources\TranslationResource\Actions\CreatePageActions; public function boot() { ManagePageActions::register([ Filament\Actions\Action::make('action') ]); EditPageActions::register([ Filament\Actions\Action::make('action') ]); ViewPageActions::register([ Filament\Actions\Action::make('action') ]); CreatePageActions::register([ Filament\Actions\Action::make('action') ]); }
Publish Assets
You can publish views file by use this command:
php artisan vendor:publish --tag="filament-translations-views"
You can publish languages file by use this command:
php artisan vendor:publish --tag="filament-translations-lang"
You can publish migrations file by use this command:
php artisan vendor:publish --tag="filament-translations-migrations"
Testing
if you like to run PEST
testing just use this command
composer test
Code Style
if you like to fix the code style just use this command
composer format
PHPStan
if you like to check the code by PHPStan
just use this command
composer analyse
Other Filament Packages
Checkout our Awesome TomatoPHP