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
|
@@ -0,0 +1,249 @@
|
|
|
1
|
+
import * as React$2 from "react";
|
|
2
|
+
import React$1, { ReactNode } from "react";
|
|
3
|
+
import { Branch, Currency, DateTime, Derive, GTProvider, 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";
|
|
4
|
+
|
|
5
|
+
//#region ../react-core/dist/types.d.ts
|
|
6
|
+
//#endregion
|
|
7
|
+
//#region src/locales/getRegionProperties.d.ts
|
|
8
|
+
//#endregion
|
|
9
|
+
//#region src/types-dir/jsx/variables.d.ts
|
|
10
|
+
type VariableType = 'v' | 'n' | 'd' | 'c' | 'rt';
|
|
11
|
+
/**
|
|
12
|
+
* Variables are used to store the variable name and type.
|
|
13
|
+
*/
|
|
14
|
+
type Variable = {
|
|
15
|
+
k: string;
|
|
16
|
+
i?: number;
|
|
17
|
+
v?: VariableType;
|
|
18
|
+
}; //#endregion
|
|
19
|
+
//#region src/types-dir/jsx/content.d.ts
|
|
20
|
+
/**
|
|
21
|
+
* Map of data-_gt properties to their corresponding React props
|
|
22
|
+
*/
|
|
23
|
+
declare const HTML_CONTENT_PROPS: {
|
|
24
|
+
readonly pl: "placeholder";
|
|
25
|
+
readonly ti: "title";
|
|
26
|
+
readonly alt: "alt";
|
|
27
|
+
readonly arl: "aria-label";
|
|
28
|
+
readonly arb: "aria-labelledby";
|
|
29
|
+
readonly ard: "aria-describedby";
|
|
30
|
+
};
|
|
31
|
+
type HtmlContentPropKeysRecord = Partial<Record<keyof typeof HTML_CONTENT_PROPS, string>>;
|
|
32
|
+
/**
|
|
33
|
+
* GTProp is an internal property used to contain data for translating and rendering elements.
|
|
34
|
+
* note, transformations are only read on the server side if they are 'plural' or 'branch'
|
|
35
|
+
*/
|
|
36
|
+
type GTProp = {
|
|
37
|
+
b?: Record<string, JsxChildren>;
|
|
38
|
+
t?: 'p' | 'b';
|
|
39
|
+
} & HtmlContentPropKeysRecord;
|
|
40
|
+
type JsxElement = {
|
|
41
|
+
t?: string;
|
|
42
|
+
i?: number;
|
|
43
|
+
d?: GTProp;
|
|
44
|
+
c?: JsxChildren;
|
|
45
|
+
};
|
|
46
|
+
type JsxChild = string | JsxElement | Variable;
|
|
47
|
+
/**
|
|
48
|
+
* The format of the string content
|
|
49
|
+
*/
|
|
50
|
+
/**
|
|
51
|
+
* String format content.
|
|
52
|
+
*/
|
|
53
|
+
/**
|
|
54
|
+
* A content type representing JSX elements.
|
|
55
|
+
*/
|
|
56
|
+
type JsxChildren = JsxChild | JsxChild[];
|
|
57
|
+
/**
|
|
58
|
+
* A content type representing ICU messages.
|
|
59
|
+
*/
|
|
60
|
+
//#endregion
|
|
61
|
+
//#region ../core/dist/types-YrrGRHBP.d.cts
|
|
62
|
+
/**
|
|
63
|
+
* For dictionaries, we have Entry and MetaEntry
|
|
64
|
+
*/
|
|
65
|
+
type Entry = string;
|
|
66
|
+
type MetaEntry = {
|
|
67
|
+
$context?: string;
|
|
68
|
+
$maxChars?: number;
|
|
69
|
+
$_hash?: string;
|
|
70
|
+
[key: string]: unknown;
|
|
71
|
+
};
|
|
72
|
+
type DictionaryEntry = Entry | [Entry] | [Entry, MetaEntry];
|
|
73
|
+
type Dictionary = {
|
|
74
|
+
[key: string]: Dictionary | DictionaryEntry;
|
|
75
|
+
} | (Dictionary | DictionaryEntry)[];
|
|
76
|
+
/**
|
|
77
|
+
* Translated content types
|
|
78
|
+
* TODO: move these types to JsxElement etc from generaltranslation/types
|
|
79
|
+
* remember to omit the t property (tag name) from the translated element
|
|
80
|
+
*/
|
|
81
|
+
type TranslatedElement = {
|
|
82
|
+
i?: number;
|
|
83
|
+
d?: GTProp;
|
|
84
|
+
c?: TranslatedChildren;
|
|
85
|
+
};
|
|
86
|
+
type TranslatedChild = TranslatedElement | string | Variable;
|
|
87
|
+
type TranslatedChildren = TranslatedChild | TranslatedChild[];
|
|
88
|
+
type Translations = {
|
|
89
|
+
[hash: string]: TranslatedChildren | null;
|
|
90
|
+
};
|
|
91
|
+
/**
|
|
92
|
+
* @deprecated use {@link Dictionary}
|
|
93
|
+
*/
|
|
94
|
+
type RenderMethod = 'skeleton' | 'replace' | 'default';
|
|
95
|
+
//#endregion
|
|
96
|
+
//#region ../format/dist/types-UnF22q9r.d.cts
|
|
97
|
+
//#region src/locales/customLocaleMapping.d.ts
|
|
98
|
+
type CustomMapping = Record<string, string | Partial<LocaleProperties>>; //#endregion
|
|
99
|
+
//#region src/locales/getLocaleProperties.d.ts
|
|
100
|
+
type LocaleProperties = {
|
|
101
|
+
code: string;
|
|
102
|
+
name: string;
|
|
103
|
+
nativeName: string;
|
|
104
|
+
languageCode: string;
|
|
105
|
+
languageName: string;
|
|
106
|
+
nativeLanguageName: string;
|
|
107
|
+
nameWithRegionCode: string;
|
|
108
|
+
nativeNameWithRegionCode: string;
|
|
109
|
+
regionCode: string;
|
|
110
|
+
regionName: string;
|
|
111
|
+
nativeRegionName: string;
|
|
112
|
+
scriptCode: string;
|
|
113
|
+
scriptName: string;
|
|
114
|
+
nativeScriptName: string;
|
|
115
|
+
maximizedCode: string;
|
|
116
|
+
maximizedName: string;
|
|
117
|
+
nativeMaximizedName: string;
|
|
118
|
+
minimizedCode: string;
|
|
119
|
+
minimizedName: string;
|
|
120
|
+
nativeMinimizedName: string;
|
|
121
|
+
emoji: string;
|
|
122
|
+
}; //#endregion
|
|
123
|
+
//#region src/locales/getRegionProperties.d.ts
|
|
124
|
+
//#endregion
|
|
125
|
+
//#region src/react-context/types/config.d.ts
|
|
126
|
+
type ClientProviderProps = {
|
|
127
|
+
children: React.ReactNode;
|
|
128
|
+
dictionary: Dictionary;
|
|
129
|
+
dictionaryTranslations: Dictionary;
|
|
130
|
+
translations: Translations;
|
|
131
|
+
locale: string;
|
|
132
|
+
locales: string[];
|
|
133
|
+
region?: string;
|
|
134
|
+
_versionId?: string;
|
|
135
|
+
dictionaryEnabled?: boolean;
|
|
136
|
+
defaultLocale: string;
|
|
137
|
+
translationRequired: boolean;
|
|
138
|
+
dialectTranslationRequired: boolean;
|
|
139
|
+
renderSettings: {
|
|
140
|
+
method: RenderMethod;
|
|
141
|
+
timeout?: number;
|
|
142
|
+
};
|
|
143
|
+
developmentApiEnabled: boolean;
|
|
144
|
+
projectId?: string;
|
|
145
|
+
devApiKey?: string;
|
|
146
|
+
runtimeUrl?: string | null;
|
|
147
|
+
gtServicesEnabled?: boolean;
|
|
148
|
+
localeCookieName?: string;
|
|
149
|
+
resetLocaleCookieName: string;
|
|
150
|
+
regionCookieName?: string;
|
|
151
|
+
customMapping?: CustomMapping;
|
|
152
|
+
environment: 'development' | 'production' | 'test';
|
|
153
|
+
reloadServer: () => void;
|
|
154
|
+
};
|
|
155
|
+
//#endregion
|
|
156
|
+
//#region src/react-context/provider/ClientProvider.d.ts
|
|
157
|
+
declare function ClientProvider({
|
|
158
|
+
children,
|
|
159
|
+
dictionary: _dictionary,
|
|
160
|
+
dictionaryTranslations: _dictionaryTranslations,
|
|
161
|
+
translations: _translations,
|
|
162
|
+
locale: _locale,
|
|
163
|
+
region: _region,
|
|
164
|
+
_versionId,
|
|
165
|
+
defaultLocale,
|
|
166
|
+
translationRequired,
|
|
167
|
+
dialectTranslationRequired,
|
|
168
|
+
locales,
|
|
169
|
+
renderSettings,
|
|
170
|
+
projectId,
|
|
171
|
+
devApiKey,
|
|
172
|
+
runtimeUrl,
|
|
173
|
+
developmentApiEnabled,
|
|
174
|
+
resetLocaleCookieName,
|
|
175
|
+
localeCookieName,
|
|
176
|
+
regionCookieName,
|
|
177
|
+
customMapping,
|
|
178
|
+
environment,
|
|
179
|
+
reloadServer
|
|
180
|
+
}: ClientProviderProps): React$2.JSX.Element;
|
|
181
|
+
//#endregion
|
|
182
|
+
//#region src/react-context/ui/LocaleSelector.d.ts
|
|
183
|
+
/**
|
|
184
|
+
* A dropdown component that allows users to select a locale.
|
|
185
|
+
* @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.
|
|
186
|
+
* @param {object} [customNames] - (deprecated) An optional object to map locales to custom names. Use `customMapping` instead.
|
|
187
|
+
* @param {CustomMapping} [customMapping] - An optional object to map locales to custom display names, emojis, or other properties.
|
|
188
|
+
* @returns {React.ReactElement | null} The rendered locale dropdown component or null to prevent rendering.
|
|
189
|
+
*/
|
|
190
|
+
declare function LocaleSelector({
|
|
191
|
+
locales: _locales,
|
|
192
|
+
...props
|
|
193
|
+
}: {
|
|
194
|
+
locales?: string[];
|
|
195
|
+
customNames?: {
|
|
196
|
+
[key: string]: string;
|
|
197
|
+
};
|
|
198
|
+
customMapping?: CustomMapping;
|
|
199
|
+
[key: string]: unknown;
|
|
200
|
+
}): React$1.JSX.Element | null;
|
|
201
|
+
//#endregion
|
|
202
|
+
//#region src/react-context/ui/RegionSelector.d.ts
|
|
203
|
+
/**
|
|
204
|
+
* A dropdown component that allows users to select a region.
|
|
205
|
+
*
|
|
206
|
+
* @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.
|
|
207
|
+
* @param {React.ReactNode} [placeholder] - Optional placeholder node to display as the first option when no region is selected.
|
|
208
|
+
* @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.
|
|
209
|
+
* @param {boolean} [prioritizeCurrentLocaleRegion] - If true, the region corresponding to the current locale is prioritized in the list.
|
|
210
|
+
* @param {boolean} [sortRegionsAlphabetically] - If true, regions are sorted alphabetically by display name.
|
|
211
|
+
* @param {boolean} [asLocaleSelector=false] - If true, selecting a region will also update the locale to the region's associated locale.
|
|
212
|
+
* @param {object} [props] - Additional props to pass to the underlying `<select>` element.
|
|
213
|
+
* @returns {React.JSX.Element | null} The rendered region dropdown component or null if no regions are available.
|
|
214
|
+
*
|
|
215
|
+
* @example
|
|
216
|
+
* ```tsx
|
|
217
|
+
* <RegionSelector
|
|
218
|
+
* regions={['US', 'CA']}
|
|
219
|
+
* customMapping={{ US: { name: "United States", emoji: "πΊπΈ" } }}
|
|
220
|
+
* placeholder="Select a region"
|
|
221
|
+
* />
|
|
222
|
+
* ```
|
|
223
|
+
*/
|
|
224
|
+
declare function RegionSelector<Regions extends string[]>({
|
|
225
|
+
regions: _regions,
|
|
226
|
+
placeholder,
|
|
227
|
+
customMapping,
|
|
228
|
+
prioritizeCurrentLocaleRegion,
|
|
229
|
+
sortRegionsAlphabetically,
|
|
230
|
+
asLocaleSelector,
|
|
231
|
+
...props
|
|
232
|
+
}: {
|
|
233
|
+
regions?: Regions;
|
|
234
|
+
placeholder?: ReactNode;
|
|
235
|
+
customMapping?: {
|
|
236
|
+
[region: string]: string | {
|
|
237
|
+
name?: string;
|
|
238
|
+
locale?: string;
|
|
239
|
+
emoji?: string;
|
|
240
|
+
};
|
|
241
|
+
};
|
|
242
|
+
prioritizeCurrentLocaleRegion?: boolean;
|
|
243
|
+
sortRegionsAlphabetically?: boolean;
|
|
244
|
+
asLocaleSelector?: boolean;
|
|
245
|
+
[key: string]: unknown;
|
|
246
|
+
}): React$1.JSX.Element | null;
|
|
247
|
+
//#endregion
|
|
248
|
+
export { Branch, ClientProvider, Currency, DateTime, Derive, GTProvider, LocaleSelector, Num, Plural, RegionSelector, 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 };
|
|
249
|
+
//# sourceMappingURL=client.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.d.cts","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/ClientProvider.tsx","../src/react-context/ui/LocaleSelector.tsx","../src/react-context/ui/RegionSelector.tsx"],"mappings":";;;;;;;;;KAiCK4B,YAAAA;;;;KAIAC,QAAAA;EACHC,CAAAA;EACAC,CAAAA;EACAC,CAAAA,GAAIJ,YAAAA;AAAAA;AAAAA;;;;cAMQK,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;;;;AAQA;;;;;AAoHW;KA7G5Ca,WAAAA,GAAcM,QAAAA,GAAWA,QAAAA;;;;;;;;;KAiHzB2C,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;;;;KAgBbU,YAAAA;;;;KC/OA6F,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;;;KCZU,mBAAA;EACV,QAAA,EAAU,KAAA,CAAM,SAAA;EAChB,UAAA,EAAY,UAAA;EACZ,sBAAA,EAAwB,UAAA;EACxB,YAAA,EAAc,YAAA;EACd,MAAA;EACA,OAAA;EACA,MAAA;EACA,UAAA;EACA,iBAAA;EACA,aAAA;EACA,mBAAA;EACA,0BAAA;EACA,cAAA;IACE,MAAA,EAAQ,YAAA;IACR,OAAA;EAAA;EAEF,qBAAA;EACA,SAAA;EACA,SAAA;EACA,UAAA;EACA,iBAAA;EACA,gBAAA;EACA,qBAAA;EACA,gBAAA;EACA,aAAA,GAAgB,aAAA;EAChB,WAAA;EACA,YAAA;AAAA;;;iBCnBsB,cAAA,CAAA;EACtB,QAAA;EACA,UAAA,EAAY,WAAA;EACZ,sBAAA,EAAwB,uBAAA;EACxB,YAAA,EAAc,aAAA;EACd,MAAA,EAAQ,OAAA;EACR,MAAA,EAAQ,OAAA;EACR,UAAA;EACA,aAAA;EACA,mBAAA;EACA,0BAAA;EACA,OAAA;EACA,cAAA;EACA,SAAA;EACA,SAAA;EACA,UAAA;EACA,qBAAA;EACA,qBAAA;EACA,gBAAA;EACA,gBAAA;EACA,aAAA;EACA,WAAA;EACA;AAAA,GACC,mBAAA,GAAsB,OAAA,CAAM,GAAA,CAAI,OAAA;;;;;;;AHhB5B;;;iBIhBiB,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;;;;;;;;AJQP;;;;;AAKU;;;;;;;;;;AAOC;iBKhBM,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"}
|
|
@@ -0,0 +1,250 @@
|
|
|
1
|
+
import * as React$2 from "react";
|
|
2
|
+
import React$1, { ReactNode } from "react";
|
|
3
|
+
import { GT } from "generaltranslation";
|
|
4
|
+
import { Branch, Currency, DateTime, Derive, GTProvider, 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";
|
|
5
|
+
|
|
6
|
+
//#region ../react-core/dist/types.d.ts
|
|
7
|
+
//#endregion
|
|
8
|
+
//#region src/locales/getRegionProperties.d.ts
|
|
9
|
+
//#endregion
|
|
10
|
+
//#region src/types-dir/jsx/variables.d.ts
|
|
11
|
+
type VariableType = 'v' | 'n' | 'd' | 'c' | 'rt';
|
|
12
|
+
/**
|
|
13
|
+
* Variables are used to store the variable name and type.
|
|
14
|
+
*/
|
|
15
|
+
type Variable = {
|
|
16
|
+
k: string;
|
|
17
|
+
i?: number;
|
|
18
|
+
v?: VariableType;
|
|
19
|
+
}; //#endregion
|
|
20
|
+
//#region src/types-dir/jsx/content.d.ts
|
|
21
|
+
/**
|
|
22
|
+
* Map of data-_gt properties to their corresponding React props
|
|
23
|
+
*/
|
|
24
|
+
declare const HTML_CONTENT_PROPS: {
|
|
25
|
+
readonly pl: "placeholder";
|
|
26
|
+
readonly ti: "title";
|
|
27
|
+
readonly alt: "alt";
|
|
28
|
+
readonly arl: "aria-label";
|
|
29
|
+
readonly arb: "aria-labelledby";
|
|
30
|
+
readonly ard: "aria-describedby";
|
|
31
|
+
};
|
|
32
|
+
type HtmlContentPropKeysRecord = Partial<Record<keyof typeof HTML_CONTENT_PROPS, string>>;
|
|
33
|
+
/**
|
|
34
|
+
* GTProp is an internal property used to contain data for translating and rendering elements.
|
|
35
|
+
* note, transformations are only read on the server side if they are 'plural' or 'branch'
|
|
36
|
+
*/
|
|
37
|
+
type GTProp = {
|
|
38
|
+
b?: Record<string, JsxChildren>;
|
|
39
|
+
t?: 'p' | 'b';
|
|
40
|
+
} & HtmlContentPropKeysRecord;
|
|
41
|
+
type JsxElement = {
|
|
42
|
+
t?: string;
|
|
43
|
+
i?: number;
|
|
44
|
+
d?: GTProp;
|
|
45
|
+
c?: JsxChildren;
|
|
46
|
+
};
|
|
47
|
+
type JsxChild = string | JsxElement | Variable;
|
|
48
|
+
/**
|
|
49
|
+
* The format of the string content
|
|
50
|
+
*/
|
|
51
|
+
/**
|
|
52
|
+
* String format content.
|
|
53
|
+
*/
|
|
54
|
+
/**
|
|
55
|
+
* A content type representing JSX elements.
|
|
56
|
+
*/
|
|
57
|
+
type JsxChildren = JsxChild | JsxChild[];
|
|
58
|
+
/**
|
|
59
|
+
* A content type representing ICU messages.
|
|
60
|
+
*/
|
|
61
|
+
//#endregion
|
|
62
|
+
//#region ../core/dist/types-YrrGRHBP.d.cts
|
|
63
|
+
/**
|
|
64
|
+
* For dictionaries, we have Entry and MetaEntry
|
|
65
|
+
*/
|
|
66
|
+
type Entry = string;
|
|
67
|
+
type MetaEntry = {
|
|
68
|
+
$context?: string;
|
|
69
|
+
$maxChars?: number;
|
|
70
|
+
$_hash?: string;
|
|
71
|
+
[key: string]: unknown;
|
|
72
|
+
};
|
|
73
|
+
type DictionaryEntry = Entry | [Entry] | [Entry, MetaEntry];
|
|
74
|
+
type Dictionary = {
|
|
75
|
+
[key: string]: Dictionary | DictionaryEntry;
|
|
76
|
+
} | (Dictionary | DictionaryEntry)[];
|
|
77
|
+
/**
|
|
78
|
+
* Translated content types
|
|
79
|
+
* TODO: move these types to JsxElement etc from generaltranslation/types
|
|
80
|
+
* remember to omit the t property (tag name) from the translated element
|
|
81
|
+
*/
|
|
82
|
+
type TranslatedElement = {
|
|
83
|
+
i?: number;
|
|
84
|
+
d?: GTProp;
|
|
85
|
+
c?: TranslatedChildren;
|
|
86
|
+
};
|
|
87
|
+
type TranslatedChild = TranslatedElement | string | Variable;
|
|
88
|
+
type TranslatedChildren = TranslatedChild | TranslatedChild[];
|
|
89
|
+
type Translations = {
|
|
90
|
+
[hash: string]: TranslatedChildren | null;
|
|
91
|
+
};
|
|
92
|
+
/**
|
|
93
|
+
* @deprecated use {@link Dictionary}
|
|
94
|
+
*/
|
|
95
|
+
type RenderMethod = 'skeleton' | 'replace' | 'default';
|
|
96
|
+
//#endregion
|
|
97
|
+
//#region ../format/dist/types-UnF22q9r.d.cts
|
|
98
|
+
//#region src/locales/customLocaleMapping.d.ts
|
|
99
|
+
type CustomMapping = Record<string, string | Partial<LocaleProperties>>; //#endregion
|
|
100
|
+
//#region src/locales/getLocaleProperties.d.ts
|
|
101
|
+
type LocaleProperties = {
|
|
102
|
+
code: string;
|
|
103
|
+
name: string;
|
|
104
|
+
nativeName: string;
|
|
105
|
+
languageCode: string;
|
|
106
|
+
languageName: string;
|
|
107
|
+
nativeLanguageName: string;
|
|
108
|
+
nameWithRegionCode: string;
|
|
109
|
+
nativeNameWithRegionCode: string;
|
|
110
|
+
regionCode: string;
|
|
111
|
+
regionName: string;
|
|
112
|
+
nativeRegionName: string;
|
|
113
|
+
scriptCode: string;
|
|
114
|
+
scriptName: string;
|
|
115
|
+
nativeScriptName: string;
|
|
116
|
+
maximizedCode: string;
|
|
117
|
+
maximizedName: string;
|
|
118
|
+
nativeMaximizedName: string;
|
|
119
|
+
minimizedCode: string;
|
|
120
|
+
minimizedName: string;
|
|
121
|
+
nativeMinimizedName: string;
|
|
122
|
+
emoji: string;
|
|
123
|
+
}; //#endregion
|
|
124
|
+
//#region src/locales/getRegionProperties.d.ts
|
|
125
|
+
//#endregion
|
|
126
|
+
//#region src/react-context/types/config.d.ts
|
|
127
|
+
type ClientProviderProps = {
|
|
128
|
+
children: React.ReactNode;
|
|
129
|
+
dictionary: Dictionary;
|
|
130
|
+
dictionaryTranslations: Dictionary;
|
|
131
|
+
translations: Translations;
|
|
132
|
+
locale: string;
|
|
133
|
+
locales: string[];
|
|
134
|
+
region?: string;
|
|
135
|
+
_versionId?: string;
|
|
136
|
+
dictionaryEnabled?: boolean;
|
|
137
|
+
defaultLocale: string;
|
|
138
|
+
translationRequired: boolean;
|
|
139
|
+
dialectTranslationRequired: boolean;
|
|
140
|
+
renderSettings: {
|
|
141
|
+
method: RenderMethod;
|
|
142
|
+
timeout?: number;
|
|
143
|
+
};
|
|
144
|
+
developmentApiEnabled: boolean;
|
|
145
|
+
projectId?: string;
|
|
146
|
+
devApiKey?: string;
|
|
147
|
+
runtimeUrl?: string | null;
|
|
148
|
+
gtServicesEnabled?: boolean;
|
|
149
|
+
localeCookieName?: string;
|
|
150
|
+
resetLocaleCookieName: string;
|
|
151
|
+
regionCookieName?: string;
|
|
152
|
+
customMapping?: CustomMapping;
|
|
153
|
+
environment: 'development' | 'production' | 'test';
|
|
154
|
+
reloadServer: () => void;
|
|
155
|
+
};
|
|
156
|
+
//#endregion
|
|
157
|
+
//#region src/react-context/provider/ClientProvider.d.ts
|
|
158
|
+
declare function ClientProvider({
|
|
159
|
+
children,
|
|
160
|
+
dictionary: _dictionary,
|
|
161
|
+
dictionaryTranslations: _dictionaryTranslations,
|
|
162
|
+
translations: _translations,
|
|
163
|
+
locale: _locale,
|
|
164
|
+
region: _region,
|
|
165
|
+
_versionId,
|
|
166
|
+
defaultLocale,
|
|
167
|
+
translationRequired,
|
|
168
|
+
dialectTranslationRequired,
|
|
169
|
+
locales,
|
|
170
|
+
renderSettings,
|
|
171
|
+
projectId,
|
|
172
|
+
devApiKey,
|
|
173
|
+
runtimeUrl,
|
|
174
|
+
developmentApiEnabled,
|
|
175
|
+
resetLocaleCookieName,
|
|
176
|
+
localeCookieName,
|
|
177
|
+
regionCookieName,
|
|
178
|
+
customMapping,
|
|
179
|
+
environment,
|
|
180
|
+
reloadServer
|
|
181
|
+
}: ClientProviderProps): React$2.JSX.Element;
|
|
182
|
+
//#endregion
|
|
183
|
+
//#region src/react-context/ui/LocaleSelector.d.ts
|
|
184
|
+
/**
|
|
185
|
+
* A dropdown component that allows users to select a locale.
|
|
186
|
+
* @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.
|
|
187
|
+
* @param {object} [customNames] - (deprecated) An optional object to map locales to custom names. Use `customMapping` instead.
|
|
188
|
+
* @param {CustomMapping} [customMapping] - An optional object to map locales to custom display names, emojis, or other properties.
|
|
189
|
+
* @returns {React.ReactElement | null} The rendered locale dropdown component or null to prevent rendering.
|
|
190
|
+
*/
|
|
191
|
+
declare function LocaleSelector({
|
|
192
|
+
locales: _locales,
|
|
193
|
+
...props
|
|
194
|
+
}: {
|
|
195
|
+
locales?: string[];
|
|
196
|
+
customNames?: {
|
|
197
|
+
[key: string]: string;
|
|
198
|
+
};
|
|
199
|
+
customMapping?: CustomMapping;
|
|
200
|
+
[key: string]: unknown;
|
|
201
|
+
}): React$1.JSX.Element | null;
|
|
202
|
+
//#endregion
|
|
203
|
+
//#region src/react-context/ui/RegionSelector.d.ts
|
|
204
|
+
/**
|
|
205
|
+
* A dropdown component that allows users to select a region.
|
|
206
|
+
*
|
|
207
|
+
* @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.
|
|
208
|
+
* @param {React.ReactNode} [placeholder] - Optional placeholder node to display as the first option when no region is selected.
|
|
209
|
+
* @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.
|
|
210
|
+
* @param {boolean} [prioritizeCurrentLocaleRegion] - If true, the region corresponding to the current locale is prioritized in the list.
|
|
211
|
+
* @param {boolean} [sortRegionsAlphabetically] - If true, regions are sorted alphabetically by display name.
|
|
212
|
+
* @param {boolean} [asLocaleSelector=false] - If true, selecting a region will also update the locale to the region's associated locale.
|
|
213
|
+
* @param {object} [props] - Additional props to pass to the underlying `<select>` element.
|
|
214
|
+
* @returns {React.JSX.Element | null} The rendered region dropdown component or null if no regions are available.
|
|
215
|
+
*
|
|
216
|
+
* @example
|
|
217
|
+
* ```tsx
|
|
218
|
+
* <RegionSelector
|
|
219
|
+
* regions={['US', 'CA']}
|
|
220
|
+
* customMapping={{ US: { name: "United States", emoji: "πΊπΈ" } }}
|
|
221
|
+
* placeholder="Select a region"
|
|
222
|
+
* />
|
|
223
|
+
* ```
|
|
224
|
+
*/
|
|
225
|
+
declare function RegionSelector<Regions extends string[]>({
|
|
226
|
+
regions: _regions,
|
|
227
|
+
placeholder,
|
|
228
|
+
customMapping,
|
|
229
|
+
prioritizeCurrentLocaleRegion,
|
|
230
|
+
sortRegionsAlphabetically,
|
|
231
|
+
asLocaleSelector,
|
|
232
|
+
...props
|
|
233
|
+
}: {
|
|
234
|
+
regions?: Regions;
|
|
235
|
+
placeholder?: ReactNode;
|
|
236
|
+
customMapping?: {
|
|
237
|
+
[region: string]: string | {
|
|
238
|
+
name?: string;
|
|
239
|
+
locale?: string;
|
|
240
|
+
emoji?: string;
|
|
241
|
+
};
|
|
242
|
+
};
|
|
243
|
+
prioritizeCurrentLocaleRegion?: boolean;
|
|
244
|
+
sortRegionsAlphabetically?: boolean;
|
|
245
|
+
asLocaleSelector?: boolean;
|
|
246
|
+
[key: string]: unknown;
|
|
247
|
+
}): React$1.JSX.Element | null;
|
|
248
|
+
//#endregion
|
|
249
|
+
export { Branch, ClientProvider, Currency, DateTime, Derive, GTProvider, LocaleSelector, Num, Plural, RegionSelector, 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 };
|
|
250
|
+
//# sourceMappingURL=client.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.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/ClientProvider.tsx","../src/react-context/ui/LocaleSelector.tsx","../src/react-context/ui/RegionSelector.tsx"],"mappings":";;;;;;;;;;KAiCK4B,YAAAA;;;;KAIAC,QAAAA;EACHC,CAAAA;EACAC,CAAAA;EACAC,CAAAA,GAAIJ,YAAAA;AAAAA;AAAAA;;;;cAMQK,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;;;;AAQA;;;;;AAoHW;KA7G5Ca,WAAAA,GAAcM,QAAAA,GAAWA,QAAAA;;;;;;;;;KAiHzB2C,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;;;;KAgBbU,YAAAA;;;;KC/OA6F,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;;;KCZU,mBAAA;EACV,QAAA,EAAU,KAAA,CAAM,SAAA;EAChB,UAAA,EAAY,UAAA;EACZ,sBAAA,EAAwB,UAAA;EACxB,YAAA,EAAc,YAAA;EACd,MAAA;EACA,OAAA;EACA,MAAA;EACA,UAAA;EACA,iBAAA;EACA,aAAA;EACA,mBAAA;EACA,0BAAA;EACA,cAAA;IACE,MAAA,EAAQ,YAAA;IACR,OAAA;EAAA;EAEF,qBAAA;EACA,SAAA;EACA,SAAA;EACA,UAAA;EACA,iBAAA;EACA,gBAAA;EACA,qBAAA;EACA,gBAAA;EACA,aAAA,GAAgB,aAAA;EAChB,WAAA;EACA,YAAA;AAAA;;;iBCnBsB,cAAA,CAAA;EACtB,QAAA;EACA,UAAA,EAAY,WAAA;EACZ,sBAAA,EAAwB,uBAAA;EACxB,YAAA,EAAc,aAAA;EACd,MAAA,EAAQ,OAAA;EACR,MAAA,EAAQ,OAAA;EACR,UAAA;EACA,aAAA;EACA,mBAAA;EACA,0BAAA;EACA,OAAA;EACA,cAAA;EACA,SAAA;EACA,SAAA;EACA,UAAA;EACA,qBAAA;EACA,qBAAA;EACA,gBAAA;EACA,gBAAA;EACA,aAAA;EACA,WAAA;EACA;AAAA,GACC,mBAAA,GAAsB,OAAA,CAAM,GAAA,CAAI,OAAA;;;;;;;AHhB5B;;;iBIhBiB,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;;;;;;;;AJQP;;;;;AAKU;;;;;;;;;;AAOC;iBKhBM,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"}
|