@amazon-devices/expo-localization 2.0.1758683737

package/build/Localization.d.ts

@@ -0,0 +1,163 @@
+import { Localization } from './Localization.types';
+export * from './Localization.types';
+/**
+ * @deprecated Use Localization.getLocales() instead.
+ * Three-character ISO 4217 currency code. Returns `null` on web.
+ *
+ * @example `'USD'`, `'EUR'`, `'CNY'`, `null`
+ */
+export declare const currency: string | null;
+/**
+ * @deprecated Use Localization.getLocales() instead.
+ * Decimal separator used for formatting numbers.
+ *
+ * @example `','`, `'.'`
+ */
+export declare const decimalSeparator: string;
+/**
+ * @deprecated Use Localization.getLocales() instead.
+ * Digit grouping separator used when formatting numbers larger than 1000.
+ *
+ * @example `'.'`, `''`, `','`
+ */
+export declare const digitGroupingSeparator: string;
+/**
+ * @deprecated Use Localization.getLocales() instead.
+ * A list of all the supported language ISO codes.
+ */
+export declare const isoCurrencyCodes: string[];
+/**
+ * @deprecated Use Localization.getLocales() instead.
+ * Boolean value that indicates whether the system uses the metric system.
+ * On Android and web, this is inferred from the current region.
+ */
+export declare const isMetric: boolean;
+/**
+ * @deprecated Use Localization.getLocales() instead.
+ * Returns if the system's language is written from Right-to-Left.
+ * This can be used to build features like [bidirectional icons](https://material.io/design/usability/bidirectionality.html).
+ *
+ * Returns `false` in Server Side Rendering (SSR) environments.
+ */
+export declare const isRTL: boolean;
+/**
+ * Consider using Localization.getLocales() for a list of user preferred locales instead.
+ * An [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag),
+ * consisting of a two-character language code and optional script, region and variant codes.
+ *
+ * @example `'en'`, `'en-US'`, `'zh-Hans'`, `'zh-Hans-CN'`, `'en-emodeng'`
+ */
+export declare const locale: string;
+/**
+ * @deprecated Use Localization.getLocales() instead.
+ * List of all the native languages provided by the user settings.
+ * These are returned in the order the user defines in their device settings.
+ *
+ * @example `['en', 'en-US', 'zh-Hans', 'zh-Hans-CN', 'en-emodeng']`
+ */
+export declare const locales: string[];
+/**
+ * @deprecated Use Localization.getCalendars() instead.
+ * The current time zone in display format.
+ * On Web time zone is calculated with Intl.DateTimeFormat().resolvedOptions().timeZone. For a
+ * better estimation you could use the moment-timezone package but it will add significant bloat to
+ * your website's bundle size.
+ *
+ * @example `'America/Los_Angeles'`
+ */
+export declare const timezone: string;
+/**
+ * @deprecated Use Localization.getLocales() instead.
+ * The region code for your device that comes from the Region setting under Language & Region on iOS.
+ * This value is always available on iOS, but might return `null` on Android or web.
+ *
+ * @example `'US'`, `'NZ'`, `null`
+ */
+export declare const region: string | null;
+/**
+ * List of user's locales, returned as an array of objects of type `Locale`.
+ * Guaranteed to contain at least 1 element.
+ * These are returned in the order the user defines in their device settings.
+ * On the web currency and measurements systems are not provided, instead returned as null.
+ * If needed, you can infer them from the current region using a lookup table.
+ * @example `[{
+    "languageTag": "pl-PL",
+    "languageCode": "pl",
+    "textDirection": "ltr",
+    "digitGroupingSeparator": " ",
+    "decimalSeparator": ",",
+    "measurementSystem": "metric",
+    "currencyCode": "PLN",
+    "currencySymbol": "zł",
+    "regionCode": "PL",
+    "temperatureUnit": "celsius"
+  }]`
+ */
+export declare const getLocales: () => import("./Localization.types").Locale[];
+/**
+ * List of user's preferred calendars, returned as an array of objects of type `Calendar`.
+ * Guaranteed to contain at least 1 element.
+ * For now always returns a single element, but it's likely to return a user preference list on some platforms in the future.
+ * @example `[
+    {
+      "calendar": "gregory",
+      "timeZone": "Europe/Warsaw",
+      "uses24hourClock": true,
+      "firstWeekday": 1
+    }
+  ]`
+ */
+export declare const getCalendars: () => import("./Localization.types").Calendar[];
+/**
+ * A hook providing a list of user's locales, returned as an array of objects of type `Locale`.
+ * Guaranteed to contain at least 1 element.
+ * These are returned in the order the user defines in their device settings.
+ * On the web currency and measurements systems are not provided, instead returned as null.
+ * If needed, you can infer them from the current region using a lookup table.
+ * If the OS settings change, the hook will rerender with a new list of locales.
+ * @example `[{
+    "languageTag": "pl-PL",
+    "languageCode": "pl",
+    "textDirection": "ltr",
+    "digitGroupingSeparator": " ",
+    "decimalSeparator": ",",
+    "measurementSystem": "metric",
+    "currencyCode": "PLN",
+    "currencySymbol": "zł",
+    "regionCode": "PL",
+    "temperatureUnit": "celsius"
+  }]`
+ */
+export declare function useLocales(): import("./Localization.types").Locale[];
+/**
+ * A hook providing a list of user's preferred calendars, returned as an array of objects of type `Calendar`.
+ * Guaranteed to contain at least 1 element.
+ * For now always returns a single element, but it's likely to return a user preference list on some platforms in the future.
+ * If the OS settings change, the hook will rerender with a new list of calendars.
+ * @example `[
+    {
+      "calendar": "gregory",
+      "timeZone": "Europe/Warsaw",
+      "uses24hourClock": true,
+      "firstWeekday": 1
+    }
+  ]`
+ */
+export declare function useCalendars(): import("./Localization.types").Calendar[];
+/**
+ * Get the latest native values from the device. Locale can be changed on some Android devices
+ * without resetting the app.
+ * > On iOS, changing the locale will cause the device to reset meaning the constants will always be
+ * correct.
+ *
+ * @example
+ * ```ts
+ * // When the app returns from the background on Android...
+ *
+ * const { locale } = await Localization.getLocalizationAsync();
+ * ```
+ * @deprecated
+ * Use Localization.getLocales() or Localization.getCalendars() instead.
+ */
+export declare function getLocalizationAsync(): Promise<Localization>;
+//# sourceMappingURL=Localization.d.ts.map

package/build/Localization.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Localization.d.ts","sourceRoot":"","sources":["../src/Localization.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,cAAc,sBAAsB,CAAC;AAGrC;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,eAA4B,CAAC;AAGlD;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,QAAoC,CAAC;AAGlE;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,QAA0C,CAAC;AAG9E;;;GAGG;AACH,eAAO,MAAM,gBAAgB,UAAoC,CAAC;AAGlE;;;;GAIG;AACH,eAAO,MAAM,QAAQ,SAA4B,CAAC;AAGlD;;;;;;GAMG;AACH,eAAO,MAAM,KAAK,SAAyB,CAAC;AAG5C;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,QAA0B,CAAC;AAG9C;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,UAA2B,CAAC;AAGhD;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ,QAA4B,CAAC;AAGlD;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,eAA0B,CAAC;AAE9C;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,UAAU,+CAA8B,CAAC;AAEtD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,iDAAgC,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,UAAU,4CAUzB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,8CAU3B;AAGD;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,YAAY,CAAC,CAElE"}

package/build/Localization.js

@@ -0,0 +1,197 @@
+import { useEffect, useReducer, useMemo } from 'react';
+import ExpoLocalization, { addCalendarListener, addLocaleListener, removeSubscription, } from './ExpoLocalization';
+export * from './Localization.types';
+// @needsAudit
+/**
+ * @deprecated Use Localization.getLocales() instead.
+ * Three-character ISO 4217 currency code. Returns `null` on web.
+ *
+ * @example `'USD'`, `'EUR'`, `'CNY'`, `null`
+ */
+export const currency = ExpoLocalization.currency;
+// @needsAudit
+/**
+ * @deprecated Use Localization.getLocales() instead.
+ * Decimal separator used for formatting numbers.
+ *
+ * @example `','`, `'.'`
+ */
+export const decimalSeparator = ExpoLocalization.decimalSeparator;
+// @needsAudit
+/**
+ * @deprecated Use Localization.getLocales() instead.
+ * Digit grouping separator used when formatting numbers larger than 1000.
+ *
+ * @example `'.'`, `''`, `','`
+ */
+export const digitGroupingSeparator = ExpoLocalization.digitGroupingSeparator;
+// @needsAudit
+/**
+ * @deprecated Use Localization.getLocales() instead.
+ * A list of all the supported language ISO codes.
+ */
+export const isoCurrencyCodes = ExpoLocalization.isoCurrencyCodes;
+// @needsAudit
+/**
+ * @deprecated Use Localization.getLocales() instead.
+ * Boolean value that indicates whether the system uses the metric system.
+ * On Android and web, this is inferred from the current region.
+ */
+export const isMetric = ExpoLocalization.isMetric;
+// @needsAudit
+/**
+ * @deprecated Use Localization.getLocales() instead.
+ * Returns if the system's language is written from Right-to-Left.
+ * This can be used to build features like [bidirectional icons](https://material.io/design/usability/bidirectionality.html).
+ *
+ * Returns `false` in Server Side Rendering (SSR) environments.
+ */
+export const isRTL = ExpoLocalization.isRTL;
+// @needsAudit
+/**
+ * Consider using Localization.getLocales() for a list of user preferred locales instead.
+ * An [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag),
+ * consisting of a two-character language code and optional script, region and variant codes.
+ *
+ * @example `'en'`, `'en-US'`, `'zh-Hans'`, `'zh-Hans-CN'`, `'en-emodeng'`
+ */
+export const locale = ExpoLocalization.locale;
+// @needsAudit
+/**
+ * @deprecated Use Localization.getLocales() instead.
+ * List of all the native languages provided by the user settings.
+ * These are returned in the order the user defines in their device settings.
+ *
+ * @example `['en', 'en-US', 'zh-Hans', 'zh-Hans-CN', 'en-emodeng']`
+ */
+export const locales = ExpoLocalization.locales;
+// @needsAudit
+/**
+ * @deprecated Use Localization.getCalendars() instead.
+ * The current time zone in display format.
+ * On Web time zone is calculated with Intl.DateTimeFormat().resolvedOptions().timeZone. For a
+ * better estimation you could use the moment-timezone package but it will add significant bloat to
+ * your website's bundle size.
+ *
+ * @example `'America/Los_Angeles'`
+ */
+export const timezone = ExpoLocalization.timezone;
+// @needsAudit
+/**
+ * @deprecated Use Localization.getLocales() instead.
+ * The region code for your device that comes from the Region setting under Language & Region on iOS.
+ * This value is always available on iOS, but might return `null` on Android or web.
+ *
+ * @example `'US'`, `'NZ'`, `null`
+ */
+export const region = ExpoLocalization.region;
+/**
+ * List of user's locales, returned as an array of objects of type `Locale`.
+ * Guaranteed to contain at least 1 element.
+ * These are returned in the order the user defines in their device settings.
+ * On the web currency and measurements systems are not provided, instead returned as null.
+ * If needed, you can infer them from the current region using a lookup table.
+ * @example `[{
+    "languageTag": "pl-PL",
+    "languageCode": "pl",
+    "textDirection": "ltr",
+    "digitGroupingSeparator": " ",
+    "decimalSeparator": ",",
+    "measurementSystem": "metric",
+    "currencyCode": "PLN",
+    "currencySymbol": "zł",
+    "regionCode": "PL",
+    "temperatureUnit": "celsius"
+  }]`
+ */
+export const getLocales = ExpoLocalization.getLocales;
+/**
+ * List of user's preferred calendars, returned as an array of objects of type `Calendar`.
+ * Guaranteed to contain at least 1 element.
+ * For now always returns a single element, but it's likely to return a user preference list on some platforms in the future.
+ * @example `[
+    {
+      "calendar": "gregory",
+      "timeZone": "Europe/Warsaw",
+      "uses24hourClock": true,
+      "firstWeekday": 1
+    }
+  ]`
+ */
+export const getCalendars = ExpoLocalization.getCalendars;
+/**
+ * A hook providing a list of user's locales, returned as an array of objects of type `Locale`.
+ * Guaranteed to contain at least 1 element.
+ * These are returned in the order the user defines in their device settings.
+ * On the web currency and measurements systems are not provided, instead returned as null.
+ * If needed, you can infer them from the current region using a lookup table.
+ * If the OS settings change, the hook will rerender with a new list of locales.
+ * @example `[{
+    "languageTag": "pl-PL",
+    "languageCode": "pl",
+    "textDirection": "ltr",
+    "digitGroupingSeparator": " ",
+    "decimalSeparator": ",",
+    "measurementSystem": "metric",
+    "currencyCode": "PLN",
+    "currencySymbol": "zł",
+    "regionCode": "PL",
+    "temperatureUnit": "celsius"
+  }]`
+ */
+export function useLocales() {
+    const [key, invalidate] = useReducer((k) => k + 1, 0);
+    const locales = useMemo(() => getLocales(), [key]);
+    useEffect(() => {
+        const subscription = addLocaleListener(invalidate);
+        return () => {
+            removeSubscription(subscription);
+        };
+    }, []);
+    return locales;
+}
+/**
+ * A hook providing a list of user's preferred calendars, returned as an array of objects of type `Calendar`.
+ * Guaranteed to contain at least 1 element.
+ * For now always returns a single element, but it's likely to return a user preference list on some platforms in the future.
+ * If the OS settings change, the hook will rerender with a new list of calendars.
+ * @example `[
+    {
+      "calendar": "gregory",
+      "timeZone": "Europe/Warsaw",
+      "uses24hourClock": true,
+      "firstWeekday": 1
+    }
+  ]`
+ */
+export function useCalendars() {
+    const [key, invalidate] = useReducer((k) => k + 1, 0);
+    const calendars = useMemo(() => getCalendars(), [key]);
+    useEffect(() => {
+        const subscription = addCalendarListener(invalidate);
+        return () => {
+            removeSubscription(subscription);
+        };
+    }, []);
+    return calendars;
+}
+// @needsAudit
+/**
+ * Get the latest native values from the device. Locale can be changed on some Android devices
+ * without resetting the app.
+ * > On iOS, changing the locale will cause the device to reset meaning the constants will always be
+ * correct.
+ *
+ * @example
+ * ```ts
+ * // When the app returns from the background on Android...
+ *
+ * const { locale } = await Localization.getLocalizationAsync();
+ * ```
+ * @deprecated
+ * Use Localization.getLocales() or Localization.getCalendars() instead.
+ */
+export async function getLocalizationAsync() {
+    return await ExpoLocalization.getLocalizationAsync();
+}
+//# sourceMappingURL=Localization.js.map

package/build/Localization.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Localization.js","sourceRoot":"","sources":["../src/Localization.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAEvD,OAAO,gBAAgB,EAAE,EACvB,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,oBAAoB,CAAC;AAE5B,cAAc,sBAAsB,CAAC;AAErC,cAAc;AACd;;;;;GAKG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,QAAQ,CAAC;AAElD,cAAc;AACd;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,gBAAgB,CAAC;AAElE,cAAc;AACd;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,gBAAgB,CAAC,sBAAsB,CAAC;AAE9E,cAAc;AACd;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,gBAAgB,CAAC;AAElE,cAAc;AACd;;;;GAIG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,QAAQ,CAAC;AAElD,cAAc;AACd;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC;AAE5C,cAAc;AACd;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC;AAE9C,cAAc;AACd;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,gBAAgB,CAAC,OAAO,CAAC;AAEhD,cAAc;AACd;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,QAAQ,CAAC;AAElD,cAAc;AACd;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC;AAE9C;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,UAAU,CAAC;AAEtD;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,gBAAgB,CAAC,YAAY,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,UAAU;IACxB,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IACtD,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACnD,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,YAAY,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC;QACnD,OAAO,GAAG,EAAE;YACV,kBAAkB,CAAC,YAAY,CAAC,CAAC;QACnC,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IACP,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,YAAY;IAC1B,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IACtD,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,YAAY,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvD,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,YAAY,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC;QACrD,OAAO,GAAG,EAAE;YACV,kBAAkB,CAAC,YAAY,CAAC,CAAC;QACnC,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IACP,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,cAAc;AACd;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB;IACxC,OAAO,MAAM,gBAAgB,CAAC,oBAAoB,EAAE,CAAC;AACvD,CAAC","sourcesContent":["import { useEffect, useReducer, useMemo } from 'react';\n\nimport ExpoLocalization, {\n  addCalendarListener,\n  addLocaleListener,\n  removeSubscription,\n} from './ExpoLocalization';\nimport { Localization } from './Localization.types';\nexport * from './Localization.types';\n\n// @needsAudit\n/**\n * @deprecated Use Localization.getLocales() instead.\n * Three-character ISO 4217 currency code. Returns `null` on web.\n *\n * @example `'USD'`, `'EUR'`, `'CNY'`, `null`\n */\nexport const currency = ExpoLocalization.currency;\n\n// @needsAudit\n/**\n * @deprecated Use Localization.getLocales() instead.\n * Decimal separator used for formatting numbers.\n *\n * @example `','`, `'.'`\n */\nexport const decimalSeparator = ExpoLocalization.decimalSeparator;\n\n// @needsAudit\n/**\n * @deprecated Use Localization.getLocales() instead.\n * Digit grouping separator used when formatting numbers larger than 1000.\n *\n * @example `'.'`, `''`, `','`\n */\nexport const digitGroupingSeparator = ExpoLocalization.digitGroupingSeparator;\n\n// @needsAudit\n/**\n * @deprecated Use Localization.getLocales() instead.\n * A list of all the supported language ISO codes.\n */\nexport const isoCurrencyCodes = ExpoLocalization.isoCurrencyCodes;\n\n// @needsAudit\n/**\n * @deprecated Use Localization.getLocales() instead.\n * Boolean value that indicates whether the system uses the metric system.\n * On Android and web, this is inferred from the current region.\n */\nexport const isMetric = ExpoLocalization.isMetric;\n\n// @needsAudit\n/**\n * @deprecated Use Localization.getLocales() instead.\n * Returns if the system's language is written from Right-to-Left.\n * This can be used to build features like [bidirectional icons](https://material.io/design/usability/bidirectionality.html).\n *\n * Returns `false` in Server Side Rendering (SSR) environments.\n */\nexport const isRTL = ExpoLocalization.isRTL;\n\n// @needsAudit\n/**\n * Consider using Localization.getLocales() for a list of user preferred locales instead.\n * An [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag),\n * consisting of a two-character language code and optional script, region and variant codes.\n *\n * @example `'en'`, `'en-US'`, `'zh-Hans'`, `'zh-Hans-CN'`, `'en-emodeng'`\n */\nexport const locale = ExpoLocalization.locale;\n\n// @needsAudit\n/**\n * @deprecated Use Localization.getLocales() instead.\n * List of all the native languages provided by the user settings.\n * These are returned in the order the user defines in their device settings.\n *\n * @example `['en', 'en-US', 'zh-Hans', 'zh-Hans-CN', 'en-emodeng']`\n */\nexport const locales = ExpoLocalization.locales;\n\n// @needsAudit\n/**\n * @deprecated Use Localization.getCalendars() instead.\n * The current time zone in display format.\n * On Web time zone is calculated with Intl.DateTimeFormat().resolvedOptions().timeZone. For a\n * better estimation you could use the moment-timezone package but it will add significant bloat to\n * your website's bundle size.\n *\n * @example `'America/Los_Angeles'`\n */\nexport const timezone = ExpoLocalization.timezone;\n\n// @needsAudit\n/**\n * @deprecated Use Localization.getLocales() instead.\n * The region code for your device that comes from the Region setting under Language & Region on iOS.\n * This value is always available on iOS, but might return `null` on Android or web.\n *\n * @example `'US'`, `'NZ'`, `null`\n */\nexport const region = ExpoLocalization.region;\n\n/**\n * List of user's locales, returned as an array of objects of type `Locale`.\n * Guaranteed to contain at least 1 element.\n * These are returned in the order the user defines in their device settings.\n * On the web currency and measurements systems are not provided, instead returned as null.\n * If needed, you can infer them from the current region using a lookup table.\n * @example `[{\n    \"languageTag\": \"pl-PL\",\n    \"languageCode\": \"pl\",\n    \"textDirection\": \"ltr\",\n    \"digitGroupingSeparator\": \" \",\n    \"decimalSeparator\": \",\",\n    \"measurementSystem\": \"metric\",\n    \"currencyCode\": \"PLN\",\n    \"currencySymbol\": \"zł\",\n    \"regionCode\": \"PL\",\n    \"temperatureUnit\": \"celsius\"\n  }]`\n */\nexport const getLocales = ExpoLocalization.getLocales;\n\n/**\n * List of user's preferred calendars, returned as an array of objects of type `Calendar`.\n * Guaranteed to contain at least 1 element.\n * For now always returns a single element, but it's likely to return a user preference list on some platforms in the future.\n * @example `[\n    {\n      \"calendar\": \"gregory\",\n      \"timeZone\": \"Europe/Warsaw\",\n      \"uses24hourClock\": true,\n      \"firstWeekday\": 1\n    }\n  ]`\n */\nexport const getCalendars = ExpoLocalization.getCalendars;\n\n/**\n * A hook providing a list of user's locales, returned as an array of objects of type `Locale`.\n * Guaranteed to contain at least 1 element.\n * These are returned in the order the user defines in their device settings.\n * On the web currency and measurements systems are not provided, instead returned as null.\n * If needed, you can infer them from the current region using a lookup table.\n * If the OS settings change, the hook will rerender with a new list of locales.\n * @example `[{\n    \"languageTag\": \"pl-PL\",\n    \"languageCode\": \"pl\",\n    \"textDirection\": \"ltr\",\n    \"digitGroupingSeparator\": \" \",\n    \"decimalSeparator\": \",\",\n    \"measurementSystem\": \"metric\",\n    \"currencyCode\": \"PLN\",\n    \"currencySymbol\": \"zł\",\n    \"regionCode\": \"PL\",\n    \"temperatureUnit\": \"celsius\"\n  }]`\n */\nexport function useLocales() {\n  const [key, invalidate] = useReducer((k) => k + 1, 0);\n  const locales = useMemo(() => getLocales(), [key]);\n  useEffect(() => {\n    const subscription = addLocaleListener(invalidate);\n    return () => {\n      removeSubscription(subscription);\n    };\n  }, []);\n  return locales;\n}\n\n/**\n * A hook providing a list of user's preferred calendars, returned as an array of objects of type `Calendar`.\n * Guaranteed to contain at least 1 element.\n * For now always returns a single element, but it's likely to return a user preference list on some platforms in the future.\n * If the OS settings change, the hook will rerender with a new list of calendars.\n * @example `[\n    {\n      \"calendar\": \"gregory\",\n      \"timeZone\": \"Europe/Warsaw\",\n      \"uses24hourClock\": true,\n      \"firstWeekday\": 1\n    }\n  ]`\n */\nexport function useCalendars() {\n  const [key, invalidate] = useReducer((k) => k + 1, 0);\n  const calendars = useMemo(() => getCalendars(), [key]);\n  useEffect(() => {\n    const subscription = addCalendarListener(invalidate);\n    return () => {\n      removeSubscription(subscription);\n    };\n  }, []);\n  return calendars;\n}\n\n// @needsAudit\n/**\n * Get the latest native values from the device. Locale can be changed on some Android devices\n * without resetting the app.\n * > On iOS, changing the locale will cause the device to reset meaning the constants will always be\n * correct.\n *\n * @example\n * ```ts\n * // When the app returns from the background on Android...\n *\n * const { locale } = await Localization.getLocalizationAsync();\n * ```\n * @deprecated\n * Use Localization.getLocales() or Localization.getCalendars() instead.\n */\nexport async function getLocalizationAsync(): Promise<Localization> {\n  return await ExpoLocalization.getLocalizationAsync();\n}\n"]}

package/build/Localization.types.d.ts

@@ -0,0 +1,202 @@
+export type Localization = {
+    /**
+     * Three-character ISO 4217 currency code. Returns `null` on web.
+     *
+     * @example `'USD'`, `'EUR'`, `'CNY'`, `null`
+     */
+    currency: string | null;
+    /**
+     * Decimal separator used for formatting numbers.
+     *
+     * @example `','`, `'.'`
+     */
+    decimalSeparator: string;
+    /**
+     * Digit grouping separator used when formatting numbers larger than 1000.
+     *
+     * @example `'.'`, `''`, `','`
+     */
+    digitGroupingSeparator: string;
+    /**
+     * A list of all the supported language ISO codes.
+     */
+    isoCurrencyCodes: string[];
+    /**
+     * Boolean value that indicates whether the system uses the metric system.
+     * On Android and web, this is inferred from the current region.
+     */
+    isMetric: boolean;
+    /**
+     * Returns if the system's language is written from Right-to-Left.
+     * This can be used to build features like [bidirectional icons](https://material.io/design/usability/bidirectionality.html).
+     *
+     * Returns `false` in Server Side Rendering (SSR) environments.
+     */
+    isRTL: boolean;
+    /**
+     * An [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag),
+     * consisting of a two-character language code and optional script, region and variant codes.
+     *
+     * @example `'en'`, `'en-US'`, `'zh-Hans'`, `'zh-Hans-CN'`, `'en-emodeng'`
+     */
+    locale: string;
+    /**
+     * List of all the native languages provided by the user settings.
+     * These are returned in the order that the user defined in the device settings.
+     *
+     * @example `['en', 'en-US', 'zh-Hans', 'zh-Hans-CN', 'en-emodeng']`
+     */
+    locales: string[];
+    /**
+     * The region code for your device that comes from the Region setting under Language & Region on iOS.
+     * This value is always available on iOS, but might return `null` on Android or web.
+     *
+     * @example `'US'`, `'NZ'`, `null`
+     */
+    region: string | null;
+    /**
+     * The current time zone in display format.
+     * On Web time zone is calculated with Intl.DateTimeFormat().resolvedOptions().timeZone. For a
+     * better estimation you could use the moment-timezone package but it will add significant bloat to
+     * your website's bundle size.
+     *
+     * @example `'America/Los_Angeles'`
+     */
+    timezone: string;
+};
+export type Locale = {
+    /**
+     * An [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) with a region code.
+     * @example `'en-US'`, `'es-419'`, `'pl-PL'`.
+     */
+    languageTag: string;
+    /**
+     * An [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) without the region code.
+     * @example `'en'`, `'es'`, `'pl'`.
+     */
+    languageCode: string;
+    /**
+     * The region code for your device that comes from the Region setting under Language & Region on iOS, Region settings on Android and is parsed from locale on Web (can be `null` on Web).
+     */
+    regionCode: string | null;
+    /**
+     * Currency code for the locale.
+     * Is `null` on Web, use a table lookup based on region instead.
+     * @example `'USD'`, `'EUR'`, `'PLN'`.
+     */
+    currencyCode: string | null;
+    /**
+     * Currency symbol for the locale.
+     * Is `null` on Web, use a table lookup based on region (if available) instead.
+     * @example `'$'`, `'€'`, `'zł'`.
+     */
+    currencySymbol: string | null;
+    /**
+     * Decimal separator used for formatting numbers with fractional parts.
+     * @example `'.'`, `','`.
+     */
+    decimalSeparator: string | null;
+    /**
+     * Digit grouping separator used for formatting large numbers.
+     * @example `'.'`, `','`.
+     */
+    digitGroupingSeparator: string | null;
+    /**
+     * Text direction for the locale. One of: `'ltr'`, `'rtl'`, but can also be `null` on some browsers without support for the [textInfo](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/textInfo) property in [Intl](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl) API.
+     */
+    textDirection: 'ltr' | 'rtl' | null;
+    /**
+     * The measurement system used in the locale.
+     * Is `null` on Web, as user chosen measurement system is not exposed on the web and using locale to determine measurement systems is unreliable.
+     * Ask for user preferences if possible.
+     */
+    measurementSystem: `metric` | `us` | `uk` | null;
+    /**
+     * The temperature unit used in the locale.
+     * Returns `null` if the region code is unknown.
+     */
+    temperatureUnit: 'celsius' | 'fahrenheit' | null;
+};
+/**
+ * An enum mapping days of the week in Gregorian calendar to their index as returned by the `firstWeekday` property.
+ */
+export declare enum Weekday {
+    SUNDAY = 1,
+    MONDAY = 2,
+    TUESDAY = 3,
+    WEDNESDAY = 4,
+    THURSDAY = 5,
+    FRIDAY = 6,
+    SATURDAY = 7
+}
+/**
+ * The calendar identifier, one of [Unicode calendar types](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/calendar).
+ * Gregorian calendar is aliased and can be referred to as both `CalendarIdentifier.GREGORIAN` and `CalendarIdentifier.GREGORY`.
+ */
+export declare enum CalendarIdentifier {
+    /** Thai Buddhist calendar */
+    BUDDHIST = "buddhist",
+    /** Traditional Chinese calendar */
+    CHINESE = "chinese",
+    /** Coptic calendar */
+    COPTIC = "coptic",
+    /** Traditional Korean calendar */
+    DANGI = "dangi",
+    /** Ethiopic calendar, Amete Alem (epoch approx. 5493 B.C.E) */
+    ETHIOAA = "ethioaa",
+    /** Ethiopic calendar, Amete Mihret (epoch approx, 8 C.E.) */
+    ETHIOPIC = "ethiopic",
+    /** Gregorian calendar */
+    GREGORY = "gregory",
+    /** Gregorian calendar (alias) */
+    GREGORIAN = "gregory",
+    /** Traditional Hebrew calendar */
+    HEBREW = "hebrew",
+    /** Indian calendar */
+    INDIAN = "indian",
+    /** Islamic calendar */
+    ISLAMIC = "islamic",
+    /** Islamic calendar, tabular (intercalary years [2,5,7,10,13,16,18,21,24,26,29] - civil epoch) */
+    ISLAMIC_CIVIL = "islamic-civil",
+    /** Islamic calendar, Saudi Arabia sighting */
+    ISLAMIC_RGSA = "islamic-rgsa",
+    /**Islamic calendar, tabular (intercalary years [2,5,7,10,13,16,18,21,24,26,29] - astronomical epoch) */
+    ISLAMIC_TBLA = "islamic-tbla",
+    /** Islamic calendar, Umm al-Qura */
+    ISLAMIC_UMALQURA = "islamic-umalqura",
+    /** ISO calendar (Gregorian calendar using the ISO 8601 calendar week rules) */
+    ISO8601 = "iso8601",
+    /** Japanese imperial calendar */
+    JAPANESE = "japanese",
+    /** Persian calendar */
+    PERSIAN = "persian",
+    /** Civil (algorithmic) Arabic calendar */
+    ROC = "roc"
+}
+export type Calendar = {
+    /**
+     * The calendar identifier, one of [Unicode calendar types](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/calendar).
+     *
+     * On Android is limited to one of device's [available calendar types](https://developer.android.com/reference/java/util/Calendar#getAvailableCalendarTypes()).
+     *
+     * On iOS uses [calendar identifiers](https://developer.apple.com/documentation/foundation/calendar/identifier), but maps them to the corresponding Unicode types, will also never contain `'dangi'` or `'islamic-rgsa'` due to it not being implemented on iOS.
+     */
+    calendar: CalendarIdentifier | null;
+    /**
+     * True when current device settings use 24 hour time format.
+     * Can be null on some browsers that don't support the [hourCycle](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/hourCycle) property in [Intl](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl) API.
+     */
+    uses24hourClock: boolean | null;
+    /**
+     * The first day of the week. For most calendars Sunday is numbered `1`, with Saturday being number `7`.
+     * Can be null on some browsers that don't support the [weekInfo](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/weekInfo) property in [Intl](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl) API.
+     * @example `1`, `7`.
+     */
+    firstWeekday: Weekday | null;
+    /**
+     * Time zone for the calendar. Can be `null` on Web.
+     * @example `'America/Los_Angeles'`, `'Europe/Warsaw'`, `'GMT+1'`.
+     */
+    timeZone: string | null;
+};
+//# sourceMappingURL=Localization.types.d.ts.map

package/build/Localization.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Localization.types.d.ts","sourceRoot":"","sources":["../src/Localization.types.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,YAAY,GAAG;IACzB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB;;;;OAIG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAC/B;;OAEG;IACH,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;;OAKG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB;;;;;OAKG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB;;;;;;;OAOG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG;IACnB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B;;;;OAIG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B;;;;OAIG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B;;;OAGG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC;;;OAGG;IACH,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC;;OAEG;IACH,aAAa,EAAE,KAAK,GAAG,KAAK,GAAG,IAAI,CAAC;IACpC;;;;OAIG;IACH,iBAAiB,EAAE,QAAQ,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IAEjD;;;OAGG;IACH,eAAe,EAAE,SAAS,GAAG,YAAY,GAAG,IAAI,CAAC;CAClD,CAAC;AAEF;;GAEG;AACH,oBAAY,OAAO;IACjB,MAAM,IAAI;IACV,MAAM,IAAI;IACV,OAAO,IAAI;IACX,SAAS,IAAI;IACb,QAAQ,IAAI;IACZ,MAAM,IAAI;IACV,QAAQ,IAAI;CACb;AAED;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,6BAA6B;IAC7B,QAAQ,aAAa;IACrB,mCAAmC;IACnC,OAAO,YAAY;IACnB,sBAAsB;IACtB,MAAM,WAAW;IACjB,kCAAkC;IAClC,KAAK,UAAU;IACf,+DAA+D;IAC/D,OAAO,YAAY;IACnB,6DAA6D;IAC7D,QAAQ,aAAa;IACrB,yBAAyB;IACzB,OAAO,YAAY;IACnB,iCAAiC;IACjC,SAAS,YAAY;IACrB,kCAAkC;IAClC,MAAM,WAAW;IACjB,sBAAsB;IACtB,MAAM,WAAW;IACjB,uBAAuB;IACvB,OAAO,YAAY;IACnB,kGAAkG;IAClG,aAAa,kBAAkB;IAC/B,8CAA8C;IAC9C,YAAY,iBAAiB;IAC7B,wGAAwG;IACxG,YAAY,iBAAiB;IAC7B,oCAAoC;IACpC,gBAAgB,qBAAqB;IACrC,+EAA+E;IAC/E,OAAO,YAAY;IACnB,iCAAiC;IACjC,QAAQ,aAAa;IACrB,uBAAuB;IACvB,OAAO,YAAY;IACnB,0CAA0C;IAC1C,GAAG,QAAQ;CACZ;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB;;;;;;OAMG;IACH,QAAQ,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACpC;;;OAGG;IACH,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;IAChC;;;;OAIG;IACH,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;IAC7B;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB,CAAC"}

package/build/Localization.types.js

@@ -0,0 +1,59 @@
+/**
+ * An enum mapping days of the week in Gregorian calendar to their index as returned by the `firstWeekday` property.
+ */
+export var Weekday;
+(function (Weekday) {
+    Weekday[Weekday["SUNDAY"] = 1] = "SUNDAY";
+    Weekday[Weekday["MONDAY"] = 2] = "MONDAY";
+    Weekday[Weekday["TUESDAY"] = 3] = "TUESDAY";
+    Weekday[Weekday["WEDNESDAY"] = 4] = "WEDNESDAY";
+    Weekday[Weekday["THURSDAY"] = 5] = "THURSDAY";
+    Weekday[Weekday["FRIDAY"] = 6] = "FRIDAY";
+    Weekday[Weekday["SATURDAY"] = 7] = "SATURDAY";
+})(Weekday || (Weekday = {}));
+/**
+ * The calendar identifier, one of [Unicode calendar types](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/calendar).
+ * Gregorian calendar is aliased and can be referred to as both `CalendarIdentifier.GREGORIAN` and `CalendarIdentifier.GREGORY`.
+ */
+export var CalendarIdentifier;
+(function (CalendarIdentifier) {
+    /** Thai Buddhist calendar */
+    CalendarIdentifier["BUDDHIST"] = "buddhist";
+    /** Traditional Chinese calendar */
+    CalendarIdentifier["CHINESE"] = "chinese";
+    /** Coptic calendar */
+    CalendarIdentifier["COPTIC"] = "coptic";
+    /** Traditional Korean calendar */
+    CalendarIdentifier["DANGI"] = "dangi";
+    /** Ethiopic calendar, Amete Alem (epoch approx. 5493 B.C.E) */
+    CalendarIdentifier["ETHIOAA"] = "ethioaa";
+    /** Ethiopic calendar, Amete Mihret (epoch approx, 8 C.E.) */
+    CalendarIdentifier["ETHIOPIC"] = "ethiopic";
+    /** Gregorian calendar */
+    CalendarIdentifier["GREGORY"] = "gregory";
+    /** Gregorian calendar (alias) */
+    CalendarIdentifier["GREGORIAN"] = "gregory";
+    /** Traditional Hebrew calendar */
+    CalendarIdentifier["HEBREW"] = "hebrew";
+    /** Indian calendar */
+    CalendarIdentifier["INDIAN"] = "indian";
+    /** Islamic calendar */
+    CalendarIdentifier["ISLAMIC"] = "islamic";
+    /** Islamic calendar, tabular (intercalary years [2,5,7,10,13,16,18,21,24,26,29] - civil epoch) */
+    CalendarIdentifier["ISLAMIC_CIVIL"] = "islamic-civil";
+    /** Islamic calendar, Saudi Arabia sighting */
+    CalendarIdentifier["ISLAMIC_RGSA"] = "islamic-rgsa";
+    /**Islamic calendar, tabular (intercalary years [2,5,7,10,13,16,18,21,24,26,29] - astronomical epoch) */
+    CalendarIdentifier["ISLAMIC_TBLA"] = "islamic-tbla";
+    /** Islamic calendar, Umm al-Qura */
+    CalendarIdentifier["ISLAMIC_UMALQURA"] = "islamic-umalqura";
+    /** ISO calendar (Gregorian calendar using the ISO 8601 calendar week rules) */
+    CalendarIdentifier["ISO8601"] = "iso8601";
+    /** Japanese imperial calendar */
+    CalendarIdentifier["JAPANESE"] = "japanese";
+    /** Persian calendar */
+    CalendarIdentifier["PERSIAN"] = "persian";
+    /** Civil (algorithmic) Arabic calendar */
+    CalendarIdentifier["ROC"] = "roc";
+})(CalendarIdentifier || (CalendarIdentifier = {}));
+//# sourceMappingURL=Localization.types.js.map