Polymer mixin for localization of text, dates, times, numbers and file sizes. Also supports automatic language resolution, timezone and locale overrides.

Installation

Install from NPM:

npm install @brightspace-ui/localize-behavior

Usage

import '@brightspace-ui/localize-behavior/d2l-localize-behavior.js';
import { mixinBehaviors } from '@polymer/polymer/lib/legacy/class.js';

class MyElement extends mixinBehaviors([
  D2L.PolymerBehaviors.LocalizeBehavior
], PolymerElement) {

  static get template() {
    return html`<p>[[localize('hello')]]</p>`;
  }

  localizeConfig: {
    importFunc: async lang => (await import(`./lang/${lang}.js`)).default
  }
}

Language Resources

Store localization resources in their own directory with nothing else in it. There should be one JavaScript file for each supported locale.

// lang/en.js
export default {
  hello: `Hello, {firstName}!`
};

// lang/fr.js
export default {
  hello: `Bonjour, {firstName}!`
};

Always provide files for base languages (e.g. "en", "fr", "pt") so that if the user is using an unsupported regional language (e.g. "en-au", "fr-ca", "pt-br") it can fall back to the base language.
If there's no entry for a particular language, and no base language, the value of data-lang-default on the <html> element will be used.
If no data-lang-default is specified, "en" will be used as a last resort.

`localize()`

The localize() method is used to localize a piece of text in the component's template.

If the localized string contains arguments, pass them as additional parameters to localize:

static get template() {
  return html`<p>[[localize('hello', 'firstName', 'Mary')]]</p>`;
}

Numbers, File Sizes, Dates and Times

While localize-behavior does support formatting and parsing numbers, dates and times, instead please use the https://github.com/BrightspaceUI/intl/ library directly.

Developing

After cloning the repo, run npm install to install dependencies.

Running the demos

To start a @web/dev-server that hosts the demo page and tests:

npm start

Linting

npm run lint

Testing

# lint & run headless unit tests
npm test

# unit tests only
npm run test:headless

# debug or run a subset of local unit tests
npm run test:headless:watch

Versioning and Releasing

This repo is configured to use semantic-release. Commits prefixed with fix: and feat: will trigger patch and minor releases when merged to main.

To learn how to create major releases and release from maintenance branches, refer to the semantic-release GitHub Action documentation.

FAQs

What is @brightspace-ui/localize-behavior?

Is @brightspace-ui/localize-behavior popular?

Is @brightspace-ui/localize-behavior well maintained?

Last updated on 28 Mar 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install