i18n

Functions to internationalize your add-on. You can use these APIs to get localized strings from locale files packaged with your add-on, find out the browser's current language, and find out the value of its Accept-Language header.

For more details on i18n in WebExtensions, see:

Internationalization: a guide to using the WebExtension i18n system.
Locale-Specific Message reference: WebExtensions supply locale-specific strings in files called messages.json. This page describes the format of messages.json.

Types

i18n.LanguageCode: A language tag such as "en-US" or "fr".

Functions

i18n.getAcceptLanguages(): Gets the accept-languages of the browser. This is different from the locale used by the browser. To get the locale, use i18n.getUILanguage.
i18n.getMessage(): Gets the localized string for the specified message.
i18n.getUILanguage(): Gets the UI language of the browser. This is different from i18n.getAcceptLanguages which returns the preferred user languages.
i18n.detectLanguage(): Detects the language of the provided text using the Compact Language Detector.

	Edge	Firefox	Chrome	Opera
`LanguageCode`	?	45.0	Yes	33
`detectLanguage`	?	47.0	Yes	33
`getAcceptLanguages`	?	47.0	Yes	33
`getMessage`	?	45.0	Yes	33
`getUILanguage`	?	47.0	Yes	No

	Firefox
`LanguageCode`	48.0
`detectLanguage`	48.0
`getAcceptLanguages`	48.0
`getMessage`	48.0
`getUILanguage`	48.0

Chrome incompatibilities

None.

Example add-ons

notify-link-clicks-i18n

Acknowledgements

This API is based on Chromium's chrome.i18n API. This documentation is derived from i18n.json in the Chromium code.

// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Document Tags and Contributors

Last updated by: wbamberg, Apr 15, 2016, 1:14:32 PM