gt-react 10.19.14 β 10.19.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +23 -0
- package/dist/browser.cjs +10789 -0
- package/dist/browser.cjs.map +1 -0
- package/dist/browser.d.cts +732 -0
- package/dist/browser.d.cts.map +1 -0
- package/dist/browser.d.mts +734 -0
- package/dist/browser.d.mts.map +1 -0
- package/dist/browser.mjs +10751 -0
- package/dist/browser.mjs.map +1 -0
- package/dist/client.cjs +3356 -0
- package/dist/client.cjs.map +1 -0
- package/dist/client.d.cts +249 -0
- package/dist/client.d.cts.map +1 -0
- package/dist/client.d.mts +250 -0
- package/dist/client.d.mts.map +1 -0
- package/dist/client.mjs +3296 -0
- package/dist/client.mjs.map +1 -0
- package/dist/index.cjs +3509 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +377 -0
- package/dist/index.d.cts.map +1 -0
- package/dist/index.d.mts +376 -0
- package/dist/index.d.mts.map +1 -0
- package/dist/index.mjs +3453 -0
- package/dist/index.mjs.map +1 -0
- package/dist/internal.cjs +3954 -0
- package/dist/internal.cjs.map +1 -0
- package/dist/internal.d.cts +1118 -0
- package/dist/internal.d.cts.map +1 -0
- package/dist/internal.d.mts +1118 -0
- package/dist/internal.d.mts.map +1 -0
- package/dist/internal.mjs +3893 -0
- package/dist/internal.mjs.map +1 -0
- package/dist/macros.cjs +6139 -0
- package/dist/macros.cjs.map +1 -0
- package/dist/macros.d.cts +25 -0
- package/dist/macros.d.cts.map +1 -0
- package/dist/macros.d.mts +25 -0
- package/dist/macros.d.mts.map +1 -0
- package/dist/macros.mjs +6140 -0
- package/dist/macros.mjs.map +1 -0
- package/package.json +61 -53
- package/dist/browser-types.d.ts +0 -5
- package/dist/browser-types.d.ts.map +0 -1
- package/dist/browser.cjs.min.cjs +0 -2
- package/dist/browser.cjs.min.cjs.map +0 -1
- package/dist/browser.d.ts +0 -4
- package/dist/browser.d.ts.map +0 -1
- package/dist/browser.esm.min.mjs +0 -2
- package/dist/browser.esm.min.mjs.map +0 -1
- package/dist/client.cjs.min.cjs +0 -2
- package/dist/client.cjs.min.cjs.map +0 -1
- package/dist/client.d.ts +0 -6
- package/dist/client.d.ts.map +0 -1
- package/dist/client.esm.min.mjs +0 -2
- package/dist/client.esm.min.mjs.map +0 -1
- package/dist/i18n-context/browser-i18n-manager/BrowserConditionStore.d.ts +0 -32
- package/dist/i18n-context/browser-i18n-manager/BrowserConditionStore.d.ts.map +0 -1
- package/dist/i18n-context/browser-i18n-manager/BrowserI18nManager.d.ts +0 -42
- package/dist/i18n-context/browser-i18n-manager/BrowserI18nManager.d.ts.map +0 -1
- package/dist/i18n-context/browser-i18n-manager/LocalStorageTranslationCache.d.ts +0 -90
- package/dist/i18n-context/browser-i18n-manager/LocalStorageTranslationCache.d.ts.map +0 -1
- package/dist/i18n-context/browser-i18n-manager/singleton-operations.d.ts +0 -9
- package/dist/i18n-context/browser-i18n-manager/singleton-operations.d.ts.map +0 -1
- package/dist/i18n-context/browser-i18n-manager/utils/constants.d.ts +0 -3
- package/dist/i18n-context/browser-i18n-manager/utils/constants.d.ts.map +0 -1
- package/dist/i18n-context/browser-i18n-manager/utils/cookies.d.ts +0 -19
- package/dist/i18n-context/browser-i18n-manager/utils/cookies.d.ts.map +0 -1
- package/dist/i18n-context/browser-i18n-manager/utils/determineLocale.d.ts +0 -15
- package/dist/i18n-context/browser-i18n-manager/utils/determineLocale.d.ts.map +0 -1
- package/dist/i18n-context/browser-i18n-manager/utils/types.d.ts +0 -14
- package/dist/i18n-context/browser-i18n-manager/utils/types.d.ts.map +0 -1
- package/dist/i18n-context/functions/branching/GtInternalBranch.d.ts +0 -29
- package/dist/i18n-context/functions/branching/GtInternalBranch.d.ts.map +0 -1
- package/dist/i18n-context/functions/branching/GtInternalPlural.d.ts +0 -30
- package/dist/i18n-context/functions/branching/GtInternalPlural.d.ts.map +0 -1
- package/dist/i18n-context/functions/branching/index.d.ts +0 -3
- package/dist/i18n-context/functions/branching/index.d.ts.map +0 -1
- package/dist/i18n-context/functions/derivation/GtInternalDerive.d.ts +0 -31
- package/dist/i18n-context/functions/derivation/GtInternalDerive.d.ts.map +0 -1
- package/dist/i18n-context/functions/derivation/index.d.ts +0 -2
- package/dist/i18n-context/functions/derivation/index.d.ts.map +0 -1
- package/dist/i18n-context/functions/html-tag-operations.d.ts +0 -19
- package/dist/i18n-context/functions/html-tag-operations.d.ts.map +0 -1
- package/dist/i18n-context/functions/index.d.ts +0 -8
- package/dist/i18n-context/functions/index.d.ts.map +0 -1
- package/dist/i18n-context/functions/locale-operations.d.ts +0 -11
- package/dist/i18n-context/functions/locale-operations.d.ts.map +0 -1
- package/dist/i18n-context/functions/translation/GtInternalRuntimeTranslateJsx.d.ts +0 -11
- package/dist/i18n-context/functions/translation/GtInternalRuntimeTranslateJsx.d.ts.map +0 -1
- package/dist/i18n-context/functions/translation/GtInternalRuntimeTranslateString.d.ts +0 -11
- package/dist/i18n-context/functions/translation/GtInternalRuntimeTranslateString.d.ts.map +0 -1
- package/dist/i18n-context/functions/translation/GtInternalTranslateJsx.d.ts +0 -33
- package/dist/i18n-context/functions/translation/GtInternalTranslateJsx.d.ts.map +0 -1
- package/dist/i18n-context/functions/translation/index.d.ts +0 -5
- package/dist/i18n-context/functions/translation/index.d.ts.map +0 -1
- package/dist/i18n-context/functions/translation/t.d.ts +0 -25
- package/dist/i18n-context/functions/translation/t.d.ts.map +0 -1
- package/dist/i18n-context/functions/translation/types.d.ts +0 -21
- package/dist/i18n-context/functions/translation/types.d.ts.map +0 -1
- package/dist/i18n-context/functions/variables/GtInternalCurrency.d.ts +0 -28
- package/dist/i18n-context/functions/variables/GtInternalCurrency.d.ts.map +0 -1
- package/dist/i18n-context/functions/variables/GtInternalDateTime.d.ts +0 -26
- package/dist/i18n-context/functions/variables/GtInternalDateTime.d.ts.map +0 -1
- package/dist/i18n-context/functions/variables/GtInternalNum.d.ts +0 -26
- package/dist/i18n-context/functions/variables/GtInternalNum.d.ts.map +0 -1
- package/dist/i18n-context/functions/variables/GtInternalRelativeTime.d.ts +0 -35
- package/dist/i18n-context/functions/variables/GtInternalRelativeTime.d.ts.map +0 -1
- package/dist/i18n-context/functions/variables/GtInternalVar.d.ts +0 -23
- package/dist/i18n-context/functions/variables/GtInternalVar.d.ts.map +0 -1
- package/dist/i18n-context/functions/variables/index.d.ts +0 -6
- package/dist/i18n-context/functions/variables/index.d.ts.map +0 -1
- package/dist/i18n-context/functions/variables/utils/computeVar.d.ts +0 -9
- package/dist/i18n-context/functions/variables/utils/computeVar.d.ts.map +0 -1
- package/dist/i18n-context/functions/variables/utils/renderVariable.d.ts +0 -15
- package/dist/i18n-context/functions/variables/utils/renderVariable.d.ts.map +0 -1
- package/dist/i18n-context/setup/bootstrap.d.ts +0 -22
- package/dist/i18n-context/setup/bootstrap.d.ts.map +0 -1
- package/dist/i18n-context/setup/index.d.ts +0 -3
- package/dist/i18n-context/setup/index.d.ts.map +0 -1
- package/dist/i18n-context/setup/initializeGT.d.ts +0 -7
- package/dist/i18n-context/setup/initializeGT.d.ts.map +0 -1
- package/dist/i18n-context/setup/types.d.ts +0 -19
- package/dist/i18n-context/setup/types.d.ts.map +0 -1
- package/dist/i18n-context/ui/LocaleSelector.d.ts +0 -18
- package/dist/i18n-context/ui/LocaleSelector.d.ts.map +0 -1
- package/dist/i18n-context/utils/enforceBrowser.d.ts +0 -7
- package/dist/i18n-context/utils/enforceBrowser.d.ts.map +0 -1
- package/dist/index.cjs.min.cjs +0 -2
- package/dist/index.cjs.min.cjs.map +0 -1
- package/dist/index.d.ts +0 -8
- package/dist/index.d.ts.map +0 -1
- package/dist/index.esm.min.mjs +0 -2
- package/dist/index.esm.min.mjs.map +0 -1
- package/dist/internal.cjs.min.cjs +0 -2
- package/dist/internal.cjs.min.cjs.map +0 -1
- package/dist/internal.d.ts +0 -7
- package/dist/internal.d.ts.map +0 -1
- package/dist/internal.esm.min.mjs +0 -2
- package/dist/internal.esm.min.mjs.map +0 -1
- package/dist/macros.cjs.min.cjs +0 -2
- package/dist/macros.cjs.min.cjs.map +0 -1
- package/dist/macros.d.ts +0 -22
- package/dist/macros.d.ts.map +0 -1
- package/dist/macros.esm.min.mjs +0 -2
- package/dist/macros.esm.min.mjs.map +0 -1
- package/dist/react-context/provider/ClientProvider.d.ts +0 -4
- package/dist/react-context/provider/ClientProvider.d.ts.map +0 -1
- package/dist/react-context/provider/GTProvider.d.ts +0 -29
- package/dist/react-context/provider/GTProvider.d.ts.map +0 -1
- package/dist/react-context/provider/helpers/isSSREnabled.d.ts +0 -2
- package/dist/react-context/provider/helpers/isSSREnabled.d.ts.map +0 -1
- package/dist/react-context/provider/hooks/locales/useDetermineLocale.d.ts +0 -5
- package/dist/react-context/provider/hooks/locales/useDetermineLocale.d.ts.map +0 -1
- package/dist/react-context/provider/hooks/useEnableI18n.d.ts +0 -10
- package/dist/react-context/provider/hooks/useEnableI18n.d.ts.map +0 -1
- package/dist/react-context/provider/hooks/useRegionState.d.ts +0 -9
- package/dist/react-context/provider/hooks/useRegionState.d.ts.map +0 -1
- package/dist/react-context/types/config.d.ts +0 -67
- package/dist/react-context/types/config.d.ts.map +0 -1
- package/dist/react-context/ui/LocaleSelector.d.ts +0 -18
- package/dist/react-context/ui/LocaleSelector.d.ts.map +0 -1
- package/dist/react-context/ui/RegionSelector.d.ts +0 -38
- package/dist/react-context/ui/RegionSelector.d.ts.map +0 -1
- package/dist/react-context/utils/readAuthFromEnv.d.ts +0 -9
- package/dist/react-context/utils/readAuthFromEnv.d.ts.map +0 -1
- package/dist/shared/InternalLocaleSelector.d.ts +0 -26
- package/dist/shared/InternalLocaleSelector.d.ts.map +0 -1
- package/dist/shared/messages.d.ts +0 -11
- package/dist/shared/messages.d.ts.map +0 -1
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,376 @@
|
|
|
1
|
+
import { Branch, Currency, DateTime, Derive, Num, Plural, RelativeTime, Static, T, Var, declareStatic, declareVar, decodeMsg, decodeOptions, decodeVars, derive, gtFallback, mFallback, msg, useDefaultLocale, useGT, useGTClass, useLocale, useLocaleDirection, useLocaleProperties, useLocaleSelector, useLocales, useMessages, useRegion, useRegionSelector, useSetLocale, useTranslations, useVersionId } from "@generaltranslation/react-core";
|
|
2
|
+
import React$1, { ReactNode } from "react";
|
|
3
|
+
//#region ../react-core/dist/types.d.ts
|
|
4
|
+
//#region ../format/dist/types-UnF22q9r.d.cts
|
|
5
|
+
//#region src/locales/customLocaleMapping.d.ts
|
|
6
|
+
type CustomMapping$1 = Record<string, string | Partial<LocaleProperties$1>>; //#endregion
|
|
7
|
+
//#region src/locales/getLocaleProperties.d.ts
|
|
8
|
+
type LocaleProperties$1 = {
|
|
9
|
+
code: string;
|
|
10
|
+
name: string;
|
|
11
|
+
nativeName: string;
|
|
12
|
+
languageCode: string;
|
|
13
|
+
languageName: string;
|
|
14
|
+
nativeLanguageName: string;
|
|
15
|
+
nameWithRegionCode: string;
|
|
16
|
+
nativeNameWithRegionCode: string;
|
|
17
|
+
regionCode: string;
|
|
18
|
+
regionName: string;
|
|
19
|
+
nativeRegionName: string;
|
|
20
|
+
scriptCode: string;
|
|
21
|
+
scriptName: string;
|
|
22
|
+
nativeScriptName: string;
|
|
23
|
+
maximizedCode: string;
|
|
24
|
+
maximizedName: string;
|
|
25
|
+
nativeMaximizedName: string;
|
|
26
|
+
minimizedCode: string;
|
|
27
|
+
minimizedName: string;
|
|
28
|
+
nativeMinimizedName: string;
|
|
29
|
+
emoji: string;
|
|
30
|
+
}; //#endregion
|
|
31
|
+
//#region src/locales/getRegionProperties.d.ts
|
|
32
|
+
//#endregion
|
|
33
|
+
//#region src/types-dir/jsx/variables.d.ts
|
|
34
|
+
type VariableType = 'v' | 'n' | 'd' | 'c' | 'rt';
|
|
35
|
+
/**
|
|
36
|
+
* Variables are used to store the variable name and type.
|
|
37
|
+
*/
|
|
38
|
+
type Variable = {
|
|
39
|
+
k: string;
|
|
40
|
+
i?: number;
|
|
41
|
+
v?: VariableType;
|
|
42
|
+
}; //#endregion
|
|
43
|
+
//#region src/types-dir/jsx/content.d.ts
|
|
44
|
+
/**
|
|
45
|
+
* Map of data-_gt properties to their corresponding React props
|
|
46
|
+
*/
|
|
47
|
+
declare const HTML_CONTENT_PROPS: {
|
|
48
|
+
readonly pl: "placeholder";
|
|
49
|
+
readonly ti: "title";
|
|
50
|
+
readonly alt: "alt";
|
|
51
|
+
readonly arl: "aria-label";
|
|
52
|
+
readonly arb: "aria-labelledby";
|
|
53
|
+
readonly ard: "aria-describedby";
|
|
54
|
+
};
|
|
55
|
+
type HtmlContentPropKeysRecord = Partial<Record<keyof typeof HTML_CONTENT_PROPS, string>>;
|
|
56
|
+
/**
|
|
57
|
+
* GTProp is an internal property used to contain data for translating and rendering elements.
|
|
58
|
+
* note, transformations are only read on the server side if they are 'plural' or 'branch'
|
|
59
|
+
*/
|
|
60
|
+
type GTProp = {
|
|
61
|
+
b?: Record<string, JsxChildren>;
|
|
62
|
+
t?: 'p' | 'b';
|
|
63
|
+
} & HtmlContentPropKeysRecord;
|
|
64
|
+
type JsxElement = {
|
|
65
|
+
t?: string;
|
|
66
|
+
i?: number;
|
|
67
|
+
d?: GTProp;
|
|
68
|
+
c?: JsxChildren;
|
|
69
|
+
};
|
|
70
|
+
type JsxChild = string | JsxElement | Variable;
|
|
71
|
+
/**
|
|
72
|
+
* The format of the string content
|
|
73
|
+
*/
|
|
74
|
+
type StringFormat = 'ICU' | 'I18NEXT' | 'STRING';
|
|
75
|
+
/**
|
|
76
|
+
* The format of the content.
|
|
77
|
+
*/
|
|
78
|
+
type DataFormat = 'JSX' | StringFormat;
|
|
79
|
+
/**
|
|
80
|
+
* String format content.
|
|
81
|
+
*/
|
|
82
|
+
/**
|
|
83
|
+
* A content type representing JSX elements.
|
|
84
|
+
*/
|
|
85
|
+
type JsxChildren = JsxChild | JsxChild[];
|
|
86
|
+
/**
|
|
87
|
+
* A content type representing ICU messages.
|
|
88
|
+
*/
|
|
89
|
+
//#endregion
|
|
90
|
+
//#region ../core/dist/types-YrrGRHBP.d.cts
|
|
91
|
+
//#endregion
|
|
92
|
+
//#region src/types.d.ts
|
|
93
|
+
/**
|
|
94
|
+
* @deprecated Use {@link Content} instead.
|
|
95
|
+
*/
|
|
96
|
+
//#endregion
|
|
97
|
+
//#region ../i18n/dist/options-D0Lnxv2X.d.cts
|
|
98
|
+
//#region src/translation-functions/types/options.d.ts
|
|
99
|
+
type BaseTranslationOptions = Record<string, unknown>;
|
|
100
|
+
type DictionaryTranslationOptions = BaseTranslationOptions;
|
|
101
|
+
/**
|
|
102
|
+
* Options for string resolution
|
|
103
|
+
* Used by the gt() function
|
|
104
|
+
*/
|
|
105
|
+
type InlineTranslationOptions = BaseTranslationOptions & {
|
|
106
|
+
$context?: string;
|
|
107
|
+
$id?: string; /** The data format for the message (e.g., 'ICU', 'STRING'). Defaults to 'ICU'. */
|
|
108
|
+
$format?: StringFormat; /** The locale to use for formatting the message. */
|
|
109
|
+
$locale?: string;
|
|
110
|
+
/**
|
|
111
|
+
* @deprecated use {@link $locale} instead
|
|
112
|
+
*/
|
|
113
|
+
$_locales?: string | string[];
|
|
114
|
+
$_hash?: string;
|
|
115
|
+
$maxChars?: number; /** @deprecated use {@link EncodedTranslationOptions} instead */
|
|
116
|
+
$_source?: string;
|
|
117
|
+
};
|
|
118
|
+
/**
|
|
119
|
+
* Options for string resolution
|
|
120
|
+
* Used by the m() function
|
|
121
|
+
*/
|
|
122
|
+
/**
|
|
123
|
+
* Options for runtime translation
|
|
124
|
+
* Used by the tx() function
|
|
125
|
+
*/
|
|
126
|
+
type RuntimeTranslationOptions = {
|
|
127
|
+
$locale?: string;
|
|
128
|
+
$format?: DataFormat;
|
|
129
|
+
} & Omit<InlineTranslationOptions, '$id' | '$format'>;
|
|
130
|
+
/**
|
|
131
|
+
* Options for JSX translation
|
|
132
|
+
* Used by the resolveJsxTranslation() function
|
|
133
|
+
*/
|
|
134
|
+
//#endregion
|
|
135
|
+
//#region ../i18n/dist/functions-DI1QpQoC.d.cts
|
|
136
|
+
/**
|
|
137
|
+
* Synchronous resolution function type
|
|
138
|
+
* @param {string} message - The message to translate.
|
|
139
|
+
* @param {InlineTranslationOptions} options - The options for the translation.
|
|
140
|
+
* @returns {string} The translated message.
|
|
141
|
+
*
|
|
142
|
+
* @important This is base type for user API
|
|
143
|
+
*
|
|
144
|
+
* TODO: next major version, this should be <T extends string | null | undefined>(message: T, options?: InlineTranslationOptions) => T extends string ? string : T;
|
|
145
|
+
*/
|
|
146
|
+
/**
|
|
147
|
+
* For dictionaries, we have Entry and MetaEntry
|
|
148
|
+
*/
|
|
149
|
+
type Entry = string;
|
|
150
|
+
type MetaEntry = {
|
|
151
|
+
$context?: string;
|
|
152
|
+
$maxChars?: number;
|
|
153
|
+
$_hash?: string;
|
|
154
|
+
[key: string]: unknown;
|
|
155
|
+
};
|
|
156
|
+
type DictionaryEntry = Entry | [Entry] | [Entry, MetaEntry];
|
|
157
|
+
type Dictionary = {
|
|
158
|
+
[key: string]: Dictionary | DictionaryEntry;
|
|
159
|
+
} | (Dictionary | DictionaryEntry)[];
|
|
160
|
+
/**
|
|
161
|
+
* Translated content types
|
|
162
|
+
* TODO: move these types to JsxElement etc from generaltranslation/types
|
|
163
|
+
* remember to omit the t property (tag name) from the translated element
|
|
164
|
+
*/
|
|
165
|
+
type TranslatedElement = {
|
|
166
|
+
i?: number;
|
|
167
|
+
d?: GTProp;
|
|
168
|
+
c?: TranslatedChildren;
|
|
169
|
+
};
|
|
170
|
+
type TranslatedChild = TranslatedElement | string | Variable;
|
|
171
|
+
type TranslatedChildren = TranslatedChild | TranslatedChild[];
|
|
172
|
+
type Translations = {
|
|
173
|
+
[hash: string]: TranslatedChildren | null;
|
|
174
|
+
};
|
|
175
|
+
/**
|
|
176
|
+
* @deprecated use {@link Dictionary}
|
|
177
|
+
*/
|
|
178
|
+
type CustomLoader = (locale: string) => Promise<unknown>;
|
|
179
|
+
type RenderMethod = 'skeleton' | 'replace' | 'default';
|
|
180
|
+
//#endregion
|
|
181
|
+
//#region src/provider/hooks/locales/types.d.ts
|
|
182
|
+
type UseDetermineLocaleParams = {
|
|
183
|
+
defaultLocale: string;
|
|
184
|
+
locales: string[];
|
|
185
|
+
enableI18n: boolean;
|
|
186
|
+
locale?: string;
|
|
187
|
+
localeCookieName?: string;
|
|
188
|
+
ssr?: boolean;
|
|
189
|
+
customMapping?: CustomMapping$1;
|
|
190
|
+
reloadOnLocaleUpdate?: boolean;
|
|
191
|
+
};
|
|
192
|
+
type UseDetermineLocaleReturn = [string, (locale: string) => void]; //#endregion
|
|
193
|
+
//#region src/provider/hooks/types.d.ts
|
|
194
|
+
//#endregion
|
|
195
|
+
//#region src/types-dir/config.d.ts
|
|
196
|
+
type GTConfig = {
|
|
197
|
+
projectId?: string;
|
|
198
|
+
devApiKey?: string;
|
|
199
|
+
locales?: string[];
|
|
200
|
+
defaultLocale?: string;
|
|
201
|
+
dictionary?: string;
|
|
202
|
+
runtimeUrl?: string | null;
|
|
203
|
+
cacheUrl?: string | null;
|
|
204
|
+
renderSettings?: {
|
|
205
|
+
method: RenderMethod;
|
|
206
|
+
timeout?: number;
|
|
207
|
+
};
|
|
208
|
+
_versionId?: string;
|
|
209
|
+
ssr?: boolean;
|
|
210
|
+
localeCookieName?: string;
|
|
211
|
+
customMapping?: CustomMapping$1;
|
|
212
|
+
modelProvider?: string;
|
|
213
|
+
enableI18n?: boolean;
|
|
214
|
+
};
|
|
215
|
+
//#endregion
|
|
216
|
+
//#region ../format/dist/types-UnF22q9r.d.cts
|
|
217
|
+
//#region src/locales/customLocaleMapping.d.ts
|
|
218
|
+
type CustomMapping = Record<string, string | Partial<LocaleProperties>>; //#endregion
|
|
219
|
+
//#region src/locales/getLocaleProperties.d.ts
|
|
220
|
+
type LocaleProperties = {
|
|
221
|
+
code: string;
|
|
222
|
+
name: string;
|
|
223
|
+
nativeName: string;
|
|
224
|
+
languageCode: string;
|
|
225
|
+
languageName: string;
|
|
226
|
+
nativeLanguageName: string;
|
|
227
|
+
nameWithRegionCode: string;
|
|
228
|
+
nativeNameWithRegionCode: string;
|
|
229
|
+
regionCode: string;
|
|
230
|
+
regionName: string;
|
|
231
|
+
nativeRegionName: string;
|
|
232
|
+
scriptCode: string;
|
|
233
|
+
scriptName: string;
|
|
234
|
+
nativeScriptName: string;
|
|
235
|
+
maximizedCode: string;
|
|
236
|
+
maximizedName: string;
|
|
237
|
+
nativeMaximizedName: string;
|
|
238
|
+
minimizedCode: string;
|
|
239
|
+
minimizedName: string;
|
|
240
|
+
nativeMinimizedName: string;
|
|
241
|
+
emoji: string;
|
|
242
|
+
}; //#endregion
|
|
243
|
+
//#region src/locales/getRegionProperties.d.ts
|
|
244
|
+
//#endregion
|
|
245
|
+
//#region src/react-context/types/config.d.ts
|
|
246
|
+
type GTProviderProps = {
|
|
247
|
+
children?: React.ReactNode;
|
|
248
|
+
projectId?: string;
|
|
249
|
+
devApiKey?: string;
|
|
250
|
+
dictionary?: Dictionary;
|
|
251
|
+
locales?: string[];
|
|
252
|
+
defaultLocale?: string;
|
|
253
|
+
locale?: string;
|
|
254
|
+
region?: string;
|
|
255
|
+
cacheUrl?: string | null;
|
|
256
|
+
runtimeUrl?: string | null;
|
|
257
|
+
renderSettings?: {
|
|
258
|
+
method: RenderMethod;
|
|
259
|
+
timeout?: number;
|
|
260
|
+
};
|
|
261
|
+
_versionId?: string;
|
|
262
|
+
ssr?: boolean;
|
|
263
|
+
localeCookieName?: string;
|
|
264
|
+
translations?: Translations | null;
|
|
265
|
+
loadDictionary?: CustomLoader;
|
|
266
|
+
loadTranslations?: CustomLoader;
|
|
267
|
+
config?: GTConfig;
|
|
268
|
+
fallback?: React.ReactNode;
|
|
269
|
+
customMapping?: CustomMapping;
|
|
270
|
+
modelProvider?: string;
|
|
271
|
+
enableI18n?: boolean;
|
|
272
|
+
enableI18nLoaded?: boolean;
|
|
273
|
+
/**
|
|
274
|
+
* @internal - internal use only
|
|
275
|
+
* TODO: this should have a separate export for internal use
|
|
276
|
+
*/
|
|
277
|
+
useDetermineLocale?: (params: UseDetermineLocaleParams) => UseDetermineLocaleReturn;
|
|
278
|
+
reloadOnLocaleUpdate?: boolean;
|
|
279
|
+
[key: string]: unknown;
|
|
280
|
+
};
|
|
281
|
+
//#endregion
|
|
282
|
+
//#region src/react-context/provider/GTProvider.d.ts
|
|
283
|
+
/**
|
|
284
|
+
* Provides General Translation context to its children, which can then access `useGT`, `useLocale`, and `useDefaultLocale`.
|
|
285
|
+
*
|
|
286
|
+
* @param {React.ReactNode} children - The children components that will use the translation context.
|
|
287
|
+
* @param {string} [projectId] - The project ID required for General Translation cloud services.
|
|
288
|
+
* @param {Dictionary} [dictionary=defaultDictionary] - The translation dictionary for the project.
|
|
289
|
+
* @param {string[]} [locales] - The list of approved locales for the project.
|
|
290
|
+
* @param {string} [defaultLocale=libraryDefaultLocale] - The default locale to use if no other locale is found.
|
|
291
|
+
* @param {string} [locale] - The current locale, if already set.
|
|
292
|
+
* @param {string} [cacheUrl='https://cdn.gtx.dev'] - The URL of the cache service for fetching translations.
|
|
293
|
+
* @param {string} [runtimeUrl='https://runtime.gtx.dev'] - The URL of the runtime service for fetching translations.
|
|
294
|
+
* @param {RenderSettings} [renderSettings=defaultRenderSettings] - The settings for rendering translations.
|
|
295
|
+
* @param {string} [_versionId] - The version ID for fetching translations.
|
|
296
|
+
* @param {string} [devApiKey] - The API key for development environments.
|
|
297
|
+
* @param {object} [metadata] - Additional metadata to pass to the context.
|
|
298
|
+
* @param {boolean} [ssr=isSSREnabled()] - Whether to enable server-side rendering.
|
|
299
|
+
* @param {string} [localeCookieName=defaultLocaleCookieName] - The name of the cookie to store the locale.
|
|
300
|
+
* @param {boolean} [enableI18n=true] - Whether to enable i18n.
|
|
301
|
+
* @param {boolean|undefined} [enableI18nLoaded=undefined] - Flag to indicate if the enableI18n flag is finished loading asynchronously. Undefined means flag is loaded synchronously.
|
|
302
|
+
* @param {Translations | null} [translations=null] - The translations to use for the context.
|
|
303
|
+
* @param {React.ReactNode} [fallback = undefined] - Custom fallback to display while loading
|
|
304
|
+
*
|
|
305
|
+
* @returns {JSX.Element} The provider component for General Translation context.
|
|
306
|
+
*/
|
|
307
|
+
declare function GTProvider(props: GTProviderProps): React$1.JSX.Element;
|
|
308
|
+
//#endregion
|
|
309
|
+
//#region src/react-context/ui/LocaleSelector.d.ts
|
|
310
|
+
/**
|
|
311
|
+
* A dropdown component that allows users to select a locale.
|
|
312
|
+
* @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.
|
|
313
|
+
* @param {object} [customNames] - (deprecated) An optional object to map locales to custom names. Use `customMapping` instead.
|
|
314
|
+
* @param {CustomMapping} [customMapping] - An optional object to map locales to custom display names, emojis, or other properties.
|
|
315
|
+
* @returns {React.ReactElement | null} The rendered locale dropdown component or null to prevent rendering.
|
|
316
|
+
*/
|
|
317
|
+
declare function LocaleSelector({
|
|
318
|
+
locales: _locales,
|
|
319
|
+
...props
|
|
320
|
+
}: {
|
|
321
|
+
locales?: string[];
|
|
322
|
+
customNames?: {
|
|
323
|
+
[key: string]: string;
|
|
324
|
+
};
|
|
325
|
+
customMapping?: CustomMapping;
|
|
326
|
+
[key: string]: unknown;
|
|
327
|
+
}): React$1.JSX.Element | null;
|
|
328
|
+
//#endregion
|
|
329
|
+
//#region src/react-context/ui/RegionSelector.d.ts
|
|
330
|
+
/**
|
|
331
|
+
* A dropdown component that allows users to select a region.
|
|
332
|
+
*
|
|
333
|
+
* @param {string[]} [regions] - An optional array of ISO 3166 region codes to display. If not provided, regions are inferred from supported locales in the `<GTProvider>` context.
|
|
334
|
+
* @param {React.ReactNode} [placeholder] - Optional placeholder node to display as the first option when no region is selected.
|
|
335
|
+
* @param {object} [customMapping] - An optional object to map region codes to custom display names, emojis, or associated locales. The value can be a string (display name) or an object with `name`, `emoji`, and/or `locale` properties.
|
|
336
|
+
* @param {boolean} [prioritizeCurrentLocaleRegion] - If true, the region corresponding to the current locale is prioritized in the list.
|
|
337
|
+
* @param {boolean} [sortRegionsAlphabetically] - If true, regions are sorted alphabetically by display name.
|
|
338
|
+
* @param {boolean} [asLocaleSelector=false] - If true, selecting a region will also update the locale to the region's associated locale.
|
|
339
|
+
* @param {object} [props] - Additional props to pass to the underlying `<select>` element.
|
|
340
|
+
* @returns {React.JSX.Element | null} The rendered region dropdown component or null if no regions are available.
|
|
341
|
+
*
|
|
342
|
+
* @example
|
|
343
|
+
* ```tsx
|
|
344
|
+
* <RegionSelector
|
|
345
|
+
* regions={['US', 'CA']}
|
|
346
|
+
* customMapping={{ US: { name: "United States", emoji: "πΊπΈ" } }}
|
|
347
|
+
* placeholder="Select a region"
|
|
348
|
+
* />
|
|
349
|
+
* ```
|
|
350
|
+
*/
|
|
351
|
+
declare function RegionSelector<Regions extends string[]>({
|
|
352
|
+
regions: _regions,
|
|
353
|
+
placeholder,
|
|
354
|
+
customMapping,
|
|
355
|
+
prioritizeCurrentLocaleRegion,
|
|
356
|
+
sortRegionsAlphabetically,
|
|
357
|
+
asLocaleSelector,
|
|
358
|
+
...props
|
|
359
|
+
}: {
|
|
360
|
+
regions?: Regions;
|
|
361
|
+
placeholder?: ReactNode;
|
|
362
|
+
customMapping?: {
|
|
363
|
+
[region: string]: string | {
|
|
364
|
+
name?: string;
|
|
365
|
+
locale?: string;
|
|
366
|
+
emoji?: string;
|
|
367
|
+
};
|
|
368
|
+
};
|
|
369
|
+
prioritizeCurrentLocaleRegion?: boolean;
|
|
370
|
+
sortRegionsAlphabetically?: boolean;
|
|
371
|
+
asLocaleSelector?: boolean;
|
|
372
|
+
[key: string]: unknown;
|
|
373
|
+
}): React$1.JSX.Element | null;
|
|
374
|
+
//#endregion
|
|
375
|
+
export { Branch, Currency, DateTime, Derive, type DictionaryTranslationOptions, GTProvider, type InlineTranslationOptions, LocaleSelector, Num, Plural, RegionSelector, RelativeTime, type RuntimeTranslationOptions, Static, T, Var, declareStatic, declareVar, decodeMsg, decodeOptions, decodeVars, derive, gtFallback, mFallback, msg, useDefaultLocale, useGT, useGTClass, useLocale, useLocaleDirection, useLocaleProperties, useLocaleSelector, useLocales, useMessages, useRegion, useRegionSelector, useSetLocale, useTranslations, useVersionId };
|
|
376
|
+
//# sourceMappingURL=index.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.mts","names":["React","ReactNode","GT","CustomMapping","LocaleProperties","Partial","Record","code","name","nativeName","languageCode","languageName","nativeLanguageName","nameWithRegionCode","nativeNameWithRegionCode","regionCode","regionName","nativeRegionName","scriptCode","scriptName","nativeScriptName","maximizedCode","maximizedName","nativeMaximizedName","minimizedCode","minimizedName","nativeMinimizedName","emoji","VariableType","Variable","k","i","v","HTML_CONTENT_PROPS","pl","ti","alt","arl","arb","ard","HtmlContentPropKeysRecord","GTProp","JsxChildren","b","t","JsxElement","d","c","JsxChild","StringFormat","DataFormat","TransformationPrefix","VariableTransformationSuffix","InjectionType","BaseTranslationOptions","DictionaryTranslationOptions","InlineTranslationOptions","$context","$id","$format","$locale","$_locales","$_hash","$maxChars","$_source","RuntimeTranslationOptions","Omit","SyncResolutionFunctionWithFallback","message","options","GTFunctionType","MFunctionType","T","encodedMsg","GTTag","TaggedChildren","id","injectionType","transformation","branches","variableType","TaggedElementProps","Key","children","branch","n","key","TaggedElement","ReactElement","TaggedChild","Exclude","Entry","MetaEntry","DictionaryEntry","Dictionary","FlattenedDictionary","TranslatedElement","TranslatedChildren","TranslatedChild","Translations","hash","DictionaryContent","DictionaryObject","LocalesDictionary","locale","CustomLoader","Promise","RenderMethod","RelativeTimeFormatOptions","Intl","RelativeTimeFormatUnit","Date","unit","baseDate","VariableProps","NumberFormatOptions","DateTimeFormatOptions","variableValue","variableOptions","variableName","RenderVariable","locales","_Message","_Messages","TranslateIcuCallback","source","targetLocale","metadata","context","maxChars","params","TranslateChildrenCallback","GTContextType","gt","registerIcuForTranslation","registerJsxForTranslation","_gtFunction","preloadedTranslations","_mFunction","_filterMessagesForPreload","_messages","_preloadMessages","_dictionaryFunction","_dictionaryObjFunction","idWithParent","developmentApiEnabled","setLocale","defaultLocale","region","setRegion","translations","translationRequired","dialectTranslationRequired","renderSettings","method","timeout","projectId","_versionId","AuthFromEnvParams","devApiKey","AuthFromEnvReturn","UseDetermineLocaleParams","enableI18n","localeCookieName","ssr","customMapping","reloadOnLocaleUpdate","UseDetermineLocaleReturn","UseRegionStateParams","_region","regionCookieName","UseRegionStateReturn","UseEnableI18nParams","enableI18nCookieName","enableI18nLoaded","UseEnableI18nReturn","LocaleSelectorProps","customNames","RegionSelectorProps","Regions","regions","placeholder","prioritizeCurrentLocaleRegion","sortRegionsAlphabetically","GTConfig","dictionary","runtimeUrl","cacheUrl","modelProvider","InternalGTProviderProps","loadDictionary","loadTranslations","config","fallback","environment","readAuthFromEnv","useDetermineLocale","useRegionState","useEnableI18n","Metadata","CustomMapping","LocaleProperties","Partial","Record","code","name","nativeName","languageCode","languageName","nativeLanguageName","nameWithRegionCode","nativeNameWithRegionCode","regionCode","regionName","nativeRegionName","scriptCode","scriptName","nativeScriptName","maximizedCode","maximizedName","nativeMaximizedName","minimizedCode","minimizedName","nativeMinimizedName","emoji","CustomRegionMapping","region","locale","CutoffFormatStyle","TerminatorOptions","terminator","separator","CutoffFormatOptions","maxChars","style","VariableType","Variable","k","i","v","HTML_CONTENT_PROPS","pl","ti","alt","arl","arb","ard","HtmlContentPropKeysRecord","HtmlContentPropValuesRecord","GTProp","JsxChildren","b","t","JsxElement","d","c","JsxChild","StringFormat","DataFormat","StringContent","IcuMessage","StringMessage","I18nextMessage","Content","FormatVariables","Date","_","a","f","g","h","l","m","n","o","p","r","s","u","x","y"],"sources":["../../react-core/dist/types.d.ts","../../format/dist/types-UnF22q9r.d.cts","../src/react-context/types/config.ts","../src/react-context/provider/GTProvider.tsx","../src/react-context/ui/LocaleSelector.tsx","../src/react-context/ui/RegionSelector.tsx"],"mappings":";;;;;KAKKG,eAAAA,GAAgBG,MAAAA,kBAAwBD,OAAAA,CAAQD,kBAAAA;AAAAA;AAAAA,KAEhDA,kBAAAA;EACHG,IAAAA;EACAC,IAAAA;EACAC,UAAAA;EACAC,YAAAA;EACAC,YAAAA;EACAC,kBAAAA;EACAC,kBAAAA;EACAC,wBAAAA;EACAC,UAAAA;EACAC,UAAAA;EACAC,gBAAAA;EACAC,UAAAA;EACAC,UAAAA;EACAC,gBAAAA;EACAC,aAAAA;EACAC,aAAAA;EACAC,mBAAAA;EACAC,aAAAA;EACAC,aAAAA;EACAC,mBAAAA;EACAC,KAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA,KAKGC,YAAAA;;;;KAIAC,QAAAA;EACHC,CAAAA;EACAC,CAAAA;EACAC,CAAAA,GAAIJ,YAAAA;AAAAA;AAAAA;;;AAZC;cAkBOK,kBAAAA;EAAAA,SACHC,EAAAA;EAAAA,SACAC,EAAAA;EAAAA,SACAC,GAAAA;EAAAA,SACAC,GAAAA;EAAAA,SACAC,GAAAA;EAAAA,SACAC,GAAAA;AAAAA;AAAAA,KAENC,yBAAAA,GAA4BnC,OAAAA,CAAQC,MAAAA,cAAoB2B,kBAAAA;;;;;KAKxDQ,MAAAA;EACHE,CAAAA,GAAIrC,MAAAA,SAAeoC,WAAAA;EACnBE,CAAAA;AAAAA,IACEJ,yBAAAA;AAAAA,KACCK,UAAAA;EACHD,CAAAA;EACAb,CAAAA;EACAe,CAAAA,GAAIL,MAAAA;EACJM,CAAAA,GAAIL,WAAAA;AAAAA;AAAAA,KAEDM,QAAAA,YAAoBH,UAAAA,GAAahB,QAAAA;;;AAjBxB;KAqBToB,YAAAA;;;;KAIAC,UAAAA,WAAqBD,YAAAA;;;;;;;KAOrBP,WAAAA,GAAcM,QAAAA,GAAWA,QAAAA;AA9BiD;;;AAAA;AAAA;AAAA;AAAA;;;;;;;KA8C1EM,sBAAAA,GAAyBhD,MAAAA;AAAAA,KACzBiD,4BAAAA,GAA+BD,sBAAAA;;;;;KAK/BE,wBAAAA,GAA2BF,sBAAAA;EAC9BG,QAAAA;EACAC,GAAAA,WAzCAX;EA0CAY,OAAAA,GAAUV,YAAAA,EA1CNP;EA2CJkB,OAAAA;EA3Ce;AAAA;;EA+CfC,SAAAA;EACAC,MAAAA;EACAC,SAAAA,WA/C4C;EAgD5CC,QAAAA;AAAAA;;;;AA5Ce;;;;;KAsDZC,yBAAAA;EACHL,OAAAA;EACAD,OAAAA,GAAUT,UAAAA;AAAAA,IACRgB,IAAAA,CAAKV,wBAAAA;;AAtCS;;;;;AAQkB;;;;;AACsB;;;;;;;;KAgGrDmC,KAAAA;AAAAA,KACAC,SAAAA;EACHnC,QAAAA;EACAM,SAAAA;EACAD,MAAAA;EAAAA,CACCwB,GAAAA;AAAAA;AAAAA,KAEEO,eAAAA,GAAkBF,KAAAA,IAASA,KAAAA,KAAUA,KAAAA,EAAOC,SAAAA;AAAAA,KAC5CE,UAAAA;EAAAA,CACFR,GAAAA,WAAcQ,UAAAA,GAAaD,eAAAA;AAAAA,KACzBC,UAAAA,GAAaD,eAAAA;;;;;;KASbG,iBAAAA;EACHjE,CAAAA;EACAe,CAAAA,GAAIL,MAAAA;EACJM,CAAAA,GAAIkD,kBAAAA;AAAAA;AAAAA,KAEDC,eAAAA,GAAkBF,iBAAAA,YAA6BnE,QAAAA;AAAAA,KAC/CoE,kBAAAA,GAAqBC,eAAAA,GAAkBA,eAAAA;AAAAA,KACvCC,YAAAA;EAAAA,CACFC,IAAAA,WAAeH,kBAAAA;AAAAA;;;;KAebQ,YAAAA,IAAgBD,MAAAA,aAAmBE,OAAAA;AAAAA,KACnCC,YAAAA;AAAAA;AAAAA;AAAAA,KA0FAsD,wBAAAA;EACHd,aAAAA;EACA1B,OAAAA;EACAyC,UAAAA;EACA1D,MAAAA;EACA2D,gBAAAA;EACAC,GAAAA;EACAC,aAAAA,GAAgBlK,eAAAA;EAChBmK,oBAAAA;AAAAA;AAAAA,KAEGC,wBAAAA,aAAqC/D,MAAAA;AAAAA;AAAAA;AAAAA;AAAAA,KAwCrCgF,QAAAA;EACH5B,SAAAA;EACAG,SAAAA;EACAtC,OAAAA;EACA0B,aAAAA;EACAsC,UAAAA;EACAC,UAAAA;EACAC,QAAAA;EACAlC,cAAAA;IACEC,MAAAA,EAAQ/C,YAAAA;IACRgD,OAAAA;EAAAA;EAEFE,UAAAA;EACAO,GAAAA;EACAD,gBAAAA;EACAE,aAAAA,GAAgBlK,eAAAA;EAChByL,aAAAA;EACA1B,UAAAA;AAAAA;;;;KC5YGsC,aAAAA,GAAgBG,MAAAA,kBAAwBD,OAAAA,CAAQD,gBAAAA;AAAAA;AAAAA,KAGhDA,gBAAAA;EACHG,IAAAA;EACAC,IAAAA;EACAC,UAAAA;EACAC,YAAAA;EACAC,YAAAA;EACAC,kBAAAA;EACAC,kBAAAA;EACAC,wBAAAA;EACAC,UAAAA;EACAC,UAAAA;EACAC,gBAAAA;EACAC,UAAAA;EACAC,UAAAA;EACAC,gBAAAA;EACAC,aAAAA;EACAC,aAAAA;EACAC,mBAAAA;EACAC,aAAAA;EACAC,aAAAA;EACAC,mBAAAA;EACAC,KAAAA;AAAAA;AAAAA;;;KCkBU,eAAA;EACV,QAAA,GAAW,KAAA,CAAM,SAAA;EACjB,SAAA;EACA,SAAA;EACA,UAAA,GAAa,UAAA;EACb,OAAA;EACA,aAAA;EACA,MAAA;EACA,MAAA;EACA,QAAA;EACA,UAAA;EACA,cAAA;IACE,MAAA,EAAQ,YAAA;IACR,OAAA;EAAA;EAEF,UAAA;EACA,GAAA;EACA,gBAAA;EACA,YAAA,GAAe,YAAA;EACf,cAAA,GAAiB,YAAA;EACjB,gBAAA,GAAmB,YAAA;EACnB,MAAA,GAAS,QAAA;EACT,QAAA,GAAW,KAAA,CAAM,SAAA;EACjB,aAAA,GAAgB,aAAA;EAChB,aAAA;EACA,UAAA;EACA,gBAAA;EF7BgB;;AAAA;;EEkChB,kBAAA,IACE,MAAA,EAAQ,wBAAA,KACL,wBAAA;EACL,oBAAA;EAAA,CACC,GAAA;AAAA;;;;;;AF7EqC;;;;;;;;;;;;;AAI6B;;;;;;;;iBG4BrD,UAAA,CAAW,KAAA,EAAO,eAAA,GAAkB,OAAA,CAAM,GAAA,CAAI,OAAA;;;;;;AHhCtB;;;;iBIWhB,cAAA,CAAA;EACtB,OAAA,EAAS,QAAA;EAAA,GACN;AAAA;EAEH,OAAA;EACA,WAAA;IAAA,CAAiB,GAAA;EAAA;EACjB,aAAA,GAAgB,aAAA;EAAA,CACf,GAAA;AAAA,IACC,OAAA,CAAM,GAAA,CAAI,OAAA;;;;;;;AJnB0B;;;;;;;;;;;;;AAI6B;;;;iBKmB7C,cAAA,0BAAA,CAAA;EACtB,OAAA,EAAS,QAAA;EACT,WAAA;EACA,aAAA;EACA,6BAAA;EACA,yBAAA;EACA,gBAAA;EAAA,GACG;AAAA;EAEH,OAAA,GAAU,OAAA;EACV,WAAA,GAAc,SAAA;EACd,aAAA;IAAA,CACG,MAAA;MAEK,IAAA;MAAe,MAAA;MAAiB,KAAA;IAAA;EAAA;EAExC,6BAAA;EACA,yBAAA;EACA,gBAAA;EAAA,CACC,GAAA;AAAA,IACC,OAAA,CAAM,GAAA,CAAI,OAAA"}
|