gt-react 9.2.29-alpha.9 → 9.2.30

package/dist/client.d.ts

@@ -378,14 +378,14 @@ declare namespace T {
  * </Currency>
  * ```
  *
- * @param {number | string} children - Content to render inside the currency component.
- * @param {string} [currency="USD"] - The currency type (e.g., USD, EUR, etc.).
- * @param {string[]} [locales] - Optional locales to use for currency formatting. If wrapped in a `<GTProvider>`, the user's locale is used.
- * @param {Intl.NumberFormatOptions} [options={}] - Optional formatting options to customize how the currency is displayed.
+ * @param {any} [children] - Optional content to render inside the currency component.
+ * @param {string} [currency] - The currency type (e.g., USD, EUR, etc.).
+ * @param {string[]} [locales] - Optional locales to use for currency formatting. If not provided, the library default locale (en-US) is used. If wrapped in a `<GTProvider>`, the user's locale is used.
+ * @param {Intl.NumberFormatOptions} [options] - Optional formatting options to customize how the currency is displayed.
  * @returns {JSX.Element} The formatted currency component.
  */
-declare function Currency({ children, currency, locales, options, }: {
-    children: number | string;
+declare function Currency({ children, currency, name, locales, options, }: {
+    children?: any;
     currency?: string;
     name?: string;
     locales?: string[];
@@ -407,13 +407,13 @@ declare namespace Currency {
  * </DateTime>
  * ```
  *
- * @param {Date} children - Content to render inside the date component.
- * @param {string[]} [locales] - Optional locales to use for date formatting. If wrapped in a `<GTProvider>`, the user's locale is used.
+ * @param {any} [children] - Optional content (typically a date) to render inside the component.
+ * @param {string[]} [locales] - Optional locales to use for date formatting. If not provided, the library default locale (en-US) is used. If wrapped in a `<GTProvider>`, the user's locale is used.
  * @param {Intl.DateTimeFormatOptions} [options={}] - Optional formatting options for the date, following `Intl.DateTimeFormatOptions` specifications.
  * @returns {JSX.Element} The formatted date or time component.
  */
-declare function DateTime({ children, locales, options, }: {
-    children: Date;
+declare function DateTime({ children, locales, name, options, }: {
+    children?: any;
     locales?: string[];
     name?: string;
     options?: Intl.DateTimeFormatOptions;
@@ -436,13 +436,12 @@ declare namespace DateTime {
  * </Num>
  * ```
  *
- * @param {number | string} children - Content to render inside the number component.
- * @param {string[]} [locales] - Optional locales to use for number formatting. If wrapped in a `<GTProvider>`, the user's locale is used.
+ * @param {any} [children] - Optional content (typically a number) to render inside the component.
  * @param {Intl.NumberFormatOptions} [options={}] - Optional formatting options for the number, following `Intl.NumberFormatOptions` specifications.
  * @returns {JSX.Element} The formatted number component.
  */
-declare function Num({ children, locales, options, }: {
-    children: number | string;
+declare function Num({ children, name, locales, options, }: {
+    children?: any;
     locales?: string[];
     options?: Intl.NumberFormatOptions;
     name?: string;
@@ -543,14 +542,23 @@ declare function useSetLocale(): (locale: string) => void;
 declare function useLocales(): string[];
 
 /**
+ /**
  * Gets the list of properties for using a locale selector.
+ * Provides locale management utilities for the application.
  * @param locales an optional list of locales to use for the drop down. These locales must be a subset of the locales provided by the `<GTProvider>` context. When not provided, the list of locales from the `<GTProvider>` context is used.
- * @returns {object} The locale, locales, and setLocale function.
+ * Provides locale management utilities for the application.
+ *
+ * @returns {Object} An object containing locale-related utilities:
+ * @returns {string} return.locale - The currently selected locale.
+ * @returns {string[]} return.locales - The list of all available locales.
+ * @returns {(locale: string) => void} return.setLocale - Function to update the current locale.
+ * @returns {(locale: string) => LocaleProperties} return.getLocaleProperties - Function to retrieve properties for a given locale.
  */
 declare function useLocaleSelector(locales?: string[]): {
     locale: string;
     locales: string[];
     setLocale: (locale: string) => void;
+    getLocaleProperties: (locale: string) => generaltranslation_types.LocaleProperties;
 };
 
 /**