gt-react 9.2.2 → 9.2.4-alpha.1

package/dist/client.d.ts

@@ -43,8 +43,13 @@ type TranslationLoading = {
     state: 'loading';
 };
 type TranslationsObject = {
-    [key: string]: TranslationSuccess | TranslationLoading | TranslationError;
+    [hash: string]: TranslationSuccess | TranslationLoading | TranslationError;
 };
+type MessagesContent = string;
+type MessagesObject = {
+    [id: string]: MessagesContent;
+};
+type CustomLoader = (locale: string) => Promise<any>;
 type RenderMethod = 'skeleton' | 'replace' | 'default';
 type DictionaryTranslationOptions = {
     variables?: Record<string, any>;
@@ -83,6 +88,7 @@ type GTContextType = {
     setLocale: (locale: string) => void;
     defaultLocale: string;
     translations: TranslationsObject | null;
+    messages: MessagesObject | null;
     translationRequired: boolean;
     dialectTranslationRequired: boolean;
     renderSettings: {
@@ -95,6 +101,7 @@ type ClientProviderProps = {
     children: any;
     dictionary: Dictionary;
     initialTranslations: TranslationsObject;
+    messages: MessagesObject;
     locale: string;
     locales: string[];
     _versionId?: string;
@@ -143,7 +150,7 @@ declare function renderVariable({ variableType, variableName, variableValue, var
     locales: string[];
 }): React.JSX.Element;
 
-declare function ClientProvider({ children, dictionary, initialTranslations, locale: _locale, _versionId, defaultLocale, translationRequired, dialectTranslationRequired, locales, renderSettings, projectId, devApiKey, runtimeUrl, runtimeTranslationEnabled, onLocaleChange, cookieName, }: ClientProviderProps): React__default.JSX.Element;
+declare function ClientProvider({ children, dictionary, initialTranslations, messages, locale: _locale, _versionId, defaultLocale, translationRequired, dialectTranslationRequired, locales, renderSettings, projectId, devApiKey, runtimeUrl, runtimeTranslationEnabled, onLocaleChange, cookieName, }: ClientProviderProps): React__default.JSX.Element;
 
 /**
  * The `<Branch>` component dynamically renders a specified branch of content or a fallback child component.
@@ -455,13 +462,11 @@ declare namespace Var {
 
 /**
  * A dropdown component that allows users to select a locale.
- * @param {string[]} locales - The list of supported locales. By default this is the user's list of supported locales from the `<GTProvider>` context.
- * @param {(a: string, b: string) => number} compare - A comparison function that defines the sort order of the locales. By default this sorts the locales by their native name with region code.
+ * @param {string[]} locales - An optional list of locales to use for the dropdown. If not provided, the list of locales from the `<GTProvider>` context is used.
  * @returns {React.ReactElement | null} The rendered locale dropdown component or null to prevent rendering.
  */
-declare function LocaleSelector({ locales, compare, ...props }: {
+declare function LocaleSelector({ locales: _locales, ...props }: {
     locales?: string[];
-    compare?: (a: string, b: string) => number;
     [key: string]: any;
 }): React__default.JSX.Element | null;
 
@@ -483,7 +488,7 @@ declare function LocaleSelector({ locales, compare, ...props }: {
  *
  * @returns {JSX.Element} The provider component for General Translation context.
  */
-declare function GTProvider({ children, projectId: _projectId, devApiKey: _devApiKey, dictionary, locales, defaultLocale, locale: _locale, cacheUrl, runtimeUrl, renderSettings, loadTranslation, _versionId, ...metadata }: {
+declare function GTProvider({ children, projectId: _projectId, devApiKey: _devApiKey, dictionary: _dictionary, locales, defaultLocale, locale: _locale, cacheUrl, runtimeUrl, renderSettings, loadMessages, loadTranslation, _versionId, ...metadata }: {
     children?: React__default.ReactNode;
     projectId?: string;
     devApiKey?: string;
@@ -497,9 +502,44 @@ declare function GTProvider({ children, projectId: _projectId, devApiKey: _devAp
         method: RenderMethod;
         timeout?: number;
     };
-    loadTranslation?: (locale: string) => Promise<any>;
+    loadMessages?: CustomLoader;
+    loadTranslation?: CustomLoader;
     _versionId?: string;
     [key: string]: any;
 }): React__default.JSX.Element;
 
-export { Branch, ClientProvider, Currency, DateTime, GTContext, GTProvider, LocaleSelector, Num, Plural, T, Var, renderVariable, useDefaultLocale, useDict, useGT, useLocale, useRuntimeTranslation };
+/**
+ * Sets the user's locale in the `<GTProvider>` context.
+ * If the locale passed is not supported, will fallback on current locale and then defaultLocale if necessary.
+ * @note Unless a locale has explicitly been passed to the `<GTProvider>`, this will override the user's browser preferences. The locale passed to `<GTProvider>` will always take priority.
+ *
+ * @returns {(locale: string) => void} A function that sets the user's locale.
+ *
+ * @example
+ * setLocale('en-US');
+ */
+declare function useSetLocale(): (locale: string) => void;
+
+/**
+ * Retrieves the user's list of supported locales from the `<GTProvider>` context.
+ *
+ * @returns {string[]} The user's locales, e.g., ['en-US', 'fr', 'jp'].
+ *
+ * @example
+ * const locales = useLocales();
+ * console.log(locale); // ['en-US', 'fr', 'jp]
+ */
+declare function useLocales(): string[];
+
+/**
+ * Gets the list of properties for using a locale selector.
+ * @param locales an optional list of locales to use for the drop down. These locales must be a subset of the locales provided by the `<GTProvider>` context. When not provided, the list of locales from the `<GTProvider>` context is used.
+ * @returns {object} The locale, locales, and setLocale function.
+ */
+declare function useLocaleSelector(locales?: string[]): {
+    locale: string;
+    locales: string[];
+    setLocale: (locale: string) => void;
+};
+
+export { Branch, ClientProvider, Currency, DateTime, GTContext, GTProvider, LocaleSelector, Num, Plural, T, Var, renderVariable, useDefaultLocale, useDict, useGT, useLocale, useLocaleSelector, useLocales, useRuntimeTranslation, useSetLocale };

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,qBAAqB,MAAM,wCAAwC,CAAC;AAC3E,OAAO,cAAc,MAAM,qCAAqC,CAAC;AACjE,OAAO,cAAc,MAAM,2BAA2B,CAAC;AACvD,OAAO,MAAM,MAAM,mBAAmB,CAAC;AACvC,OAAO,MAAM,MAAM,2BAA2B,CAAC;AAC/C,OAAO,KAAK,MAAM,2BAA2B,CAAC;AAC9C,OAAO,gBAAgB,MAAM,0BAA0B,CAAC;AACxD,OAAO,OAAO,MAAM,6BAA6B,CAAC;AAClD,OAAO,SAAS,MAAM,mBAAmB,CAAC;AAC1C,OAAO,CAAC,MAAM,wBAAwB,CAAC;AACvC,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,GAAG,MAAM,iBAAiB,CAAC;AAClC,OAAO,GAAG,MAAM,iBAAiB,CAAC;AAClC,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EACL,SAAS,EACT,UAAU,EACV,qBAAqB,EACrB,cAAc,EACd,cAAc,EACd,KAAK,EACL,OAAO,EACP,gBAAgB,EAChB,SAAS,EACT,CAAC,EACD,GAAG,EACH,GAAG,EACH,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,MAAM,EACN,cAAc,GACf,CAAC"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,qBAAqB,MAAM,wCAAwC,CAAC;AAC3E,OAAO,cAAc,MAAM,qCAAqC,CAAC;AACjE,OAAO,cAAc,MAAM,2BAA2B,CAAC;AACvD,OAAO,MAAM,MAAM,mBAAmB,CAAC;AACvC,OAAO,MAAM,MAAM,2BAA2B,CAAC;AAC/C,OAAO,KAAK,MAAM,2BAA2B,CAAC;AAC9C,OAAO,gBAAgB,MAAM,0BAA0B,CAAC;AACxD,OAAO,OAAO,MAAM,6BAA6B,CAAC;AAClD,OAAO,SAAS,MAAM,mBAAmB,CAAC;AAC1C,OAAO,CAAC,MAAM,wBAAwB,CAAC;AACvC,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,GAAG,MAAM,iBAAiB,CAAC;AAClC,OAAO,GAAG,MAAM,iBAAiB,CAAC;AAClC,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAC/C,OAAO,YAAY,MAAM,sBAAsB,CAAC;AAChD,OAAO,UAAU,MAAM,oBAAoB,CAAC;AAC5C,OAAO,iBAAiB,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EACL,SAAS,EACT,UAAU,EACV,qBAAqB,EACrB,cAAc,EACd,cAAc,EACd,KAAK,EACL,OAAO,EACP,gBAAgB,EAChB,SAAS,EACT,UAAU,EACV,YAAY,EACZ,iBAAiB,EACjB,CAAC,EACD,GAAG,EACH,GAAG,EACH,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,MAAM,EACN,cAAc,GACf,CAAC"}