summaryrefslogtreecommitdiffstats
path: root/dom/webidl/IntlUtils.webidl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
commit2aa4a82499d4becd2284cdb482213d541b8804dd (patch)
treeb80bf8bf13c3766139fbacc530efd0dd9d54394c /dom/webidl/IntlUtils.webidl
parentInitial commit. (diff)
downloadfirefox-upstream.tar.xz
firefox-upstream.zip
Adding upstream version 86.0.1.upstream/86.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--dom/webidl/IntlUtils.webidl85
1 files changed, 85 insertions, 0 deletions
diff --git a/dom/webidl/IntlUtils.webidl b/dom/webidl/IntlUtils.webidl
new file mode 100644
index 0000000000..722988b5e1
--- /dev/null
+++ b/dom/webidl/IntlUtils.webidl
@@ -0,0 +1,85 @@
+/* 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/. */
+
+[GenerateConversionToJS]
+dictionary DisplayNameOptions {
+ DOMString style;
+ sequence<DOMString> keys;
+};
+
+[GenerateInit]
+dictionary DisplayNameResult {
+ DOMString locale;
+ DOMString style;
+ record<DOMString, DOMString> values;
+};
+
+[GenerateInit]
+dictionary LocaleInfo {
+ DOMString locale;
+ DOMString direction;
+};
+
+/**
+ * The IntlUtils interface provides helper functions for localization.
+ */
+[NoInterfaceObject,
+ Exposed=Window]
+interface IntlUtils {
+ /**
+ * Helper function to retrieve the localized values for a list of requested
+ * keys.
+ *
+ * The function takes two arguments - locales which is a list of locale
+ * strings and options which is an object with two optional properties:
+ *
+ * keys:
+ * an Array of string values that are paths to individual terms
+ *
+ * style:
+ * a String with a value "long", "short" or "narrow"
+ *
+ * It returns an object with properties:
+ *
+ * locale:
+ * a negotiated locale string
+ *
+ * style:
+ * negotiated style
+ *
+ * values:
+ * a key-value pair list of requested keys and corresponding translated
+ * values
+ *
+ */
+ [Throws]
+ DisplayNameResult getDisplayNames(sequence<DOMString> locales,
+ optional DisplayNameOptions options = {});
+
+ /**
+ * Helper function to retrieve useful information about a locale.
+ *
+ * The function takes one argument - locales which is a list of locale
+ * strings.
+ *
+ * It returns an object with properties:
+ *
+ * locale:
+ * a negotiated locale string
+ *
+ * direction:
+ * text direction, "ltr" or "rtl"
+ *
+ */
+ [Throws]
+ LocaleInfo getLocaleInfo(sequence<DOMString> locales);
+
+ /**
+ * Helper function to determine if the current application locale is RTL.
+ *
+ * The result of this function can be overriden by this pref:
+ * - `intl.l10n.pseudo`
+ */
+ boolean isAppLocaleRTL();
+};