npm - @nicorp/nui - Versions diffs - 0.6.0 → 0.8.0 - Mend

@nicorp/nui 0.6.0 → 0.8.0

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.

Files changed (6) hide show

package/dist/index.d.ts CHANGED Viewed

@@ -910,6 +910,11 @@ export declare interface MessageActionsProps extends React_2.HTMLAttributes<HTML
 export declare type MessageActionType = "copy" | "retry" | "edit" | "like" | "dislike" | "share";
+/** Recursive JSON dictionary — values are strings or nested objects. */
+export declare type MessageDictionary = {
+    [key: string]: string | MessageDictionary;
+};
 export declare function MetricCard({ title, value, description, trend, trendLabel, icon, className, ...props }: MetricCardProps): JSX_2.Element;
 declare interface MetricCardProps extends React_2.HTMLAttributes<HTMLDivElement> {
@@ -1100,32 +1105,6 @@ export declare interface NUILocale {
     breadcrumb_more: string;
 }
-/**
- * Provides a locale dictionary to every NUI AI component in the tree.
- *
- * @example
- * ```tsx
- * <NUIProvider locale="ru">
- *   <App />
- * </NUIProvider>
- * ```
- *
- * @example Custom locale
- * ```tsx
- * <NUIProvider locale={{ chatInput_placeholder: "Ask anything…" }}>
- *   <App />
- * </NUIProvider>
- * ```
- */
-export declare function NUIProvider({ locale, children }: NUIProviderProps): JSX_2.Element;
-export declare interface NUIProviderProps {
-    /** Built-in locale key ("en" | "ru") or a custom (partial) locale dictionary.
-     *  Missing keys fall back to English. */
-    locale?: "en" | "ru" | (string & {}) | Partial<NUILocale>;
-    children: React_2.ReactNode;
-}
 export declare function NumberInput({ value, onChange, min, max, step, disabled, className, }: NumberInputProps): JSX_2.Element;
 export declare interface NumberInputProps {
@@ -1420,6 +1399,9 @@ export declare const textVariants: (props?: ({
     leading?: "normal" | "tight" | "relaxed" | null | undefined;
 } & ClassProp) | undefined) => string;
+/** Translation function returned by `useLocale()`. */
+export declare type TFunction = (key: string, vars?: Record<string, string | number>) => string;
 export declare type Theme = "dark" | "light" | "system";
 export declare function ThemeProvider({ children, defaultTheme, storageKey, attribute, enableSystem, disableTransitionOnChange, forcedTheme, nonce, }: ThemeProviderProps): JSX_2.Element;
@@ -1519,22 +1501,90 @@ export declare const TooltipTrigger: React_2.ForwardRefExoticComponent<TooltipPr
  *
  * @example
  * ```ts
- * t("Calling {name}...", { name: "search" })
+ * tpl("Calling {name}...", { name: "search" })
  * // → "Calling search..."
  * ```
  */
 export declare function tpl(template: string, vars: Record<string, string | number>): string;
+/**
+ * Provides i18n for both NUI components **and** your own app strings.
+ *
+ * @example NUI-only (component translations)
+ * ```tsx
+ * <TranslateProvider locale="ru">
+ *   <App />
+ * </TranslateProvider>
+ * ```
+ *
+ * @example With user JSON dictionaries
+ * ```tsx
+ * import en from "./locales/en.json"
+ * import ru from "./locales/ru.json"
+ *
+ * <TranslateProvider locale="ru" messages={{ en, ru }}>
+ *   <App />
+ * </TranslateProvider>
+ * ```
+ */
+declare function TranslateProvider({ locale, messages, children }: TranslateProviderProps): JSX_2.Element;
+export { TranslateProvider as NUIProvider }
+export { TranslateProvider }
+export declare interface TranslateProviderProps {
+    /** Built-in locale key ("en" | "ru") or a custom (partial) NUI locale dictionary.
+     *  Missing keys fall back to English. */
+    locale?: "en" | "ru" | (string & {}) | Partial<NUILocale>;
+    /**
+     * User JSON dictionaries for app-level translations.
+     *
+     * @example
+     * ```tsx
+     * import en from "./locales/en.json"
+     * import ru from "./locales/ru.json"
+     *
+     * <TranslateProvider locale="ru" messages={{ en, ru }}>
+     *   <App />
+     * </TranslateProvider>
+     * ```
+     */
+    messages?: Record<string, MessageDictionary>;
+    children: React_2.ReactNode;
+}
 declare type UseCarouselParameters = Parameters<typeof default_2>;
 /**
- * Returns the current NUI locale dictionary.
- * Falls back to English when used outside a `<NUIProvider>`.
+ * Returns `{ t, lang }` for translating your own app strings.
+ *
+ * `t("profile.save")` resolves dot-paths in your JSON dictionaries.
+ * Variables: `t("greeting", { name: "Alex" })` → replaces `{name}`.
+ *
+ * Fallback chain: **active lang → "en" → raw key**.
+ *
+ * @example
+ * ```tsx
+ * function MyButton() {
+ *   const { t } = useLocale()
+ *   return <button>{t("profile.save")}</button>
+ * }
+ * ```
  */
-export declare function useNUILocale(): NUILocale;
+export declare function useLocale(): {
+    t: TFunction;
+    lang: string;
+};
 export declare function useTheme(): ThemeProviderState;
+/**
+ * Returns the current NUI locale dictionary (built-in component strings).
+ * Falls back to English when used outside a `<TranslateProvider>`.
+ */
+declare function useTranslate(): NUILocale;
+export { useTranslate as useNUILocale }
+export { useTranslate }
 export declare const VStack: React_2.ForwardRefExoticComponent<StackProps & React_2.RefAttributes<HTMLDivElement>>;
 export { }