Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/statikbe/laravel-filament-chained-translation-manager
A translation manager tool for Laravel Filament, that makes use of the Laravel Chained Translator.
https://github.com/statikbe/laravel-filament-chained-translation-manager
Last synced: about 1 month ago
JSON representation
A translation manager tool for Laravel Filament, that makes use of the Laravel Chained Translator.
- Host: GitHub
- URL: https://github.com/statikbe/laravel-filament-chained-translation-manager
- Owner: statikbe
- License: mit
- Created: 2022-10-18T06:37:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-25T01:47:39.000Z (3 months ago)
- Last Synced: 2024-03-27T03:25:32.268Z (3 months ago)
- Language: PHP
- Size: 450 KB
- Stars: 69
- Watchers: 6
- Forks: 18
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
Lists
- awesome-filament - statikbe/laravel-filament-chained-translation-manager - A translation manager tool using [Laravel Chained Translator](https://github.com/statikbe/laravel-chained-translator). (Complete Sections)
README
# Laravel Filament Chained Translation Manager
The Laravel Filament Chained Translation Manager allows you to easily edit the translations of your current Laravel environment.
This translation manager uses the [Laravel Chained Translator](https://github.com/statikbe/laravel-chained-translator),
that enables you to override the default translations with translations for a specific environment, e.g.
a content manager can independently edit and override the translation files on the production environment from the translations provided by the developers.
Typically, at some point during the development phase, a content manager wants to translate or finetune the translation
strings added by developers. This often results in merge and versioning issues, when developers and content managers are
working on the translation files at the same time.
The Chained Translator package allows translations created by developers to exist separately from translations edited
by the content manager in separate lang directories. The library merges the translations of both language directories,
where the translations of the content manager (the custom translations) override those of the developer (the default translations).
Check the documentation of the [Laravel Chained Translator](https://github.com/statikbe/laravel-chained-translator) for more info.
There is also a [Laravel Nova Chained Translation Manager](https://github.com/statikbe/laravel-nova-chained-translation-manager) of this package.
## Features
- Save translations of the current environment to separate translation files in a separate language directory to avoid version conflicts.
- Immediately save translations.
- Search for translations and translation keys.
- Filter translations for specific groups and languages.
- Only show keys with missing translations.
- Shows statistics of how many fields are completely translated.
This tool does not provide features to add new translation keys, because our target users are translators and
content managers, and we want to avoid that they add unnecessary translation keys.
## Installation
> **Note**
> For **Filament 2.x** use **[v1.x](https://github.com/statikbe/laravel-filament-chained-translation-manager/releases)** version
1. You can install the package via Composer:
```bash
composer require statikbe/laravel-filament-chained-translation-manager
```
2. Register the plugin for the Filament Panels you want:
```php
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
\Statikbe\FilamentTranslationManager\FilamentChainedTranslationManagerPlugin::make(),
]);
}
```
2. Using this package requires a Filament custom theme. If you do not have one already, you can follow the instructions [on the Filament documentation site](https://filamentphp.com/docs/3.x/panels/themes#creating-a-custom-theme) to create one. Creating a new theme simply publishes the styling for the default Filament panel, so this will not change anything if you are happy with how Filament is styled out of the box. After creating a custom theme, you will need to add the following path to the `content` array of the generated `tailwind.config.js` file for the Filament theme:
```javascript
"./vendor/statikbe/laravel-filament-chained-translation-manager/**/*.blade.php",
```
3. Now run the following command to compile the plugin styles into Filament's stylesheet:
```bash
npm run build
```
4. Publish the `config` file then setup your configuration:
```bash
php artisan vendor:publish --tag="filament-translation-manager-config"
```
## Configuration
You can configure the custom language directory name and extend or finetune the service provider of the
[Laravel Chained Translator](https://github.com/statikbe/laravel-chained-translator). Have a look at the configuration
options of the [Laravel Chained Translator library](https://github.com/statikbe/laravel-chained-translator).
### Supported locales
There are two ways to change the supported locales.
#### Option 1
Set up the supported locales using the configuration. By default, it will fallback to the locale and fallback locale. However, you can customize the configuration to include additional locales as follows:
```php
'locales' => [
'en',
'fr',
],
```
#### Option 2
If your application already has a config that declares your locales than you are able to set the supported locales in any service provider.
Create a new one or use the `app/Providers/AppServiceProvider.php` and set the supported locales as an array in the boot function as follows:
```php
use Statikbe\FilamentTranslationManager\FilamentTranslationManager;
public function boot()
{
FilamentTranslationManager::setLocales(['en', 'nl']);
}
```
### Gate
You can restrict access to the Translation Manager by configuring the Gate variable.
```php
'gate' => 'view-filament-translation-manager',
```
### Ignoring groups
You can choose to exclude specific groups of translations from appearing in Filament. Create an array with the keys that you wish to ignore:
```php
'ignore_groups' => [
'auth',
],
```
### Navigation Icon
You can customize the navigation icon by configuring the `navigation-icon` variable
```
'navigation_icon' => 'heroicon-o-language',
```
## Usage
The library creates a new directory for the new translations, see [Laravel Chained Translator](https://github.com/statikbe/laravel-chained-translator).
Check the configuration options of the [Laravel Chained Translator](https://github.com/statikbe/laravel-chained-translator) package to change this.
Additionally, please note that the Translation Manager is automatically included in the Filament menu.
### Merging translations
You can combine the custom translations of the current environment with the default translation files,
by running the command provided by the [Laravel Chained Translator](https://github.com/statikbe/laravel-chained-translator).
## Screenshots
## Upgrading
Please see [UPGRADING](UPGRADING.md) for details.
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Kobe Christiaensen](https://github.com/Kobo-one)
- [Sten Govaerts](https://github.com/sten)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.