A simple mixin to be aware of the current language application

[ This description is mirrored from README.md at github.com/UdeSElements/udes-language-mixin on 2019-05-10 ]

UdeS.LanguageMixin

Published on webcomponents.org

A simple mixin to be aware of the current language application.

The language property is computed from supported languages and from the browser languages.

It implements the observer pattern. You should call the updateLanguage function if you want to update the language of all observers. When the language is changed, the lang attribute of html element is update automatically.

<html lang="en"></html>

The mixin also provide some read-only properties to your component:

  • defaultLanguage: Default language defined globally.
  • language: Current language.
  • navigatorLanguage: Navigator language (see window.navigator.language).
  • navigatorLanguages: Navigator languages (see window.navigator.languages).
  • supportedLanguages: Supported languages defined globally.

Demo

<udes-language-demo></udes-language-demo>

Usage

As the primary language at our organisation, Université de Sherbrooke, is French, you may want to change the defaultLanguage and the supportedLanguages properties.

To do so, add the following code inside your index.html BEFORE you import any HTML component using this mixin.

UdeS.Language = {
    defaultLanguage: 'en',
    supportedLanguages: ['en', 'fr'],
  };

Localized files with UdeS.LocalizeMixin

If you want also to load some localized files, you should take a look on UdeS.LocalizeMixin instead (not published yet).

Install

Link to this version
ImportedReleased 31 October 2017MIT License
Framework Support
Polymer 2.0+
Browser Compatibility
Install with
bower install --save UdeSElements/udes-language-mixin"#2.2.2"
Run the above Bower command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 2.2.2

Dependencies

  • polymer#Polymer/polymer#^2.0.0