@enum-plus/plugin-react/es/components/I18nLocale.d.ts

A plugin for enum-plus that provides React components and hooks for enum handling

import type { FC } from 'react';
import type { TOptions } from 'i18next';
import i18n from 'i18next';
export interface I18nextLocaleProps {
    /**
     * - **EN:** The key to be translated. It can be a string or an array of strings.
     * - **CN:** 要翻译的key，可以是字符串或字符串数组。
     */
    i18nKey?: string | string[];
    /**
     * - **EN:** The i18next instance to be used, if not provided, the default instance will be used.
     * - **CN:** 要使用的i18next实例，如果不提供，则使用默认实例。
     */
    instance?: typeof i18n;
    /**
     * - **EN:** Provide options to be passed to the `t` method when generating internationalized text
     *   within the enum, so that parameters can be passed dynamically.
     *
     *   You can pass an object or a function, the parameter of the function is the current key, and the
     *   return value is the option passed to the `t` method, or even a string directly as the final
     *   translation result.
     * - **CN:** 在枚举内部生成国际化文本时，提供传递给`t`方法的选项，以便可以动态传递参数。
     *
     *   可以传递一个对象，也可以传递一个函数，函数的参数是当前的key，返回值是传递给`t`方法的选项，甚至可以直接返回一个字符串作为最终的翻译结果。
     */
    tOptions?: TOptions | ((key: string | undefined | (string | undefined)[], instance: typeof i18n) => TOptions | string);
}
/**
 * - **EN:** A React component for rendering internationalized text using i18next. It listens for
 *   language changes and updates the displayed text accordingly.
 * - **CN:** 一个用于渲染国际化文本的React组件，它监听语言变化并相应地更新显示的文本。
 */
declare const I18nextLocale: FC<I18nextLocaleProps>;
export declare function translate(props: {
    i18nKey: string | string[] | undefined;
    instance?: typeof i18n;
    tOptions?: TOptions | ((key: string | undefined | (string | undefined)[], instance: typeof i18n) => TOptions | string);
}): string;
export default I18nextLocale;