@react-aria/i18n 3.12.16 → 3.13.0

package/src/server.tsx

@@ -1,99 +0,0 @@
-/*
- * Copyright 2023 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import type {LocalizedString} from '@internationalized/string';
-import React, {JSX} from 'react';
-
-type PackageLocalizedStrings = {
-  [packageName: string]: Record<string, LocalizedString>
-};
-
-interface PackageLocalizationProviderProps {
-  locale: string,
-  strings: PackageLocalizedStrings,
-  nonce?: string
-}
-
-/**
- * A PackageLocalizationProvider can be rendered on the server to inject the localized strings
- * needed by the client into the initial HTML.
- */
-export function PackageLocalizationProvider(props: PackageLocalizationProviderProps): JSX.Element | null {
-  if (typeof document !== 'undefined') {
-    console.log('PackageLocalizationProvider should only be rendered on the server.');
-    return null;
-  }
-
-  let {nonce, locale, strings} = props;
-  // suppressHydrationWarning is necessary because the browser
-  // remove the nonce parameter from the DOM before hydration
-  return <script nonce={typeof window === 'undefined' ? nonce : ''} suppressHydrationWarning dangerouslySetInnerHTML={{__html: getPackageLocalizationScript(locale, strings)}} />;
-}
-
-/**
- * Returns the content for an inline `<script>` tag to inject localized strings into initial HTML.
- */
-export function getPackageLocalizationScript(locale: string, strings: PackageLocalizedStrings): string {
-  return `window[Symbol.for('react-aria.i18n.locale')]=${JSON.stringify(locale)};{${serialize(strings)}}`;
-}
-
-const cache = new WeakMap<PackageLocalizedStrings, string>();
-
-function serialize(strings: PackageLocalizedStrings): string {
-  let cached = cache.get(strings);
-  if (cached) {
-    return cached;
-  }
-
-  // Find common strings between packages and hoist them into variables.
-  let seen = new Set();
-  let common = new Map();
-  for (let pkg in strings) {
-    for (let key in strings[pkg]) {
-      let v = strings[pkg][key];
-      let s = typeof v === 'string' ? JSON.stringify(v) : v.toString();
-      if (seen.has(s) && !common.has(s)) {
-        let name = String.fromCharCode(common.size > 25 ? common.size + 97 : common.size + 65);
-        common.set(s, name);
-      }
-      seen.add(s);
-    }
-  }
-
-  let res = '';
-  if (common.size > 0) {
-    res += 'let ';
-  }
-  for (let [string, name] of common) {
-    res += `${name}=${string},`;
-  }
-  if (common.size > 0) {
-    res = res.slice(0, -1) + ';';
-  }
-
-  res += "window[Symbol.for('react-aria.i18n.strings')]={";
-  for (let pkg in strings) {
-    res += `'${pkg}':{`;
-    for (let key in strings[pkg]) {
-      let v = strings[pkg][key];
-      let s = typeof v === 'string' ? JSON.stringify(v) : v.toString();
-      if (common.has(s)) {
-        s = common.get(s);
-      }
-      res += `${/[ ()]/.test(key) ? JSON.stringify(key) : key}:${s},`;
-    }
-    res = res.slice(0, -1) + '},';
-  }
-  res = res.slice(0, -1) + '};';
-  cache.set(strings, res);
-  return res;
-}

package/src/useCollator.ts

@@ -1,33 +0,0 @@
-/*
- * Copyright 2020 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {useLocale} from './context';
-
-let cache = new Map<string, Intl.Collator>();
-
-/**
- * Provides localized string collation for the current locale. Automatically updates when the locale changes,
- * and handles caching of the collator for performance.
- * @param options - Collator options.
- */
-export function useCollator(options?: Intl.CollatorOptions): Intl.Collator {
-  let {locale} = useLocale();
-
-  let cacheKey = locale + (options ? Object.entries(options).sort((a, b) => a[0] < b[0] ? -1 : 1).join() : '');
-  if (cache.has(cacheKey)) {
-    return cache.get(cacheKey)!;
-  }
-
-  let formatter = new Intl.Collator(locale, options);
-  cache.set(cacheKey, formatter);
-  return formatter;
-}

package/src/useDateFormatter.ts

@@ -1,52 +0,0 @@
-/*
- * Copyright 2020 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {DateFormatter} from '@internationalized/date';
-import {useDeepMemo} from '@react-aria/utils';
-import {useLocale} from './context';
-import {useMemo} from 'react';
-
-export interface DateFormatterOptions extends Intl.DateTimeFormatOptions {
-  calendar?: string
-}
-
-/**
- * Provides localized date formatting for the current locale. Automatically updates when the locale changes,
- * and handles caching of the date formatter for performance.
- * @param options - Formatting options.
- */
-export function useDateFormatter(options?: DateFormatterOptions): DateFormatter {
-  // Reuse last options object if it is shallowly equal, which allows the useMemo result to also be reused.
-  options = useDeepMemo(options ?? {}, isEqual);
-  let {locale} = useLocale();
-  return useMemo(() => new DateFormatter(locale, options), [locale, options]);
-}
-
-function isEqual(a: DateFormatterOptions, b: DateFormatterOptions) {
-  if (a === b) {
-    return true;
-  }
-
-  let aKeys = Object.keys(a);
-  let bKeys = Object.keys(b);
-  if (aKeys.length !== bKeys.length) {
-    return false;
-  }
-
-  for (let key of aKeys) {
-    if (b[key] !== a[key]) {
-      return false;
-    }
-  }
-
-  return true;
-}

package/src/useDefaultLocale.ts

@@ -1,91 +0,0 @@
-/*
- * Copyright 2020 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {Direction} from '@react-types/shared';
-import {isRTL} from './utils';
-import {useEffect, useState} from 'react';
-import {useIsSSR} from '@react-aria/ssr';
-
-export interface Locale {
-  /** The [BCP47](https://www.ietf.org/rfc/bcp/bcp47.txt) language code for the locale. */
-  locale: string,
-  /** The writing direction for the locale. */
-  direction: Direction
-}
-
-// Locale passed from server by PackageLocalizationProvider.
-const localeSymbol = Symbol.for('react-aria.i18n.locale');
-
-/**
- * Gets the locale setting of the browser.
- */
-export function getDefaultLocale(): Locale {
-  let locale = typeof window !== 'undefined' && window[localeSymbol]
-    // @ts-ignore
-    || (typeof navigator !== 'undefined' && (navigator.language || navigator.userLanguage))
-    || 'en-US';
-
-  try {
-    Intl.DateTimeFormat.supportedLocalesOf([locale]);
-  } catch {
-    locale = 'en-US';
-  }
-  return {
-    locale,
-    direction: isRTL(locale) ? 'rtl' : 'ltr'
-  };
-}
-
-let currentLocale = getDefaultLocale();
-let listeners = new Set<(locale: Locale) => void>();
-
-function updateLocale() {
-  currentLocale = getDefaultLocale();
-  for (let listener of listeners) {
-    listener(currentLocale);
-  }
-}
-
-/**
- * Returns the current browser/system language, and updates when it changes.
- */
-export function useDefaultLocale(): Locale {
-  let isSSR = useIsSSR();
-  let [defaultLocale, setDefaultLocale] = useState(currentLocale);
-
-  useEffect(() => {
-    if (listeners.size === 0) {
-      window.addEventListener('languagechange', updateLocale);
-    }
-
-    listeners.add(setDefaultLocale);
-
-    return () => {
-      listeners.delete(setDefaultLocale);
-      if (listeners.size === 0) {
-        window.removeEventListener('languagechange', updateLocale);
-      }
-    };
-  }, []);
-
-  // We cannot determine the browser's language on the server, so default to
-  // en-US. This will be updated after hydration on the client to the correct value.
-  if (isSSR) {
-    let locale = typeof window !== 'undefined' && window[localeSymbol];
-    return {
-      locale: locale || 'en-US',
-      direction: 'ltr'
-    };
-  }
-
-  return defaultLocale;
-}

package/src/useFilter.ts

@@ -1,83 +0,0 @@
-/*
- * Copyright 2020 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {useCallback, useMemo} from 'react';
-import {useCollator} from './useCollator';
-
-export interface Filter {
-  /** Returns whether a string starts with a given substring. */
-  startsWith: (string: string, substring: string) => boolean,
-  /** Returns whether a string ends with a given substring. */
-  endsWith: (string: string, substring: string) => boolean,
-  /** Returns whether a string contains a given substring. */
-  contains: (string: string, substring: string) => boolean
-}
-
-/**
- * Provides localized string search functionality that is useful for filtering or matching items
- * in a list. Options can be provided to adjust the sensitivity to case, diacritics, and other parameters.
- */
-export function useFilter(options?: Intl.CollatorOptions): Filter {
-  let collator = useCollator({
-    usage: 'search',
-    ...options
-  });
-
-  // TODO(later): these methods don't currently support the ignorePunctuation option.
-  let startsWith = useCallback((string, substring) => {
-    if (substring.length === 0) {
-      return true;
-    }
-
-    // Normalize both strings so we can slice safely
-    // TODO: take into account the ignorePunctuation option as well...
-    string = string.normalize('NFC');
-    substring = substring.normalize('NFC');
-    return collator.compare(string.slice(0, substring.length), substring) === 0;
-  }, [collator]);
-
-  let endsWith = useCallback((string, substring) => {
-    if (substring.length === 0) {
-      return true;
-    }
-
-    string = string.normalize('NFC');
-    substring = substring.normalize('NFC');
-    return collator.compare(string.slice(-substring.length), substring) === 0;
-  }, [collator]);
-
-  let contains = useCallback((string, substring) => {
-    if (substring.length === 0) {
-      return true;
-    }
-
-    string = string.normalize('NFC');
-    substring = substring.normalize('NFC');
-
-    let scan = 0;
-    let sliceLen = substring.length;
-    for (; scan + sliceLen <= string.length; scan++) {
-      let slice = string.slice(scan, scan + sliceLen);
-      if (collator.compare(substring, slice) === 0) {
-        return true;
-      }
-    }
-
-    return false;
-  }, [collator]);
-
-  return useMemo(() => ({
-    startsWith,
-    endsWith,
-    contains
-  }), [startsWith, endsWith, contains]);
-}

package/src/useListFormatter.tsx

@@ -1,24 +0,0 @@
-/*
- * Copyright 2020 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {useLocale} from './context';
-import {useMemo} from 'react';
-
-/**
- * Provides localized list formatting for the current locale. Automatically updates when the locale changes,
- * and handles caching of the list formatter for performance.
- * @param options - Formatting options.
- */
-export function useListFormatter(options: Intl.ListFormatOptions = {}): Intl.ListFormat {
-  let {locale} = useLocale();
-  return useMemo(() => new Intl.ListFormat(locale, options), [locale, options]);
-}

package/src/useLocalizedStringFormatter.ts

@@ -1,44 +0,0 @@
-/*
- * Copyright 2022 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {LocalizedString, LocalizedStringDictionary, LocalizedStringFormatter, LocalizedStrings} from '@internationalized/string';
-import {useLocale} from './context';
-import {useMemo} from 'react';
-
-const cache = new WeakMap();
-function getCachedDictionary<K extends string, T extends LocalizedString>(strings: LocalizedStrings<K, T>): LocalizedStringDictionary<K, T> {
-  let dictionary = cache.get(strings);
-  if (!dictionary) {
-    dictionary = new LocalizedStringDictionary(strings);
-    cache.set(strings, dictionary);
-  }
-
-  return dictionary;
-}
-
-/**
- * Returns a cached LocalizedStringDictionary for the given strings.
- */
-export function useLocalizedStringDictionary<K extends string = string, T extends LocalizedString = string>(strings: LocalizedStrings<K, T>, packageName?: string): LocalizedStringDictionary<K, T> {
-  return (packageName && LocalizedStringDictionary.getGlobalDictionaryForPackage(packageName)) || getCachedDictionary(strings);
-}
-
-/**
- * Provides localized string formatting for the current locale. Supports interpolating variables,
- * selecting the correct pluralization, and formatting numbers. Automatically updates when the locale changes.
- * @param strings - A mapping of languages to localized strings by key.
- */
-export function useLocalizedStringFormatter<K extends string = string, T extends LocalizedString = string>(strings: LocalizedStrings<K, T>, packageName?: string): LocalizedStringFormatter<K, T> {
-  let {locale} = useLocale();
-  let dictionary = useLocalizedStringDictionary(strings, packageName);
-  return useMemo(() => new LocalizedStringFormatter(locale, dictionary), [locale, dictionary]);
-}

package/src/useNumberFormatter.ts

@@ -1,25 +0,0 @@
-/*
- * Copyright 2020 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {NumberFormatOptions, NumberFormatter} from '@internationalized/number';
-import {useLocale} from './context';
-import {useMemo} from 'react';
-
-/**
- * Provides localized number formatting for the current locale. Automatically updates when the locale changes,
- * and handles caching of the number formatter for performance.
- * @param options - Formatting options.
- */
-export function useNumberFormatter(options: NumberFormatOptions = {}): Intl.NumberFormat {
-  let {locale} = useLocale();
-  return useMemo(() => new NumberFormatter(locale, options), [locale, options]);
-}

package/src/utils.ts

@@ -1,43 +0,0 @@
-/*
- * Copyright 2020 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-// https://en.wikipedia.org/wiki/Right-to-left
-const RTL_SCRIPTS = new Set(['Arab', 'Syrc', 'Samr', 'Mand', 'Thaa', 'Mend', 'Nkoo', 'Adlm', 'Rohg', 'Hebr']);
-const RTL_LANGS = new Set(['ae', 'ar', 'arc', 'bcc', 'bqi', 'ckb', 'dv', 'fa', 'glk', 'he', 'ku', 'mzn', 'nqo', 'pnb', 'ps', 'sd', 'ug', 'ur', 'yi']);
-
-/**
- * Determines if a locale is read right to left using [Intl.Locale]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale}.
- */
-export function isRTL(localeString: string): boolean {
-  // If the Intl.Locale API is available, use it to get the locale's text direction.
-  if (Intl.Locale) {
-    let locale = new Intl.Locale(localeString).maximize();
-
-    // Use the text info object to get the direction if possible.
-    // @ts-ignore - this was implemented as a property by some browsers before it was standardized as a function.
-    // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/getTextInfo
-    let textInfo = typeof locale.getTextInfo === 'function' ? locale.getTextInfo() : locale.textInfo;
-    if (textInfo) {
-      return textInfo.direction === 'rtl';
-    }
-
-    // Fallback: guess using the script.
-    // This is more accurate than guessing by language, since languages can be written in multiple scripts.
-    if (locale.script) {
-      return RTL_SCRIPTS.has(locale.script);
-    }
-  }
-
-  // If not, just guess by the language (first part of the locale)
-  let lang = localeString.split('-')[0];
-  return RTL_LANGS.has(lang);
-}