angular-bootstrap-locale-dialog
v1.2.3
Published
Locale selector dialog for angular-bootstrap
Downloads
22
Maintainers
Readme
Angular Bootstrap Locale Dialog - Locale selector dialog for angular-bootstrap - https://sharvit.github.io/angular-bootstrap-locale-dialog/
Quick links
Demo
Do you want to see dialog in action? Visit https://sharvit.github.io/angular-bootstrap-locale-dialog/!
Installation
Installation is easy as angular-bootstrap-locale-dialog has minimal dependencies - only the AngularJS and AngularUI Bootstrap are required.
Additionally, it is recommended to use some other dependencies:
- font-awesome - use to render extra icons for the dialog
- flag-icon-css - use to render flag icons for each locale
Download the build
Install with NPM
$ npm install angular-bootstrap-locale-dialog --save
This will install AngularJS and AngularUI Bootstrap NPM packages.
Install with Bower
$ bower install angular-bootstrap-locale-dialog --save
This will install AngularJS and AngularUI Bootstrap bower packages.
Manual download
All the build files for all version can manually downloaded (or better yet, referencing them from the CDN): https://sharvit.github.io/angular-bootstrap-locale-dialog//angular-bootstrap-locale-dialog-v1.2.3.js
Adding dependency to your project
When you are done downloading all the dependencies and project files the only remaining part is to add dependencies on the angular-bootstrap-locale-dialog
AngularJS module:
angular.module('myModule', [
'ui.bootstrap',
'ui.bootstrap.locale-dialog'
]);
Usage
<div ng-controller="DemoController as vm">
<button ng-click="vm.changeLocale()" type="button" class="btn btn-primary">
Open a Demo Dialog
</button>
<p ng-show="vm.selectedLocale">
You selected: {{vm.selectedLocale}}
</p>
</div>
angular.module('demo')
.constant("avilableLocales", {
"en-US": {
"name": "English (US)",
"language": "en",
"country": "us"
},
"en-CA": {
"name": "English (CA)",
"language": "en",
"country": "ca"
},
"en-GB": {
"name": "English (GB)",
"language": "en",
"country": "gb"
},
"en-IN": {
"name": "English (IN)",
"language": "en",
"country": "in"
},
"en-IE": {
"name": "English (IE)",
"language": "en",
"country": "ie"
},
"fr-FR": {
"name": "Fran\u00e7ais (FR)",
"language": "fr",
"country": "fr"
},
"fr-BE": {
"name": "Fran\u00e7ais (BE)",
"language": "fr",
"country": "be"
},
"fr-CA": {
"name": "Fran\u00e7ais (CA)",
"language": "fr",
"country": "ca"
},
"fr-LB": {
"name": "Fran\u00e7ais (LB)",
"language": "fr",
"country": "lb"
},
"he-IL": {
"name": "\u05e2\u05d1\u05e8\u05d9\u05ea",
"language": "he",
"country": "il"
},
"pt-BR": {
"name": "Português (BR)",
"language": "pt",
"country": "br"
},
"pt-PT": {
"name": "Português (PT)",
"language": "pt",
"country": "pt"
},
"ro-RO": {
"name": "Română",
"language": "ro",
"country": "ro"
},
"ru-RU": {
"name": "Русский",
"language": "ru",
"country": "ru"
},
"sk-SK": {
"name": "Slovenčina (SK)",
"language": "sk",
"country": "sk"
},
"tr-TR": {
"name": "Türkçe",
"language": "tr",
"country": "tr"
},
"de-DE": {
"name": "Deutsch (German)",
"language": "de",
"country": "de"
},
"th-TH": {
"name": "ภาษาไทย",
"language": "th",
"country": "th"
}
})
.controller('DemoController', function ($localeSelectorDialog, avilableLocales) {
var vm = this;
vm.changeLocale = function () {
$localeSelectorDialog.open({
locales: avilableLocales,
showFlags: true,
showSearch: true,
contributeUrl: 'https://sharvit.github.io/angular-bootstrap-locale-dialog/'
}).result.then(function (selectedLocale) {
vm.selectedLocale = selectedLocale;
});
};
});
$localeSelectorDialog
is a service to open the locale selector dialog.
It based on AngularUI Bootstrap $uibModal
witch can create modal windows.
The $localeSelectorDialog
service has only one method: open(options)
.
$localeSelectorDialog's open function
options parameter
locales
(Type:object
, Default:{}
) - Anobject
with all the supported locales of your app. Thekeys
inside the object should be your locale id, for example:en-US
Thevalue
for eachkey
should fill the following requirements:name
(Type:string
) - The locale readable name, for exampleEnglish (US)
language
(Type:string
) - The language key, for exampleen
country
(Type:string
) - The country key, for exampleus
Their is an example for the
locale
object at the demo.templateUrl
(Type:string
, Default:angular-bootstrap-locale-dialog/angular-bootstrap-locale-dialog.html
) - A path to a template representing modal's content. Use it if you don't want to use the default template.showFlags
(Type:boolean
, Default:false
) - Set to true to show flags next to the locale name. Need to install flag-icon-css so it will match the css to the flag icon.showSearch
(Type:boolean
, Default:false
) - Set to true to show the search field. Useful when you have a big list of locales.contributeUrl
(Type:string
, Default:null
) - Have a contribute url that your users can help localize your app? Set it in order to show contribute box with that url.
return
The open
method returns the $uibModal
modal instance and use his promise
to let you know when the dialog is getting closed and what locale did the user choose.
You can get the selected locale from the result
property of the returned $uibModal
modal instance.
See the example.
[read more about the $uibModal]
Contributing
npm install && npm install -g gulp
to install the environmentgulp build
build the component, the docs and the demogulp serve
serve the demogulp test
test the component with karama
License
MIT License (MIT)
Copyright (c) 2015 Avi Sharvit