gt-react 10.18.0 → 10.18.1

package/dist/i18n-context/browser-i18n-manager/BrowserI18nManager.d.ts

@@ -1,12 +1,21 @@
 import { I18nManager } from 'gt-i18n/internal';
 import type { I18nManagerConstructorParams } from 'gt-i18n/internal/types';
 import type { BrowserStorageAdapter } from './BrowserStorageAdapter';
+import type { HtmlTagOptions } from './utils/types';
 import { Translation } from 'gt-i18n/types';
+/**
+ * The configuration for the BrowserI18nManager
+ */
+type BrowserI18nManagerConstructorParams = I18nManagerConstructorParams<BrowserStorageAdapter> & {
+    htmlTagOptions?: HtmlTagOptions;
+};
 /**
  * I18nManager implementation for Browser.
  */
 export declare class BrowserI18nManager extends I18nManager<BrowserStorageAdapter, Translation> {
-    constructor(config: I18nManagerConstructorParams<BrowserStorageAdapter>);
+    /** Customize browser-related behavior */
+    private htmlTagOptions?;
+    constructor(config: BrowserI18nManagerConstructorParams);
     /**
      * Load translations for a given locale
      * @param {string} locale - The locale to load translations for
@@ -26,5 +35,13 @@ export declare class BrowserI18nManager extends I18nManager<BrowserStorageAdapte
      * @note This function causes a page reload
      */
     setLocale(locale: string): void;
+    /**
+     * Update the html tag (lang, dir)
+     */
+    updateHtmlTag(htmlTagOptions?: {
+        lang?: string;
+        dir?: 'ltr' | 'rtl';
+    } & HtmlTagOptions): void;
 }
+export {};
 //# sourceMappingURL=BrowserI18nManager.d.ts.map

package/dist/i18n-context/browser-i18n-manager/BrowserI18nManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BrowserI18nManager.d.ts","sourceRoot":"","sources":["../../../src/i18n-context/browser-i18n-manager/BrowserI18nManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,wBAAwB,CAAC;AAC3E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAGrE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,WAAW,CACjD,qBAAqB,EACrB,WAAW,CACZ;gBACa,MAAM,EAAE,4BAA4B,CAAC,qBAAqB,CAAC;IASvE;;;;OAIG;IACG,gBAAgB,CAAC,MAAM,GAAE,MAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxE;;;OAGG;IACH,SAAS,IAAI,MAAM;IAInB;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;CAQhC"}
+{"version":3,"file":"BrowserI18nManager.d.ts","sourceRoot":"","sources":["../../../src/i18n-context/browser-i18n-manager/BrowserI18nManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,wBAAwB,CAAC;AAC3E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAGpD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAG5C;;GAEG;AACH,KAAK,mCAAmC,GACtC,4BAA4B,CAAC,qBAAqB,CAAC,GAAG;IACpD,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC,CAAC;AAEJ;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,WAAW,CACjD,qBAAqB,EACrB,WAAW,CACZ;IACC,yCAAyC;IACzC,OAAO,CAAC,cAAc,CAAC,CAAiB;gBAE5B,MAAM,EAAE,mCAAmC;IAcvD;;;;OAIG;IACG,gBAAgB,CAAC,MAAM,GAAE,MAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxE;;;OAGG;IACH,SAAS,IAAI,MAAM;IAInB;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAS/B;;OAEG;IACH,aAAa,CACX,cAAc,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;KAAE,GAAG,cAAc,GACvE,IAAI;CA4BR"}

package/dist/i18n-context/browser-i18n-manager/utils/constants.d.ts

@@ -0,0 +1,3 @@
+import type { HtmlTagOptions } from './types';
+export declare const DEFAULT_HTML_TAG_OPTIONS: HtmlTagOptions;
+//# sourceMappingURL=constants.d.ts.map

package/dist/i18n-context/browser-i18n-manager/utils/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/i18n-context/browser-i18n-manager/utils/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C,eAAO,MAAM,wBAAwB,EAAE,cAGtC,CAAC"}

package/dist/i18n-context/browser-i18n-manager/utils/types.d.ts

@@ -2,4 +2,13 @@
  * Type for custom getLocale function
  */
 export type GetLocale = () => string;
+/**
+ * Html tag options
+ * @param {boolean} updateHtmlLangTag - Whether to update the html lang tag on locale change
+ * @param {boolean} updateHtmlDirTag - Whether to update the html dir tag on locale change
+ */
+export type HtmlTagOptions = {
+    updateHtmlLangTag?: boolean;
+    updateHtmlDirTag?: boolean;
+};
 //# sourceMappingURL=types.d.ts.map

package/dist/i18n-context/browser-i18n-manager/utils/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/i18n-context/browser-i18n-manager/utils/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/i18n-context/browser-i18n-manager/utils/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC;AAErC;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC"}

package/dist/i18n-context/functions/html-tag-operations.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Update the html tag lang property
+ * @param {string} locale - The locale to update the html tag lang property to
+ * @returns {void}
+ *
+ * @example
+ * updateHtmlTagLang('en');
+ */
+export declare function updateHtmlTagLang(locale: string): void;
+/**
+ * Update the html tag dir property
+ * @param {string} dir - The direction to update the html tag dir property to
+ * @returns {void}
+ *
+ * @example
+ * updateHtmlTagDir('ltr');
+ */
+export declare function updateHtmlTagDir(dir: 'ltr' | 'rtl'): void;
+//# sourceMappingURL=html-tag-operations.d.ts.map

package/dist/i18n-context/functions/html-tag-operations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"html-tag-operations.d.ts","sourceRoot":"","sources":["../../../src/i18n-context/functions/html-tag-operations.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAOtD;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,KAAK,GAAG,KAAK,GAAG,IAAI,CAOzD"}

package/dist/i18n-context/functions/index.d.ts

@@ -4,4 +4,5 @@ export * from './translation';
 export * from './variables';
 export * from './locale-operations';
 export * from './versionId';
+export * from './html-tag-operations';
 //# sourceMappingURL=index.d.ts.map

package/dist/i18n-context/functions/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/i18n-context/functions/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/i18n-context/functions/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC"}

package/dist/i18n-context/setup/bootstrap.d.ts

@@ -7,13 +7,13 @@ import { InitializeGTParams } from './types';
  * @example
  * import gtConfig from '../gt.config.json';
  *
- * function getTranslations(locale: string) {
- *   return import(`./_gt/${locale}.json`);
+ * async function loadTranslations(locale: string) {
+ *   return (await import(`./_gt/${locale}.json`)).default;
  * }
  *
  * await bootstrap({
  *   ...gtConfig,
- *   getTranslations,
+ *   loadTranslations,
  * });
  *
  * await import('./main.tsx')

package/dist/i18n-context/setup/bootstrap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bootstrap.d.ts","sourceRoot":"","sources":["../../../src/i18n-context/setup/bootstrap.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAE7C;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,SAAS,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAIzE"}
+{"version":3,"file":"bootstrap.d.ts","sourceRoot":"","sources":["../../../src/i18n-context/setup/bootstrap.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAE7C;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,SAAS,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CASzE"}

package/dist/i18n-context/setup/types.d.ts

@@ -1,15 +1,18 @@
 import type { GTConfig, TranslationsLoader } from 'gt-i18n/internal/types';
-import { GetLocale } from '../browser-i18n-manager/utils/types';
+import { GetLocale, HtmlTagOptions } from '../browser-i18n-manager/utils/types';
 /**
  * Parameters for the initializing GT
  * @param {string} params.defaultLocale - The default locale to use
  * @param {string[]} params.locales - The locales to support
- * @param {GetLocale} params.getLocale - The function to get the locale
  * @param {TranslationsLoader} params.loadTranslations - The custom translation loader to use
+ * @param {GetLocale} [params.getLocale] - The function to get the locale
+ * @param {HtmlTagOptions} [params.htmlTagOptions.updateHtmlLangTag] - (true) Whether to update the html lang tag on locale change
+ * @param {HtmlTagOptions} [params.htmlTagOptions.updateHtmlDirTag] - (true) Whether to update the html dir tag on locale change
  */
 export type InitializeGTParams = GTConfig & {
     loadTranslations?: TranslationsLoader;
     getLocale?: GetLocale;
+    htmlTagOptions?: HtmlTagOptions;
 };
 export type { GTConfig, TranslationsLoader } from 'gt-i18n/internal/types';
 export type { GetLocale } from '../browser-i18n-manager/utils/types';

package/dist/i18n-context/setup/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/i18n-context/setup/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAEhE;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG;IAC1C,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;IACtC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAGF,YAAY,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC3E,YAAY,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/i18n-context/setup/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAC;AAEhF;;;;;;;;GAQG;AACH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG;IAC1C,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;IACtC,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC,CAAC;AAGF,YAAY,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC3E,YAAY,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC"}