@shopify/react-i18n-universal-provider

@shopify/react-i18n-universal-provider

[!CAUTION]

@shopify/react-i18n-universal-provider is deprecated.

Shopifolk, see Shopify/quilt-internal for information on the latest packages available for use internally.

A self-serializing/deserializing i18n provider that works for isomorphic applications.

Installation

yarn add @shopify/react-i18n-universal-provider

Usage

Props

The component takes an object containing the React children to render and any options to use when configuring the I18nManager to provide to the tree.

The <I18nUniversalProvider> takes the following props:

// from @shopify/react-i18n
I18nDetails {
    locale: string;
    country?: string;
    currency?: string;
    timezone?: string;
    pseudolocalize?: boolean;
    fallbackLocale?: string;
    onError?(error: I18nError): void;
}

Example

// App.tsx
import {I18nUniversalProvider} from '@shopify/react-i18n-universal-provider';

function App({locale}: {locale?: string}) {
  return (
    <I18nUniversalProvider locale={locale}>
      {/* rest of the app */}
    </I18nUniversalProvider>
  );
}

Possible Issues

Missing i18n manager error

Error: Missing i18n manager. Make sure to use an <I18nContext.Provider /> somewhere in your React tree from the @shopify/react-i18n hook.

Cause:

Duplicate and/or unmet versions of react-i18n

Potential Solution:

Deduplicating dependencies for react-i18n-universal-provider and react-i18n.

npx yarn-deduplicate --packages @shopify/react-i18n yarn.lock
npx yarn-deduplicate --packages @shopify/react-html yarn.lock
npx yarn-deduplicate --packages @shopify/react-effect yarn.lock
# deduplicate other dependencies of @shopify/react-i18n

yarn why @shopify/react-i18n # ensure no duplicate / unmet dependencies
yarn list  # ensure no duplicate / unmet dependencies
yarn install