Skip to content

Zero config Language Switch(Changer/Localizer) plugin for Filamentphp Admin

License

Notifications You must be signed in to change notification settings

albertobenavides/filament-language-switch

 
 

Repository files navigation

Filament Language Switch

FILAMENT 8.x Packagist Tests Passing Code Style Passing Downloads


Filament Language(Locale) Switcher

Zero config Language Switch(Changer/Localizer) plugin for Filamentphp Admin

  • For Filamentphp 2.x use version 1.x

Installation

Install the package via composer:

composer require bezhansalleh/filament-language-switch

Publish the config file with:

php artisan vendor:publish --tag="filament-language-switch-config"

Configure your preferred options and then register the plugin to your panel(s).

Note You can find the supported country flag codes here flag codes

Optionally, you can publish the views using

php artisan vendor:publish --tag="filament-language-switch-views"

Plugin Usage

Using the plugin is easy all you need to do is instanciate it to the Panels you want the plugin to be available in.

public function panel(Panel $panel): Panel
{
    return $panel
        ...
        ->plugins([
            FilamentLanguageSwitchPlugin::make()
        ])
        ...
}

Customize Render Hook

By default the switch render in the panels::global-search.after hook but you can render the Language Switch in any of the Render Hooks available in Filamentphp using the renderHookName() method inside your panel's plugins() method.

public function panel(Panel $panel): Panel
{
    return $panel
        ...
        ->plugins([
            FilamentLanguageSwitchPlugin::make()
                ->renderHookName('panels::global-search.before'),
        ])
        ...
}

Custom Theme

By default the plugin uses the default theme of Filamentphp, but you can customize it by adding the plugins view path into the content array of your tailwind.config.js file:

export default {
    content: [
        // ...
        './vendor/bezhansalleh/filament-language-switch/resources/views/language-switch.blade.php',
    ],
    // ...
}

Changelog

Please see CHANGELOG 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:

"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 for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

About

Zero config Language Switch(Changer/Localizer) plugin for Filamentphp Admin

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 92.4%
  • Blade 6.6%
  • Other 1.0%