summaryrefslogtreecommitdiffstats
path: root/devtools/client/shared/fluent-l10n/fluent-l10n.js
blob: d3a5c33408d379195e1fdd141f790efdfa99e54e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

"use strict";

const FluentReact = require("resource://devtools/client/shared/vendor/fluent-react.js");

/**
 * Wrapper over FluentReact. It encapsulates instantiation of the localization
 * bundles, and offers a simpler way of accessing `getString`.
 */
class FluentL10n {
  /**
   * Initializes the wrapper, generating the bundles for the given resource ids.
   * It can optionally add the right attributes to the document element.
   * @param {Array} resourceIds
   * @param {Object} [options]
   * @param {boolean} [options.setAttributesOnDocument]
   */
  async init(resourceIds, { setAttributesOnDocument } = {}) {
    if (setAttributesOnDocument) {
      const primaryLocale = Services.locale.appLocalesAsBCP47[0];
      document.documentElement.setAttribute("lang", primaryLocale);
      const direction = Services.locale.isAppLocaleRTL ? "rtl" : "ltr";
      document.documentElement.setAttribute("dir", direction);
    }

    const locales = Services.locale.appLocalesAsBCP47;
    const generator = L10nRegistry.getInstance().generateBundles(
      locales,
      resourceIds
    );

    this._bundles = [];
    for await (const bundle of generator) {
      this._bundles.push(bundle);
    }
    this._reactLocalization = new FluentReact.ReactLocalization(this._bundles);
  }

  /**
   * Returns the fluent bundles generated.
   */
  getBundles() {
    return this._bundles;
  }

  /**
   * Returns the localized string for the provided id, formatted using args.
   */
  getString(id, args, fallback) {
    // Forward arguments via .apply() so that the original method can:
    // - perform asserts based on the number of arguments
    // - add new arguments
    return this._reactLocalization.getString.apply(
      this._reactLocalization,
      arguments
    );
  }
}

// Export the class
exports.FluentL10n = FluentL10n;