# Filament Language(Locale) Switcher
Zero config Language Switch(Changer/Localizer) plugin for Filamentphp Admin
## Installation
Install the package via composer:
```bash
composer require bezhansalleh/filament-language-switch
```
Publish the config file with:
```bash
php artisan vendor:publish --tag="filament-language-switch-config"
```
Set your preferred options:
```php
true,
/*
|--------------------------------------------------------------------------
| Language display name
|--------------------------------------------------------------------------
|
| Option to whether display the language in English or Native.
|
*/
'native' => true,
/*
|--------------------------------------------------------------------------
| Flag
|--------------------------------------------------------------------------
|
| Option to display flag for the Language.
| By default the first and second letter of the display name (if single word, otherwise first letter of first two words) will be used instead of flag.
| If set to true, the following package needs to be installed via composer.
| "composer require stijnvanouplines/blade-country-flags"
*/
'flag' => false,
/*
|--------------------------------------------------------------------------
| All Locales (Languages)
|--------------------------------------------------------------------------
|
| Uncomment the languages that your site supports - or add new ones.
| These are sorted by the native name, which is the order you might show them in a language selector.
|
*/
'locales' => [
'ar' => ['name' => 'Arabic', 'script' => 'Arab', 'native' => 'العربية', 'flag_code' => 'sa'],
'en' => ['name' => 'English', 'script' => 'Latn', 'native' => 'English', 'flag_code' => 'us'],
// 'fr' => ['name' => 'French', 'script' => 'Latn', 'native' => 'français', 'flag_code' => 'fr'],
// 'ace' => ['name' => 'Achinese', 'script' => 'Latn', 'native' => 'Aceh', 'flag_code' => '' ],
//'af' => ['name' => 'Afrikaans', 'script' => 'Latn', 'native' => 'Afrikaans', 'flag_code' => '' ],
//'agq' => ['name' => 'Aghem', 'script' => 'Latn', 'native' => 'Aghem', 'flag_code' => '' ],
//'ak' => ['name' => 'Akan', 'script' => 'Latn', 'native' => 'Akan', 'flag_code' => '' ],
//'an' => ['name' => 'Aragonese', 'script' => 'Latn', 'native' => 'aragonés', 'flag_code' => '' ],
//'cch' => ['name' => 'Atsam', 'script' => 'Latn', 'native' => 'Atsam', 'flag_code' => '' ],
//'gn' => ['name' => 'Guaraní', 'script' => 'Latn', 'native' => 'Avañe’ẽ', 'flag_code' => '' ],
//'ae' => ['name' => 'Avestan', 'script' => 'Latn', 'native' => 'avesta', 'flag_code' => '' ],
//'ay' => ['name' => 'Aymara', 'script' => 'Latn', 'native' => 'aymar aru', 'flag_code' => '' ],
//'az' => ['name' => 'Azerbaijani (Latin)', 'script' => 'Latn', 'native' => 'azərbaycanca', 'flag_code' => '' ],
...
]
];
```
That's it, everything is now ready to be deployed.
> **Note**
> You can find the supported country flag codes here [flag codes](https://flagicons.lipis.dev/)
Optionally, you can publish the views using
```bash
php artisan vendor:publish --tag="filament-language-switch-views"
```
## Configure the **Render Hook**
You can render the the **Language Switch** in any of the [Render Hooks](https://filamentphp.com/docs/2.x/admin/appearance#render-hooks) available in Filamentphp using the following method inside a service provider's `boot()` method.
```php
public function boot(): void
{
FilamentLanguageSwitch::configureUsing(fn(FilamentLanguageSwitch $switch) => $switch->setRenderHookName('user-menu.account.before'));
}
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
If you want to contribute to this packages, you may want to test it in a real Filament project:
- Fork this repository to your GitHub account.
- Create a Filament app locally.
- Clone your fork in your Filament app's root directory.
- In the `/filament-language-switch` directory, create a branch for your fix, e.g. `fix/error-message`.
Install the packages in your app's `composer.json`:
```json
"require": {
"bezhansalleh/filament-language-switch": "dev-fix/error-message as main-dev",
},
"repositories": [
{
"type": "path",
"url": "filament-language-switch"
}
]
```
Now, run `composer update`.
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Bezhan Salleh](https://github.com/bezhanSalleh)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.