@nuxtjs/i18n/dist/module.d.mts

Internationalization for Nuxt

import * as _nuxt_schema from '@nuxt/schema';
import { HookResult } from '@nuxt/schema';
import { Locale, I18nOptions } from 'vue-i18n';
import { PluginOptions } from '@intlify/unplugin-vue-i18n';
import { RouteMapGeneric, RouteMapI18n } from 'vue-router';

declare const STRATEGY_PREFIX = "prefix";
declare const STRATEGY_PREFIX_EXCEPT_DEFAULT = "prefix_except_default";
declare const STRATEGY_PREFIX_AND_DEFAULT = "prefix_and_default";
declare const STRATEGY_NO_PREFIX = "no_prefix";
declare const STRATEGIES: {
    readonly PREFIX: "prefix";
    readonly PREFIX_EXCEPT_DEFAULT: "prefix_except_default";
    readonly PREFIX_AND_DEFAULT: "prefix_and_default";
    readonly NO_PREFIX: "no_prefix";
};

/**
 * @public
 */
type RedirectOnOptions = 'all' | 'root' | 'no prefix';
/**
 * @public
 */
interface DetectBrowserLanguageOptions {
    alwaysRedirect?: boolean;
    cookieCrossOrigin?: boolean;
    cookieDomain?: string | null;
    cookieKey?: string;
    cookieSecure?: boolean;
    fallbackLocale?: Locale | null;
    redirectOn?: RedirectOnOptions;
    useCookie?: boolean;
}
/**
 * @internal
 */
type LocaleType = 'static' | 'dynamic' | 'unknown';
type LocaleFile = {
    path: string;
    cache?: boolean;
};
type LocaleInfo = Omit<LocaleObject, 'file' | 'files'> & {
    code: Locale;
    meta: FileMeta[];
};
/**
 * @internal
 */
type FileMeta = {
    path: string;
    hash: string;
    cache: boolean;
    type: LocaleType;
};
/**
 * @public
 */
interface RootRedirectOptions {
    path: string;
    statusCode: number;
}
type RouteLocationAsStringTypedListI18n<T = RouteMapGeneric extends RouteMapI18n ? RouteMapGeneric : RouteMapI18n> = {
    [N in keyof T]?: Partial<Record<Locale, `/${string}` | false>> | false;
};
type CustomRoutePages = RouteLocationAsStringTypedListI18n;
interface ExperimentalFeatures {
    /**
     * Path to server-side locale detector resolved from `restructureDir` (`<rootDir>/i18n` by default)
     * @default undefined
     */
    localeDetector?: string;
    /**
     * Generates types for i18n routing helper
     * @default true
     */
    typedPages?: boolean;
    /**
     * Generates types for vue-i18n and messages
     * - `'default'` to generate types based on `defaultLocale`
     * - `'all'` to generate types based on all locales
     * @default false
     */
    typedOptionsAndMessages?: false | 'default' | 'all';
    /**
     * Removes non-canonical query parameters from alternate link meta tags
     * @default true
     */
    alternateLinkCanonicalQueries?: boolean;
    /**
     * Enables caching of locale messages in dev mode
     * @default false
     */
    devCache?: boolean;
    /**
     * Locale messages cache lifetime in seconds
     * - `-1` cache disabled
     * @default -1 // disabled, or `86400` (1 day) if all locale files are static files
     */
    cacheLifetime?: number;
    /**
     * Preload locale messages and add them to the server-side rendered HTML.
     * This increases the size of the initial HTML payload but prevents an addition client-side request to load the messages.
     *
     * Since locale messages can be a large collection, it is recommended to use this in combination with `stripMessagesPayload`.
     * @default false
     */
    preload?: boolean;
    /**
     * Strip unused locale messages from the server-side rendered HTML, reducing the size of the HTML payload.
     *
     * The `useI18nPreloadKeys` composable is used to prevent keys from being stripped, this is useful for conditionally rendered translations.
     * @default false // or `true` if `experimental.preload` is enabled
     */
    stripMessagesPayload?: boolean;
    strictSeo?: boolean | SeoAttributesOptions;
    /**
     * Enables Nitro context detection and allows for more reliable detection and redirection behavior especially in setups using prerendering.
     * It is recommended to keep it enabled, but can be disabled if this causes issues, this option might be removed in v11.
     * @default true
     */
    nitroContextDetection?: boolean;
}
interface BundleOptions extends Pick<PluginOptions, 'compositionOnly' | 'runtimeOnly' | 'fullInstall' | 'dropMessageCompiler' | 'onlyLocales'> {
}
interface CustomBlocksOptions extends Pick<PluginOptions, 'defaultSFCLang' | 'globalSFCScope'> {
}
interface LocaleMessageCompilationOptions {
    strictMessage?: boolean;
    escapeHtml?: boolean;
}
type NuxtI18nOptions<Context = unknown, ConfiguredLocaleType extends string[] | LocaleObject[] = string[] | LocaleObject[]> = {
    /**
     * Path to a Vue I18n configuration file, the module will scan for a i18n.config{.js,.mjs,.ts} if left unset.
     * @default ''
     */
    vueI18n?: string;
    experimental?: ExperimentalFeatures;
    /**
     * The directory from which i18n files are resolved relative to the `<rootDir>` of the project.
     * @default 'i18n'
     */
    restructureDir?: string;
    bundle?: BundleOptions;
    compilation?: LocaleMessageCompilationOptions;
    customBlocks?: CustomBlocksOptions;
    /**
     * Enable when using different domains for each locale
     *
     * If enabled, no prefix is added to routes and `locales` must be configured as an array of `LocaleObject` objects with the `domain` property set.
     * @default false
     */
    differentDomains?: boolean;
    /**
     * Enable when using different domains with different locales
     *
     * If enabled, `locales` must be configured as an array of `LocaleObject` objects with the `domains` and `defaultForDomains` property set.
     * @default false
     */
    multiDomainLocales?: boolean;
    detectBrowserLanguage?: DetectBrowserLanguageOptions | false;
    langDir?: string | null;
    pages?: CustomRoutePages;
    customRoutes?: 'page' | 'config' | 'meta';
    /**
     * Do not use in projects - this is used internally for e2e tests to override default option merging.
     * @internal
     */
    overrides?: Omit<NuxtI18nOptions<Context>, 'overrides'>;
    rootRedirect?: string | RootRedirectOptions;
    /**
     * Status code used for localized redirects
     * @default 302
     */
    redirectStatusCode?: number;
    skipSettingLocaleOnNavigate?: boolean;
    /**
     * @deprecated This option is deprecated, only `'composition'` types will be supported in the future.
     * @default 'composition'
     */
    types?: 'composition' | 'legacy';
    debug?: boolean | 'verbose';
    parallelPlugin?: boolean;
    /**
     * The app's default locale
     *
     * It's recommended to set this to some locale regardless of chosen strategy, as it will be used as a fallback locale when navigating to a non-existent route
     *
     * With `prefix_except_default` strategy, routes for `defaultLocale` have no prefix.
     * @default ''
     */
    defaultLocale?: Locale;
    /**
     * List of locales supported by your app
     *
     * Can either be an array of string codes (e.g. `['en', 'fr']`) or an array of {@link LocaleObject} for more complex configurations
     * @default []
     */
    locales?: ConfiguredLocaleType;
    /**
     * Routes strategy
     * - `no_prefix`: routes won't have a locale prefix
     * - `prefix_except_default`: locale prefix added for every locale except default
     * - `prefix`: locale prefix added for every locale
     * - `prefix_and_default`: locale prefix added for every locale and default
     *
     * @default 'prefix_except_default'
     */
    strategy?: Strategies;
    /**
     * Whether to use trailing slash
     * @default false
     */
    trailingSlash?: boolean;
    /**
     * Internal separator used for generated route names for each locale - you shouldn't need to change this
     * @deprecated This option is deprecated and will be removed in the future.
     * @default '___'
     */
    routesNameSeparator?: string;
    /**
     * Internal suffix added to generated route names for default locale
     *
     * Relevant if strategy is `prefix_and_default` - you shouldn't need to change this.
     * @deprecated This option is deprecated and will be removed in the future.
     * @default 'default'
     */
    defaultLocaleRouteNameSuffix?: string;
    /**
     * Default direction direction
     * @default 'ltr'
     */
    defaultDirection?: Directions;
    /**
     * The fallback base URL to use as a prefix for alternate URLs in hreflang tags.
     *
     * By default VueRouter's base URL will be used and only if that is not available, fallback URL will be used.
     *
     * @default ''
     */
    baseUrl?: string | BaseUrlResolveHandler<Context>;
    /**
     * Hot module replacement for locale message files and vue-i18n configuration in dev mode.
     *
     * @defaultValue `true`
     */
    hmr?: boolean;
    /**
     * Automatically imports/initializes `$t`, `$rt`, `$d`, `$n`, `$tm` and `$te` functions in `<script setup>` when used.
     *
     * This requires Nuxt's `autoImport` functionality to work.
     *
     * @example
     * ```vue
     * <script setup>
     * // const { t: $t } = useI18n() --- automatically declared
     * const title = computed(() => $t('my-title'))
     * </script>
     * ```
     * @default true
     */
    autoDeclare?: boolean;
};
type VueI18nConfig = () => Promise<{
    default: I18nOptions | (() => I18nOptions | Promise<I18nOptions>);
}>;
/**
 * Routing strategy
 * @public
 */
type Strategies = (typeof STRATEGIES)[keyof typeof STRATEGIES];
/**
 * Direction
 * @public
 */
type Directions = 'ltr' | 'rtl' | 'auto';
/**
 * Locale object
 * @public
 */
interface LocaleObject<T = Locale> {
    [k: string]: unknown;
    /** Code used for route prefixing and argument in i18n utility functions. */
    code: T;
    /** User facing name */
    name?: string;
    /** Writing direction */
    dir?: Directions;
    /** Language tag - see IETF's BCP47 - required when using SEO features */
    language?: string;
    /** Override default SEO catch-all and force this locale to be catch-all for its locale group */
    isCatchallLocale?: boolean;
    domain?: string;
    domains?: string[];
    defaultForDomains?: string[];
    domainDefault?: boolean;
    file?: string | LocaleFile;
    files?: string[] | LocaleFile[];
}
/**
 * @public
 * @deprecated Configuring baseUrl as a function is deprecated and will be removed in the v11.
 */
type BaseUrlResolveHandler<Context = unknown> = (context: Context) => string;
/**
 * SEO Attribute options.
 * @public
 */
interface SeoAttributesOptions {
    /**
     * An array of strings corresponding to query params you would like to include in your canonical URL.
     * @default []
     */
    canonicalQueries?: string[];
}
/**
 * @public Options for {@link localeHead} function.
 */
interface I18nHeadOptions {
    /**
     * Adds a `lang` attribute to the HTML element.
     * @default true
     */
    lang?: boolean;
    /**
     * Adds a `dir` attribute to the HTML element.
     * @default true
     */
    dir?: boolean;
    /**
     * Adds various SEO tags.
     * @default true
     */
    seo?: boolean | SeoAttributesOptions;
}
/**
 * Meta attributes for head properties.
 * @public
 */
type MetaAttrs = Record<string, string>;
/**
 * I18n header meta info.
 * @public
 */
interface I18nHeadMetaInfo {
    htmlAttrs: MetaAttrs;
    meta: MetaAttrs[];
    link: MetaAttrs[];
}
interface I18nPublicRuntimeConfig {
    baseUrl: NuxtI18nOptions['baseUrl'];
    rootRedirect: NuxtI18nOptions['rootRedirect'];
    redirectStatusCode?: NuxtI18nOptions['redirectStatusCode'];
    domainLocales: {
        [key: Locale]: {
            domain: string | undefined;
        };
    };
    /** @internal Overwritten at build time, used to pass generated options to runtime */
    locales: NonNullable<Required<NuxtI18nOptions<unknown>>['locales']>;
    /** @internal Overwritten at build time, used to pass generated options to runtime */
    defaultLocale: Required<NuxtI18nOptions>['defaultLocale'];
    /** @internal Overwritten at build time, used to pass generated options to runtime */
    experimental: NonNullable<NuxtI18nOptions['experimental']>;
    /** @internal Overwritten at build time, used to pass generated options to runtime */
    detectBrowserLanguage: Required<NuxtI18nOptions>['detectBrowserLanguage'];
    /** @internal Overwritten at build time, used to pass generated options to runtime */
    skipSettingLocaleOnNavigate: Required<NuxtI18nOptions>['skipSettingLocaleOnNavigate'];
}

declare const _default: _nuxt_schema.NuxtModule<NuxtI18nOptions, NuxtI18nOptions, false>;

type UserNuxtI18nOptions = Omit<NuxtI18nOptions, 'locales'> & {
    locales?: string[] | LocaleObject<string>[];
};
interface ModuleOptions extends UserNuxtI18nOptions {
}
interface ModulePublicRuntimeConfig {
    i18n: Partial<I18nPublicRuntimeConfig>;
}
interface ModuleHooks {
    'i18n:registerModule': (registerModule: (config: Pick<NuxtI18nOptions<unknown>, 'langDir' | 'locales'>) => void) => HookResult;
}
interface ModuleRuntimeHooks {
    'i18n:beforeLocaleSwitch': <Context = unknown>(params: {
        oldLocale: Locale;
        newLocale: Locale;
        initialSetup: boolean;
        /** @deprecated use `const context = useNuxtApp()` outside hook scope instead */
        context: Context;
    }) => HookResult;
    'i18n:localeSwitched': (params: {
        oldLocale: Locale;
        newLocale: Locale;
    }) => HookResult;
}
declare module '#app' {
    interface RuntimeNuxtHooks extends ModuleRuntimeHooks {
    }
}
declare module '@nuxt/schema' {
    interface NuxtConfig {
        ['i18n']?: Partial<UserNuxtI18nOptions>;
    }
    interface NuxtOptions {
        ['i18n']: UserNuxtI18nOptions;
    }
    interface NuxtHooks extends ModuleHooks {
    }
    interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {
    }
}

export { STRATEGIES, STRATEGY_NO_PREFIX, STRATEGY_PREFIX, STRATEGY_PREFIX_AND_DEFAULT, STRATEGY_PREFIX_EXCEPT_DEFAULT, _default as default };
export type { BaseUrlResolveHandler, BundleOptions, CustomBlocksOptions, CustomRoutePages, DetectBrowserLanguageOptions, Directions, ExperimentalFeatures, FileMeta, I18nHeadMetaInfo, I18nHeadOptions, I18nPublicRuntimeConfig, LocaleFile, LocaleInfo, LocaleMessageCompilationOptions, LocaleObject, LocaleType, MetaAttrs, ModuleHooks, ModuleOptions, ModulePublicRuntimeConfig, ModuleRuntimeHooks, NuxtI18nOptions, RedirectOnOptions, RootRedirectOptions, SeoAttributesOptions, Strategies, VueI18nConfig };