Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lajax/yii2-language-picker
Yii2 Language picker widget
https://github.com/lajax/yii2-language-picker
Last synced: 22 days ago
JSON representation
Yii2 Language picker widget
- Host: GitHub
- URL: https://github.com/lajax/yii2-language-picker
- Owner: lajax
- License: other
- Created: 2015-03-01T12:35:51.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-07-24T10:43:11.000Z (over 6 years ago)
- Last Synced: 2024-12-13T05:18:27.401Z (28 days ago)
- Language: CSS
- Size: 619 KB
- Stars: 43
- Watchers: 12
- Forks: 24
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Yii2 Language Picker
Yii2 Language Picker Widget
## Introduction
The widget provides an easy to use language selector which makes it possible to change the language of our website easily.
The language change can take place synchronously or asynchronously (through Ajax). The default method is asynchronous (through an Ajax call), however when this method fails for any reason (e.g. JavaScript is blocked on the client side) the new language will actualise synchronously through an automatic page reload.
The language switcher is fully customisable. However, the pre-defined options provide a dropdown list (DropDownList), and a link-based list (ButtonList). Both versions can display the name of the chosen language and the corresponding flag (icon).
## Installation
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
```json
composer require lajax/yii2-language-picker
```
## Config:
Identifier of the language element. e.g.: en, en-US
### IMPORTANT
To use the widget, the value of the enablePrettyUrl property in the urlManager configuration must be true, and the value of showScriptName false.
example:
```php
'components' => [
// ...
'urlManager' => [
'enablePrettyUrl' => true,
'showScriptName' => false,
'rules' => [
// your rules go here
],
// ...
],
// ...
]
```
Using of [urlManager](http://www.yiiframework.com/doc-2.0/yii-web-urlmanager.html).
### Minimal configuration (icons only)
```php
'language' => 'en',
'bootstrap' => ['languagepicker'],
'components' => [
'languagepicker' => [
'class' => 'lajax\languagepicker\Component',
// List of available languages (icons only)
'languages' => ['en', 'de', 'fr'],
]
],
```
### Minimal configuration (icons and text)
```php
'language' => 'en',
'bootstrap' => ['languagepicker'],
'components' => [
'languagepicker' => [
'class' => 'lajax\languagepicker\Component',
// List of available languages (icons and text)
'languages' => ['en' => 'English', 'de' => 'Deutsch', 'fr' => 'Français']
]
],
```
### Full configuration (icons only)
```php
'language' => 'en-US',
'bootstrap' => ['languagepicker'],
'components' => [
'languagepicker' => [
'class' => 'lajax\languagepicker\Component',
'languages' => ['en-US', 'de-DE', 'fr-FR'], // List of available languages (icons only)
'cookieName' => 'language', // Name of the cookie.
'cookieDomain' => 'example.com', // Domain of the cookie.
'expireDays' => 64, // The expiration time of the cookie is 64 days.
// Function to execute after changing the language
'callback' => function() {
if (!\Yii::$app->user->isGuest) {
$user = \Yii::$app->user->identity;
$user->language = \Yii::$app->language;
$user->save();
}
}
]
],
```
### [Yii2-translate-manager](https://github.com/lajax/yii2-translate-manager) integration
#### Minimal configuration (icons only)
```php
'language' => 'en',
'bootstrap' => ['languagepicker'],
'components' => [
'languagepicker' => [
'class' => 'lajax\languagepicker\Component',
// Get available languages from translate manager
'languages' => function () {
return array_keys(\lajax\translatemanager\models\Language::getLanguageNames(true));
}
]
],
```
#### Minimal configuration (icons and text)
```php
'language' => 'en',
'bootstrap' => ['languagepicker'],
'components' => [
'languagepicker' => [
'class' => 'lajax\languagepicker\Component',
// Get available languages from translate manager
'languages' => function () {
return \lajax\translatemanager\models\Language::getLanguageNames(true);
}
]
],
```
## Usage
## Displaying language selector
#### Displaying pre-defined languate picker buttons (icons and text or icons only):
```php
= \lajax\languagepicker\widgets\LanguagePicker::widget([
'skin' => \lajax\languagepicker\widgets\LanguagePicker::SKIN_BUTTON,
'size' => \lajax\languagepicker\widgets\LanguagePicker::SIZE_SMALL
]); ?>
```
#### Displaying pre-defined languate picker dropdown list (icons and text or icons only):
```php
= \lajax\languagepicker\widgets\LanguagePicker::widget([
'skin' => \lajax\languagepicker\widgets\LanguagePicker::SKIN_DROPDOWN,
'size' => \lajax\languagepicker\widgets\LanguagePicker::SIZE_LARGE
]); ?>
```
#### Customising the language picker:
```php
= \lajax\languagepicker\widgets\LanguagePicker::widget([
'itemTemplate' => '
'activeItemTemplate' => ' {name}',
'parentTemplate' => '
- {items}
'languageAsset' => 'lajax\languagepicker\bundles\LanguageLargeIconsAsset', // StyleSheets
'languagePluginAsset' => 'lajax\languagepicker\bundles\LanguagePluginAsset', // JavaScripts
]); ?>
```
## Screenshots
### Buttons icons and text
### Buttons icons only
### Buttons text only
### DropDown icons and text
### DropDown icons only
### DropDown text only
## Links
- [GitHub](https://github.com/lajax/yii2-language-picker)
- [Api Docs](http://lajax.github.io/yii2-language-picker)
- [Packagist](https://packagist.org/packages/lajax/yii2-language-picker)
- [Yii Extensions](http://www.yiiframework.com/extension/yii2-language-picker)
- [Flag Sprites](http://www.flag-sprites.com)