pure
    Preparing search index...

    Type Alias LocaleOptionsWithI18next<TLocale>

    LocaleOptionsWithI18next: LocaleOptions<TLocale> & {
        loader: LoadLanguageFn | Record<string, LoadLanguageFn>;
        react?: boolean;
        sync?: "full" | "i18next-pure" | "pure-i18next";
    }

    Option for initializing locale with i18next integration

    Type Parameters

    • TLocale extends string

    Type declaration

    • loader: LoadLanguageFn | Record<string, LoadLanguageFn>

      The language loader function(s).

      If a function is provided, it will be called for the "translations" namespace. Otherwise, you can provide a record of functions for each namespace.

    • Optionalreact?: boolean

      If the react-i18next integration should be enabled (true by default, if not specified)

    • Optionalsync?: "full" | "i18next-pure" | "pure-i18next"

      The sync mode between i18next and pure. Default is "full"

      With "full", either setLocale or i18next.changeLanguage will sync the other. For other modes, changing the first will sync to the second, but not the other way around.

      "full" or "i18next-pure" will also sync the initially detected language from pure to i18next

    Settings

    Member Visibility