aymericzip/intlayer-skills / skills/intlayer-react
intlayer-react
VerifiedIntegrates Intlayer internationalization with React component. Use when the user asks to "setup React i18n", create a new translated component, use the "useIntlayer" hook, or configure providers.
references/environment_tanstack-start.md
View on GitHub---
createdAt: 2025-09-09
updatedAt: 2026-09-27
priority: 10
title: "TanStack Start i18n - Complete guide to translate your app"
description: "Set up Intlayer in TanStack Start: locale route params, SSR-safe translated content, localized head metadata, hreflang and sitemap."
keywords:
- Internationalization
- Documentation
- Intlayer
- Tanstack Start
- React
- i18n
- TypeScript
- Locale Routing
- Sitemap
slugs:
- doc
- environment
- tanstack-start
applicationTemplate: https://github.com/aymericzip/intlayer-tanstack-start-template
applicationShowcase: https://intlayer-tanstack-start-template.vercel.app
youtubeVideo: https://www.youtube.com/watch?v=_XTdKVWaeqg
history:
- version: 9.4.0
date: 2026-08-25
changes: "Compare static, dynamic and cached dynamic resolution of metadata dictionaries in route head functions"
- version: 8.9.0
date: 2026-05-04
changes: "Update Solid useIntlayer API usage to direct property access"
- version: 8.6.0
date: 2026-03-29
changes: "Add pre-render & sitemap"
- version: 7.5.9
date: 2025-12-30
changes: "Add init command"
- version: 7.4.0
date: 2025-12-11
changes: "Introduce validatePrefix and add step 14 - Handling 404 pages with localized routes."
- version: 7.3.9
date: 2025-12-05
changes: "Add step 13 - Retrieve the locale in your server actions (Optional)"
- version: 7.2.3
date: 2025-11-18
changes: "Add step 13 - Adapt Nitro"
- version: 7.1.0
date: 2025-11-17
changes: "Fix prefix default by adding getPrefix function useLocalizedNavigate, LocaleSwitcher and LocalizedLink."
- version: 6.5.2
date: 2025-10-03
changes: "Update documentation"
- version: 5.8.1
date: 2025-09-09
changes: "Added for Tanstack Start"
author: aymericzip
---
# Translate your Tanstack Start website using Intlayer
## Table of Contents
<TOC/>
This guide demonstrates how to integrate **Intlayer** for seamless internationalization in Tanstack Start projects with locale-aware routing, TypeScript support, and modern development practices.
## Why Intlayer over alternatives?
Compared to main solutions like `react-i18next` or `use-intl`, or `paraglide`, Intlayer is a solution that comes with integrated optimizations such as:
<AccordionGroup>
<Accordion header="Full TanStack Start coverage">
Intlayer is fully optimized for TanStack Start, providing **multilingual routing**, **cookie management**, **sitemap generation**, **dynamic content loading**, and all the features needed to scale your internationalization (i18n) efforts.
</Accordion>
<Accordion header="Bundle size">
Instead of loading massive JSON files into your pages, load only the necessary content. Intlayer helps **reduce your bundle and page sizes by up to 50%**.
</Accordion>
<Accordion header="Maintainability">
Scoping your application's content **facilitates maintenance** for large-scale applications. You can duplicate or delete a single feature folder without the mental burden of reviewing your entire content codebase. Additionally, Intlayer is **fully typed** to ensure your content's accuracy.
</Accordion>
<Accordion header="AI Agent">
Co-locating content **reduces the context needed** by Large Language Models (LLMs). Intlayer also comes with a suite of tools, such as a **CLI** to test for missing translations,**[LSP](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/lsp.md)**, **[MCP](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/mcp_server.md)**, and **[agent skills](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/agent_skills.md)**, to make the developer experience (DX) even smoother for AI agents.
- [LSP](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/lsp.md)
- [MCP](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/mcp_server.md)
- [agent skills](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/agent_skills.md)
</Accordion>
<Accordion header="Automation">
Use automation to translate in your CI/CD pipeline using the LLM of your choice at the cost of your AI provider. Intlayer also offers a **compiler** to automate content extraction, as well as a [web platform](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_CMS.md) to help **translate in the background**.
- [web platform](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_CMS.md)
</Accordion>
<Accordion header="Performance">
Connecting massive JSON files to components can lead to performance and reactivity issues. Intlayer optimizes your content loading at build time.
</Accordion>
<Accordion header="Scaling with none-dev">
More than just an i18n solution, Intlayer provides an **self-hosted [visual editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_visual_editor.md)** and a **[full CMS](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_CMS.md)** to help you manage your multilingual content in **real-time**, making collaboration with translators, copywriters, and other team members seamless. Content can be stored locally and/or remotely.
- [visual editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_visual_editor.md)
- [full CMS](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_CMS.md)
</Accordion>
</AccordionGroup>
## Step-by-Step Guide to Set Up Intlayer in a Tanstack Start Application
<Tabs defaultTab="video">
<Tab label="Video" value="video">
<iframe title="The best i18n solution for Tanstack Start? Discover Intlayer" class="m-auto aspect-16/9 w-full overflow-hidden rounded-lg border-0" allow="autoplay; gyroscope;" loading="lazy" width="1080" height="auto" src="https://www.youtube.com/embed/_XTdKVWaeqg?autoplay=0&origin=https://intlayer.org&controls=0&rel=1"/>
</Tab>
<Tab label="Code" value="code">
<iframe
src="https://ide.intlayer.org/aymericzip/intlayer-tanstack-start-template?file=intlayer.config.ts"
className="m-auto overflow-hidden rounded-lg border-0 max-md:size-full max-md:h-[700px] md:aspect-16/9 md:w-full"
title="Demo CodeSandbox - How to Internationalize your application using Intlayer"
sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
loading="lazy"
/>
</Tab>
<Tab label="Demo" value="demo">
<iframe
src="https://intlayer-tanstack-start-template.vercel.app"
className="m-auto overflow-hidden rounded-lg border-0 max-md:size-full max-md:h-[700px] md:aspect-16/9 md:w-full"
title="Demo - intlayer-tanstack-start-template"
sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
loading="lazy"
/>
</Tab>
</Tabs>
See [Application Template](https://github.com/aymericzip/intlayer-tanstack-start-template) on GitHub.
<Steps>
<Step number={1} title="Create Project">
Start by creating a new TanStack Start project by following the [Start new project](https://tanstack.com/start/latest/docs/framework/react/quick-start) guide on the TanStack Start website.
</Step>
<Step number={2} title="Install Intlayer Packages">
Install the necessary packages using your preferred package manager:
```bash packageManager="npm"
npx intlayer init --interactive
```
```bash packageManager="pnpm"
pnpm dlx intlayer init --interactive
```
```bash packageManager="yarn"
yarn dlx intlayer init --interactive
```
```bash packageManager="bun"
bunx intlayer init --interactive
```
> the `--interactive` flag is optional. Use `intlayer-cli init` if you're an AI agent.
> This command will detect your environment and install the required packages. For example:
```bash packageManager="npm"
npm install intlayer react-intlayer
npm install vite-intlayer --save-dev
```
```bash packageManager="pnpm"
pnpm add intlayer react-intlayer
pnpm add vite-intlayer --save-dev
```
```bash packageManager="yarn"
yarn add intlayer react-intlayer
yarn add vite-intlayer --save-dev
```
```bash packageManager="bun"
bun add intlayer react-intlayer
bun add vite-intlayer --dev
```
- **intlayer**
The core package that provides internationalization tools for configuration management, translation, [content declaration](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/content_file.md), transpilation, and [CLI commands](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/index.md).
- **react-intlayer**
The package that integrates Intlayer with React application. It provides context providers and hooks for React internationalization.
- **vite-intlayer**
Includes the Vite plugin for integrating Intlayer with the [Vite bundler](https://vite.dev/guide/why.html#why-bundle-for-production), as well as middleware for detecting the user's preferred locale, managing cookies, and handling URL redirection.
</Step>
<Step number={3} title="Configuration of your project">
### Architecture
In this architecture, all localized routes are nested under the `{-$locale}` route segment. This approach ensures each language has a dedicated URL while enabling automatic locale prefixing, validation, and SEO optimization.
```bash
.
├── src
│ ├── components
│ │ ├── Header.tsx
│ │ ├── locale-switcher.content.ts
│ │ ├── locale-switcher.tsx
│ │ └── localized-link.tsx
│ ├── hooks
│ │ ├── useI18nHTMLAttributes.tsx
│ │ └── useLocalizedNavigate.ts
│ ├── routes
│ │ ├── {-$locale}
│ │ │ ├── 404.content.ts
│ │ │ ├── 404.tsx
│ │ │ ├── about.content.ts
│ │ │ ├── about.tsx
│ │ │ ├── index.content.tsx
│ │ │ ├── index.tsx
│ │ │ └── route.tsx # Locale layout & prefix validation
│ │ ├── __root.tsx # Root route with IntlayerProvider
│ │ └── sitemap[.]xml.ts
│ ├── router.tsx
│ └── styles.css
├── intlayer.config.ts
├── package.json
├── tsconfig.json
└── vite.config.ts
```
### Configuration
Create a config file to configure the languages of your application:
```typescript fileName="intlayer.config.ts"
import type { IntlayerConfig } from "intlayer";
import { Locales } from "intlayer";
const config: IntlayerConfig = {
internationalization: {
defaultLocale: Locales.ENGLISH,
locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
},
};
export default config;
```
> Through this configuration file, you can set up localized URLs, middleware redirection, cookie names, the location and extension of your content declarations, disable Intlayer logs in the console, and more. For a complete list of available parameters, refer to the [configuration documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/configuration.md).
- [configuration documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/configuration.md)
</Step>
<Step number={4} title="Integrate Intlayer in Your Vite Configuration">
Add the intlayer plugin into your configuration:
```typescript fileName="vite.config.ts"
import { tanstackStart } from "@tanstack/react-start/plugin/vite";
import viteReact from "@vitejs/plugin-react";
import { nitro } from "nitro/vite";
import { defineConfig } from "vite";
import { intlayer } from "vite-intlayer";
const config = defineConfig({
plugins: [
nitro(),
intlayer({
proxy: {
ignore: (req) => req.url?.startsWith("/api"),
},
}),
tanstackStart({
router: {
routeFileIgnorePattern:
".content.(ts|tsx|js|mjs|cjs|jsx|json|jsonc|json5|md|mdx|yaml|yml)$",
},
}),
viteReact(),
],
});
export default config;
```
> The `intlayer()` Vite plugin is used to integrate Intlayer with Vite. It ensures the building of content declaration files and monitors them in development mode. It defines Intlayer environment variables within the Vite application. Additionally, it provides aliases to optimize performance.
</Step>
<Step number={5} title="Create Root Layout">
Configure your root layout to support internationalization by using `useParams` to detect the current locale and setting the `lang` and `dir` attributes on the `html` tag.
```tsx fileName="src/routes/__root.tsx"
import {
createRootRouteWithContext,
getRouteApi,
HeadContent,
Scripts,
} from "@tanstack/react-router";
import { defaultLocale, getHTMLTextDir } from "intlayer";
import { type ReactNode } from "react";
import { IntlayerProvider } from "react-intlayer";
const localeRoute = getRouteApi("/{-$locale}");
export const Route = createRootRouteWithContext<{}>()({
head: () => ({
meta: [
{
charSet: "utf-8",
},
{
content: "width=device-width, initial-scale=1",
name: "viewport",
},
{
title: "TanStack Start Starter",
},
],
}),
shellComponent: RootDocument,
});
function RootDocument({ children }: { children: ReactNode }) {
const params = localeRoute.useParams();
const locale = params?.locale ?? defaultLocale;
return (
<html dir={getHTMLTextDir(locale)} lang={locale}>
<head>
<HeadContent />
</head>
<body>
<IntlayerProvider locale={locale}>{children}</IntlayerProvider>
<Scripts />
</body>
</html>
);
}
```
</Step>
<Step number={6} title="Create Locale Layout">
Create a layout that handles the locale prefix and performs validation.
```tsx fileName="src/routes/{-$locale}/route.tsx"
import { createFileRoute, Outlet, redirect } from "@tanstack/react-router";
import { validatePrefix } from "intlayer";
export const Route = createFileRoute("/{-$locale}")({
beforeLoad: ({ params }) => {
const localeParam = params.locale;
// Validate the locale prefix
const { isValid, localePrefix } = validatePrefix(localeParam);
if (!isValid) {
throw redirect({
to: "/{-$locale}/404",
params: { locale: localePrefix },
});
}
},
component: Outlet,
});
```
> Here, `{-$locale}` is a dynamic route parameter that gets replaced with the current locale. This notation makes the slot optional, allowing it to work with routing modes such as `'prefix-no-default'` etc.
> Be aware that this slot may cause issues if you use multiple dynamic segments in the same route (e.g., `/{-$locale}/other-path/$anotherDynamicPath/...`).
> For the `'prefix-all'` mode, you may prefer switching the slot to `$locale` instead.
> For the `'no-prefix'` or `'search-params'` mode, you can remove the slot entirely.
</Step>
<Step number={7} title="Declare Your Content">
Create and manage your content declarations to store translations:
```tsx fileName="src/contents/page.content.ts"
import type { Dictionary } from "intlayer";
import { t } from "intlayer";
const appContent = {
content: {
links: {
about: t({
en: "About",
es: "Acerca de",
fr: "À propos",
}),
home: t({
en: "Home",
es: "Inicio",
fr: "Accueil",
}),
},
meta: {
title: t({
en: "Welcome to Intlayer + TanStack Router",
es: "Bienvenido a Intlayer + TanStack Router",
fr: "Bienvenue à Intlayer + TanStack Router",
}),
description: t({
en: "This is an example of using Intlayer with TanStack Router",
es: "Este es un ejemplo de uso de Intlayer con TanStack Router",
fr: "Ceci est un exemple d'utilisation d'Intlayer avec TanStack Router",
}),
},
},
key: "app",
} satisfies Dictionary;
export default appContent;
```
> Your content declarations can be defined anywhere in your application as soon they are included into the `contentDir` directory (by default, `./app`). And match the content declaration file extension (by default, `.content.{json,ts,tsx,js,jsx,mjs,cjs,md,mdx,yaml,yml}`).
> For more details, refer to the [content declaration documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/content_file.md).
- [content declaration documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/content_file.md)
</Step>
<Step number={7} title="Create Locale-Aware Components and Hooks">
Create a `LocalizedLink` component for locale-aware navigation:
```tsx fileName="src/components/localized-link.tsx"
import type { FC } from "react";
import { Link, type LinkComponentProps } from "@tanstack/react-router";
import { useLocale } from "react-intlayer";
import { getPrefix } from "intlayer";
export const LOCALE_ROUTE = "{-$locale}" as const;
export type To = StripLocalePrefix<LinkComponentProps["to"]>;
export type StripLocalePrefix<T extends string | undefined> = T extends
`/${typeof LOCALE_ROUTE}/` | `/${typeof LOCALE_ROUTE}`
? "/"
: T extends `/${typeof LOCALE_ROUTE}/${infer Rest}`
? `/${Rest}`
: T;
type LocalizedLinkProps = {
to?: To;
} & Omit<LinkComponentProps, "to">;
export const LocalizedLink: FC<LocalizedLinkProps> = (props) => {
const { locale } = useLocale();
const { localePrefix } = getPrefix(locale);
return (
<Link
{...props}
params={{
locale: localePrefix,
...(typeof props?.params === "object" ? props?.params : {}),
}}
to={`/${LOCALE_ROUTE}${props.to}` as LinkComponentProps["to"]}
/>
);
};
```
This component has two objectives:
- Remove the unnecessary `{-$locale}` prefix from the URL.
- Inject the locale parameter into the URL to ensure the user is directly redirected to the localized route.
Then we can create a `useLocalizedNavigate` hook for programmatic navigation:
```tsx fileName="src/hooks/useLocalizedNavigate.tsx"
import { useNavigate } from "@tanstack/react-router";
import { getPrefix } from "intlayer";
import { useLocale } from "react-intlayer";
import type { StripLocalePrefix } from "@/components/localized-link";
import type { FileRouteTypes } from "@/routeTree.gen";
type NavigateFn = ReturnType<typeof useNavigate>;
type BaseNavigateOptions = Parameters<NavigateFn>[0];
type LocalizedTo = StripLocalePrefix<FileRouteTypes["to"]>;
export type LocalizedNavigateOptions = Omit<
BaseNavigateOptions,
"to" | "params"
> & {
to: LocalizedTo;
params?: Omit<NonNullable<BaseNavigateOptions["params"]>, "locale">;
};
type LocalizedNavigate = (
options: LocalizedNavigateOptions
) => ReturnType<NavigateFn>;
export const useLocalizedNavigate = () => {
const navigate = useNavigate();
const { locale } = useLocale();
const localizedNavigate: LocalizedNavigate = (args: any) => {
const { localePrefix } = getPrefix(locale);
if (typeof args === "string") {
return navigate({
to: `/${LOCALE_ROUTE}${args}`,
params: { locale: localePrefix },
});
}
const { to, ...rest } = args;
const localizedTo = `/${LOCALE_ROUTE}${to}` as any;
return navigate({
to: localizedTo,
params: { locale: localePrefix, ...rest } as any,
});
};
return localizedNavigate;
};
```
</Step>
<Step number={8} title="Utilize Intlayer in Your Pages">
> Use **`useIntlayer`** by default: it is the recommended way to read content inside components, and the compiler resolves it to the locale being rendered. Reach for `getIntlayer` / `getIntlayerAsync` only outside the React tree: route `head`, loaders and server functions.
Access your content dictionaries throughout your application:
#### Localized Home Page
```tsx fileName="src/routes/{-$locale}/index.tsx"
import { createFileRoute } from "@tanstack/react-router";
import { useIntlayer } from "react-intlayer";
import LocaleSwitcher from "@/components/locale-switcher";
import { LocalizedLink } from "@/components/localized-link";
import { useLocalizedNavigate } from "@/hooks/useLocalizedNavigate";
export const Route = createFileRoute("/{-$locale}/")({
component: RouteComponent,
});
function RouteComponent() {
const content = useIntlayer("app");
const navigate = useLocalizedNavigate();
return (
<div>
<div>
{content.title}
<LocaleSwitcher />
<div>
<LocalizedLink to="/">{content.links.home}</LocalizedLink>
<LocalizedLink to="/about">{content.links.about}</LocalizedLink>
</div>
<div>
<button onClick={() => navigate({ to: "/" })}>
{content.links.home}
</button>
<button onClick={() => navigate({ to: "/about" })}>
{content.links.about}
</button>
</div>
</div>
</div>
);
}
```
> If you want to use your content in a `string` attribute, such as `alt`, `title`, `href`, `aria-label`, etc., you can use the value of the function, like:
>
> ```tsx
> <img src={content.image.src.value} alt={content.image.value} />
> <img src={content.image.src.toString()} alt={content.image.toString()} />
> <img src={String(content.image.src)} alt={String(content.image)} />
> ```
> To Learn more about the `useIntlayer` hook, refer to the [documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/react-intlayer/useIntlayer.md).
- [useIntlayer Hook Documentation | react-intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/react-intlayer/useIntlayer.md)
</Step>
<Step number={9} title="Create a Locale Switcher Component">
Create a component to allow users to change languages:
```tsx fileName="src/components/locale-switcher.tsx"
import { useLocation } from "@tanstack/react-router";
import {
getHTMLTextDir,
getLocaleName,
getPathWithoutLocale,
getPrefix,
Locales,
} from "intlayer";
import type { FC } from "react";
import { useLocale } from "react-intlayer";
import { LocalizedLink, type To } from "./localized-link";
export const LocaleSwitcher: FC = () => {
const { pathname } = useLocation();
const { availableLocales, locale, setLocale } = useLocale();
const pathWithoutLocale = getPathWithoutLocale(pathname);
return (
<ol>
{availableLocales.map((localeEl) => (
<li key={localeEl}>
<LocalizedLink
aria-current={localeEl === locale ? "page" : undefined}
onClick={() => setLocale(localeEl)}
params={{ locale: getPrefix(localeEl).localePrefix }}
to={pathWithoutLocale as To}
>
<span>
{/* Locale - e.g. FR */}
{localeEl}
</span>
<span>
{/* Language in its own Locale - e.g. Français */}
{getLocaleName(localeEl, locale)}
</span>
<span dir={getHTMLTextDir(localeEl)} lang={localeEl}>
{/* Language in current Locale - e.g. Francés with current locale set to Locales.SPANISH */}
{getLocaleName(localeEl)}
</span>
<span dir="ltr" lang={Locales.ENGLISH}>
{/* Language in English - e.g. French */}
{getLocaleName(localeEl, Locales.ENGLISH)}
</span>
</LocalizedLink>
</li>
))}
</ol>
);
};
```
> To Learn more about the `useLocale` hook, refer to the [documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/react-intlayer/useLocale.md).
- [useLocale Hook Documentation | react-intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/react-intlayer/useLocale.md)
</Step>
<Step number={10} title="HTML Attributes Management">
As seen in Step 5, you can manage the `lang` and `dir` attributes of the `html` tag using `useParams` in your root component. This ensures that the correct attributes are set on the server and client.
```tsx fileName="src/routes/__root.tsx"
const localeRoute = getRouteApi("/{-$locale}");
function RootDocument({ children }: { children: ReactNode }) {
const params = localeRoute.useParams();
const locale = params?.locale ?? defaultLocale;
return (
<html dir={getHTMLTextDir(locale)} lang={locale}>
{/* ... */}
</html>
);
}
```
</Step>
<Step number={11} title="Add middleware">
You can also use the `intlayerProxy` to add server-side routing to your application. This plugin will automatically detect the current locale based on the URL and set the appropriate locale cookie. If no locale is specified, the plugin will determine the most appropriate locale based on the user's browser language preferences. If no locale is detected, it will redirect to the default locale.
> Note that to use the `intlayerProxy` in production, you need to switch the `vite-intlayer` package from `devDependencies` to `dependencies`.
> Since Intlayer v9, `intlayerProxy()` is bundled directly into the `intlayer()` plugin and enabled by default through the `routing.enableProxy` option (`true` by default). Registering it separately as shown below is now optional: it is kept for backward compatibility and for setups that need to control plugin order. Set `routing.enableProxy: false` to opt out. See the [v9 release notes](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/releases/v9.md).
- [v9 release notes](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/releases/v9.md)
```typescript fileName="vite.config.ts"
import { tanstackStart } from "@tanstack/react-start/plugin/vite";
import viteReact from "@vitejs/plugin-react";
import { nitro } from "nitro/vite";
import { defineConfig } from "vite";
import { intlayer } from "vite-intlayer";
export default defineConfig({
plugins: [
nitro(),
intlayer({
proxy: {
ignore: (req) => req.url?.startsWith("/api"),
},
}),
tanstackStart({
router: {
routeFileIgnorePattern:
".content.(ts|tsx|js|mjs|cjs|jsx|json|jsonc|json5|md|mdx|yaml|yml)$",
},
}),
viteReact(),
],
});
```
</Step>
<Step number={12} title="Internationalize your Metadata">
<Tabs>
<Tab label="Static resolution" value="static">
`getIntlayer` resolves synchronously against the **merged** dictionary, the one holding every declared locale. `head` stays synchronous and nothing is awaited, but the whole multilingual dictionary is pulled into the route chunk sent to the browser.
```tsx fileName="src/routes/{-$locale}/index.tsx"
import { createFileRoute } from "@tanstack/react-router";
import {
defaultLocale,
getIntlayer,
getLocalizedUrl,
localeMap,
} from "intlayer";
export const Route = createFileRoute("/{-$locale}/")({
component: RouteComponent,
head: ({ params }) => {
const { locale = defaultLocale } = params;
const path = "/"; // The path for this route
const metaContent = getIntlayer("app", locale);
return {
links: [
// Canonical link: Points to the current localized page
{ rel: "canonical", href: getLocalizedUrl(path, locale) },
// Hreflang: Tell Google about all localized versions
...localeMap(({ locale: mapLocale }) => ({
rel: "alternate",
hrefLang: mapLocale,
href: getLocalizedUrl(path, mapLocale),
})),
// x-default: For users in unmatched languages
// Define the default fallback locale (usually your primary language)
{
rel: "alternate",
hrefLang: "x-default",
href: getLocalizedUrl(path, defaultLocale),
},
],
meta: [
{ title: metaContent.title },
{ name: "description", content: metaContent.meta.description },
],
};
},
});
```
Best for small metadata dictionaries, a handful of locales, or while prototyping.
</Tab>
<Tab label="Dynamic resolution" value="dynamic">
`getIntlayerAsync` (available from **v9.4**) behaves like `getIntlayer`, but the build plugin points it at the per-locale chunk in `.intlayer/dynamic_dictionaries/` instead of the merged dictionary. A page therefore ships only the locale it renders. Because that chunk is loaded on demand, `head` becomes `async`:
```tsx fileName="src/routes/{-$locale}/index.tsx"
import { createFileRoute } from "@tanstack/react-router";
import {
defaultLocale,
getIntlayerAsync,
getLocalizedUrl,
localeMap,
} from "intlayer";
export const Route = createFileRoute("/{-$locale}/")({
component: RouteComponent,
head: async ({ params }) => {
const { locale = defaultLocale } = params;
const path = "/"; // The path for this route
const metaContent = await getIntlayerAsync("app", locale);
return {
links: [
// Canonical link: Points to the current localized page
{ rel: "canonical", href: getLocalizedUrl(path, locale) },
// Hreflang: Tell Google about all localized versions
...localeMap(({ locale: mapLocale }) => ({
rel: "alternate",
hrefLang: mapLocale,
href: getLocalizedUrl(path, mapLocale),
})),
// x-default: For users in unmatched languages
// Define the default fallback locale (usually your primary language)
{
rel: "alternate",
hrefLang: "x-default",
href: getLocalizedUrl(path, defaultLocale),
},
],
meta: [
{ title: metaContent.title },
{ name: "description", content: metaContent.meta.description },
],
};
},
});
```
> If a `head` reads several dictionaries, resolve them with `Promise.all`: awaiting each `getIntlayerAsync` on its own line chains the requests instead of running them in parallel.
The trade-off: the dynamic import is resolved while `head` runs, on the critical path of the document render. On a cold route this delays the head by a few milliseconds and can slightly degrade **LCP**.
</Tab>
<Tab label="Cached dynamic resolution" value="cached">
Resolve the dictionary in the route `loader` and read it back from `loaderData` in `head`. Loaders of the matched routes run in parallel, and `staleTime: Infinity` tells TanStack Router the result never goes stale, so the per-locale chunk is resolved once and served from the router cache afterwards, leaving `head` synchronous.
```tsx fileName="src/routes/{-$locale}/index.tsx"
import { createFileRoute } from "@tanstack/react-router";
import {
defaultLocale,
getIntlayerAsync,
getLocalizedUrl,
localeMap,
} from "intlayer";
export const Route = createFileRoute("/{-$locale}/")({
component: RouteComponent,
// Resolved in parallel with the other matched routes, off the head critical path
loader: async ({ params }) => {
const { locale = defaultLocale } = params;
return { metaContent: await getIntlayerAsync("app", locale) };
},
// The dictionary never changes for a given locale: resolve the chunk once
staleTime: Infinity,
head: ({ params, loaderData }) => {
const { locale = defaultLocale } = params;
const path = "/"; // The path for this route
return {
links: [
// Canonical link: Points to the current localized page
{ rel: "canonical", href: getLocalizedUrl(path, locale) },
// Hreflang: Tell Google about all localized versions
...localeMap(({ locale: mapLocale }) => ({
rel: "alternate",
hrefLang: mapLocale,
href: getLocalizedUrl(path, mapLocale),
})),
// x-default: For users in unmatched languages
// Define the default fallback locale (usually your primary language)
{
rel: "alternate",
hrefLang: "x-default",
href: getLocalizedUrl(path, defaultLocale),
},
],
meta: [
{ title: loaderData?.metaContent.title },
{
name: "description",
content: loaderData?.metaContent.meta.description,
},
],
};
},
});
```
> `head` can be called before the loader settles, so `loaderData` is typed as possibly `undefined`. Keep the optional chaining, or return a fallback title.
You keep the per-locale chunk without paying its cost on the head critical path. The price is developer experience: the content has to be threaded explicitly from the loader to the `head` through `loaderData`.
</Tab>
</Tabs>
### Which resolution should I pick?
| | Static resolution | Dynamic resolution | Cached dynamic resolution |
| -------------------- | --------------------- | -------------------------- | -------------------------------------- |
| API | `getIntlayer` | `getIntlayerAsync` (v9.4+) | `getIntlayerAsync` in `loader` (v9.4+) |
| `head` signature | synchronous | `async` | synchronous, reads `loaderData` |
| Locales shipped | every declared locale | requested locale only | requested locale only |
| Client navigations | nothing to resolve | re-entered on every match | served from the router cache |
| Developer experience | simplest | one `await` | content threaded through `loaderData` |
</Step>
<Step number={13} title="Retrieve the locale in your server actions">
You may want to access the current locale from inside your server actions or API endpoints.
You can do this using the `getLocale` helper from `intlayer`.
Here's an example using TanStack Start's server functions:
```tsx fileName="src/routes/{-$locale}/index.tsx"
import { createServerFn } from "@tanstack/react-start";
import {
getRequestHeader,
getRequestHeaders,
} from "@tanstack/react-start/server";
import { getCookie, getIntlayer, getLocale } from "intlayer";
export const getLocaleServer = createServerFn().handler(async () => {
const locale = await getLocale({
// Get the cookie from the request (default: 'INTLAYER_LOCALE')
getCookie: (name) => {
const cookieString = getRequestHeader("cookie");
return getCookie(name, cookieString);
},
// Get the header from the request (default: 'x-intlayer-locale')
// Fallback using Accept-Language negotiation
getHeader: (name) => getRequestHeader(name),
});
// Retrieve some content using getIntlayerAsync()
const content = getIntlayer("app", locale);
return { locale, content };
});
```
</Step>
<Step number={14} title="Manage not found pages">
When a user visits a non-existing page, you can display a custom not found page and the locale prefix may impact the way the not found page is triggered.
#### Understanding TanStack Router's 404 Handling with Locale Prefixes
In TanStack Router, handling 404 pages with localized routes requires a multi-layered approach:
1. **Dedicated 404 route**: A specific route to display the 404 UI
2. **Route-level validation**: Validates locale prefixes and redirects invalid ones to 404
3. **Catch-all route**: Captures any unmatched paths within the locale segment
```tsx fileName="src/routes/{-$locale}/404.tsx"
import { createFileRoute } from "@tanstack/react-router";
// This creates a dedicated /[locale]/404 route
// It's used both as a direct route and imported as a component in other files
export const Route = createFileRoute("/{-$locale}/404")({
component: NotFoundComponent,
});
// Exported separately so it can be reused in notFoundComponent and catch-all routes
export function NotFoundComponent() {
return (
<div>
<h1>404</h1>
</div>
);
}
```
```tsx fileName="src/routes/{-$locale}/route.tsx"
import { createFileRoute, Outlet, redirect } from "@tanstack/react-router";
import { validatePrefix } from "intlayer";
import { NotFoundComponent } from "./404";
export const Route = createFileRoute("/{-$locale}")({
// beforeLoad runs before the route renders (on both server and client)
// It's the ideal place to validate the locale prefix
beforeLoad: ({ params }) => {
const localeParam = params.locale;
// validatePrefix checks if the locale is valid according to your intlayer config
const { isValid, localePrefix } = validatePrefix(localeParam);
if (!isValid) {
// Invalid locale prefix - redirect to the 404 page with a valid locale prefix
throw redirect({
to: "/{-$locale}/404",
params: { locale: localePrefix },
});
}
},
component: Outlet,
// notFoundComponent is called when a child route doesn't exist
// e.g., /en/non-existent-page triggers this within the /en layout
notFoundComponent: NotFoundComponent,
});
```
```tsx fileName="src/routes/{-$locale}/$.tsx"
import { createFileRoute } from "@tanstack/react-router";
import { NotFoundComponent } from "./404";
// The $ (splat/catch-all) route matches any path that doesn't match other routes
// e.g., /en/some/deeply/nested/invalid/path
// This ensures ALL unmatched paths within a locale show the 404 page
// Without this, unmatched deep paths might show a blank page or error
export const Route = createFileRoute("/{-$locale}/$")({
component: NotFoundComponent,
});
```
</Step>
<Step number={15} title="Extract the content of your components" isOptional={true}>
If you have an existing codebase, transforming thousands of files can be time-consuming.
To ease this process, Intlayer propose a [compiler](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/compiler.md) / [extractor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/extract.md) to transform your components and extract the content.
- [compiler](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/compiler.md)
- [extractor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/extract.md)
To set it up, you can add a `compiler` section in your `intlayer.config.ts` file:
```typescript fileName="intlayer.config.ts" codeFormat={["typescript", "esm", "commonjs"]}
import { type IntlayerConfig } from "intlayer";
const config: IntlayerConfig = {
// ... Rest of your config
compiler: {
/**
* Indicates if the compiler should be enabled.
*/
enabled: true,
/**
* Defines the output files path
*/
output: ({ fileName, extension }) => `./${fileName}${extension}`,
/**
* Indicates if the components should be saved after being transformed.
*
* - If `true`, the compiler will rewrite the component file in the disk. So the transformation will be permanent, and the compiler will skip the transformation for the next process. That way, the compiler can transform the app, and then it can be removed.
*
* - If `false`, the compiler will inject the `useIntlayer()` function call into the code in the build output only, and keep the base codebase intact. The transformation will be done only in memory.
*/
saveComponents: false,
/**
* Dictionary key prefix
*/
dictionaryKeyPrefix: "",
},
};
export default config;
```
<Tabs>
<Tab value='Extract command'>
Run the extractor to transform your components and extract the content
```bash packageManager="npm"
npx intlayer extract
```
```bash packageManager="pnpm"
pnpm intlayer extract
```
```bash packageManager="yarn"
yarn intlayer extract
```
```bash packageManager="bun"
bun x intlayer extract
```
</Tab>
<Tab value='Babel compiler'>
<Tabs>
<Tab value='intlayer >= 9'>
> Since v9, the `intlayerCompiler` is included in the `intlayer` plugin. So you don't need to add it manually.
</Tab>
<Tab value='intlayer < 9'>
Update your `vite.config.ts` to include the `intlayerCompiler` plugin:
```ts fileName="vite.config.ts"
import { defineConfig } from "vite";
import { intlayer, intlayerCompiler } from "vite-intlayer";
export default defineConfig({
plugins: [
intlayer(),
intlayerCompiler(), // Adds the compiler plugin
],
});
```
</Tab>
</Tabs>
Build your application to transform your components and extract the content
```bash packageManager="npm"
npm run build # Or npm run dev
```
```bash packageManager="pnpm"
pnpm run build # Or pnpm run dev
```
```bash packageManager="yarn"
yarn build # Or yarn dev
```
```bash packageManager="bun"
bun run build # Or bun run dev
```
</Tab>
</Tabs>
</Step>
<Step number={16} title="Pre-render & Generate Sitemap">
Intlayer comes with a built-in sitemap generator to help you create a sitemap for your application easily. It handles localized routes and adds the necessary metadata for search engines.
> The Intlayer generated sitemap supports the `xhtml:link` namespace (Hreflang XML Extensions). Unlike the default sitemap generators that only list raw URLs, Intlayer automatically creates the required bidirectional links between all language versions of a page (e.g., `/about`, `/about?lang=fr`, and `/about?lang=es`). This ensures search engines correctly index and serve the right language version to the right audience.
To use it, you first need to configure your `vite.config.ts` to enable pre-rendering for your localized routes and disable the default TanStack Start sitemap generation.
```typescript fileName="vite.config.ts"
import { localeFlatMap } from "intlayer";
// ... other imports
export const pathList = ["", "/about", "/404"];
const localizedPages = localeFlatMap(({ urlPrefix }) =>
pathList.map((path) => ({
path: `${urlPrefix}${path}`,
prerender: {
enabled: true,
},
}))
);
export default defineConfig({
plugins: [
// ... other plugins
tanstackStart({
// ... other config
sitemap: {
enabled: false,
},
prerender: {
enabled: true,
crawlLinks: false,
concurrency: 10,
},
pages: localizedPages,
}),
],
});
```
Then, create a `src/routes/sitemap[.]xml.ts` route that uses the `generateSitemap` function:
```typescript fileName="src/routes/sitemap[.]xml.ts"
import { createFileRoute } from "@tanstack/react-router";
import { generateSitemap } from "intlayer";
export const Route = createFileRoute("/sitemap.xml")({
server: {
handlers: {
GET: async () => {
const sitemap = generateSitemap(
[
{ path: "/", changefreq: "daily", priority: 1.0 },
{ path: "/about", changefreq: "monthly", priority: 0.8 },
],
{ siteUrl: "https://example.com" }
);
return new Response(sitemap, {
headers: { "Content-Type": "application/xml" },
});
},
},
},
});
```
</Step>
<Step number={17} title="Configure TypeScript">
Intlayer uses module augmentation to get benefits of TypeScript and make your codebase stronger.
Ensure your TypeScript configuration includes the autogenerated types:
```json5 fileName="tsconfig.json"
{
// ... your existing configurations
include: [
// ... your existing includes
".intlayer/**/*.ts", // Include the auto-generated types
],
}
```
</Step>
</Steps>
### Git Configuration
It is recommended to ignore the files generated by Intlayer. This allows you to avoid committing them to your Git repository.
To do this, you can add the following instructions to your `.gitignore` file:
```plaintext fileName=".gitignore"
# Ignore the files generated by Intlayer
.intlayer
```
## VS Code Extension
To improve your development experience with Intlayer, you can install the official **Intlayer VS Code Extension**.
- [Install from the VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=intlayer.intlayer-vs-code-extension)
This extension provides:
- **Autocompletion** for translation keys.
- **Real-time error detection** for missing translations.
- **Inline previews** of translated content.
- **Quick actions** to easily create and update translations.
For more details on how to use the extension, refer to the [Intlayer VS Code Extension documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/vs_code_extension.md).
- [Intlayer VS Code Extension documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/vs_code_extension.md)
## Go Further
To go further, you can implement the [visual editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_visual_editor.md) or externalize your content using the [CMS](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_CMS.md).
- [visual editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_visual_editor.md)
- [CMS](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_CMS.md)
## Documentation References
- [Intlayer Documentation](https://intlayer.org)
- [Tanstack Start Documentation](https://reactrouter.com/)
- [useIntlayer hook](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/react-intlayer/useIntlayer.md)
- [useLocale hook](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/react-intlayer/useLocale.md)
- [Content Declaration](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/content_file.md)
- [Configuration](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/configuration.md)
## Frequently Asked Questions
<FAQ>
<Question title="What are the different solutions available to internationalize a TanStack Start app?">
TanStack Start ships no i18n layer of its own, so the choice is a library:
- **`i18next` / `react-i18next`** and **`react-intl`**: framework agnostic message catalogs, wired manually into the router.
- **`Lingui`**: ICU messages with a compile step.
- **`Paraglide`**: compiled messages, focused on the message layer only.
- **`Intlayer`**: the most advanced solution. Content declared anywhere in your codebase ([next to each component or centralized](https://github.com/aymericzip/intlayer/blob/main/docs/blog/en/per-component_vs_centralized_i18n.md)) and compiled at build time, with typed keys, locale aware routing, sitemap generation, AI translation, a visual editor and a CMS.
The difference that matters on TanStack Start is routing and server rendering. Intlayer integrates with the file based router, the `head` function and the pre-render pass, instead of leaving you to assemble a provider, a locale detector and a sitemap by hand. See [why Intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/interest_of_intlayer.md) and the [TanStack Start i18n benchmark](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/tanstack.md).
- [why Intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/interest_of_intlayer.md)
- [TanStack Start i18n benchmark](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/tanstack.md)
</Question>
<Question title="How much does i18n add to my TanStack Start bundle size?">
Much less than a namespace based setup, because a page never downloads a catalog it does not render. Server rendered markup resolves its content on the server, and the build time compiler replaces `useIntlayer` calls with the exact dictionary entries a component uses, so unused keys and unused languages are dropped, and [dynamic dictionaries](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dynamic_dictionaries/index.md) split the rest per locale. Measured against the usual alternatives, Intlayer reduces bundle and page size by up to 50%. See [bundle optimization](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/bundle_optimization.md) and the [benchmark](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/tanstack.md).
- [dynamic dictionaries](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dynamic_dictionaries/index.md)
- [bundle optimization](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/bundle_optimization.md)
- [benchmark](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/tanstack.md)
</Question>
<Question title="Can I migrate from `react-i18next` or `react-intl` without rewriting my components?">
Yes, and there are two paths. You can migrate the content progressively with the [react-i18next migration guide](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/migration_from_react-i18next_to_intlayer.md) or the [i18next migration guide](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/migration_from_i18next_to_intlayer.md). Or you can keep your current API entirely: the [compat adapters](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/compat/index.md) expose the exact same API as `react-i18next`, `react-intl` and `i18next`, but served by Intlayer dictionaries, so imports change and component code does not.
- [react-i18next migration guide](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/migration_from_react-i18next_to_intlayer.md)
- [i18next migration guide](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/migration_from_i18next_to_intlayer.md)
- [compat adapters](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/compat/index.md)
</Question>
<Question title="Can I keep my existing JSON translation files?">
Yes. The [sync JSON plugin](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/plugins/sync-json.md) keeps your `/messages/{locale}/{namespace}.json` files as the source of truth and generates Intlayer dictionaries from them, in both directions. A [sync PO plugin](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/plugins/sync-po.md) does the same for gettext catalogs, and [per locale files](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/per_locale_file.md) let you split content by language instead of grouping locales in one file.
- [sync JSON plugin](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/plugins/sync-json.md)
- [sync PO plugin](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/plugins/sync-po.md)
- [per locale files](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/per_locale_file.md)
</Question>
<Question title="Do I have to move my content key by key?">
No. Run `npx intlayer extract` and Intlayer reads your components, pulls the user facing strings out and writes a `.content` file next to each one, so you review a diff instead of copying strings into a catalog one at a time. Step 15 of this guide walks through it.
For a fully automated pipeline, the [Intlayer Compiler](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/compiler.md) does the same at build time: it scans your JSX, TSX, Vue and Svelte source on every change, generates the dictionaries and keeps them in sync through hot module replacement, so there are no keys to maintain by hand at all.
- [Intlayer Compiler](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/compiler.md)
Two limits are worth knowing before you turn the compiler on. It works by static analysis, so strings that only exist at runtime, such as API error codes or CMS fields, stay out of reach. And it has to tell user facing text apart from application logic like `className="active"` or a status code, which needs a few annotations in a large codebase. The [extract command](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/extract.md) avoids both by keeping you in the loop.
- [extract command](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/extract.md)
</Question>
<Question title="What editor and AI agent tooling is available?">
Five pieces, all optional:
- **[VS Code extension](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/vs_code_extension.md)**: jump from a `useIntlayer` key to the content file that declares it, extract content from a component, and run build, fill, test, push and pull from the command palette or a dedicated Intlayer tab.
- **[LSP server](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/lsp.md)**: the same awareness in any editor that speaks LSP, with go to definition, find all references, hover previews of a translated value, autocompletion of keys and fields, and a warning when a key is not declared anywhere. It also resolves `i18next`, `react-i18next`, `next-intl` and `use-intl` calls, which helps while you migrate.
- **[MCP server](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/mcp_server.md)**: exposes the Intlayer documentation and CLI to Cursor, VS Code, Claude Desktop, Claude Code and ChatGPT, so an assistant answers from current docs instead of guessing, and can run commands such as `intlayer fill` itself.
- **[Agent skills](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/agent_skills.md)**: focused skills such as `intlayer-config`, `intlayer-cli` and `intlayer-content`, plus one per framework, that teach an agent your routing setup and the content node types.
- **[ESLint plugin](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/eslint.md)**: `no-raw-text` flags hardcoded strings, with further rules for static dictionary keys and unused content.
</Question>
<Question title="Does Intlayer support server side rendering and pre-rendering in TanStack Start?">
Yes. Content resolves during SSR, and the guide covers the pre-render configuration that emits one static document per localized route. Step 16 shows how to enable `prerender` in `vite.config.ts` and generate a localized sitemap from the same route table.
</Question>
<Question title="How do I add hreflang tags and a localized sitemap?">
Use the built-in `generateSitemap` function in a `src/routes/sitemap[.]xml.ts` route. Unlike a plain URL list, it emits the `xhtml:link` namespace, so every language version of a page links bidirectionally to the others and search engines index the right one for each audience. Localized `head` metadata is covered in step 12.
</Question>
<Question title="Do I have to put the locale in the URL?">
No. `routing.mode` controls the URL scheme: `"prefix-no-default"` (the default, `/about` and `/fr/about`), `"prefix-all"` (`/en/about`), `"no-prefix"` (resolved from cookie, header or domain) or `"search-params"` (`/about?locale=fr`). Locales can also be mapped to separate domains with `routing.domains`. See the [configuration reference](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/configuration.md).
- [configuration reference](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/configuration.md)
</Question>
<Question title="How do I build a locale switcher that keeps the current route?">
Use `useLocale` together with the localized link component described in step 9. `useLocale` exposes the active locale, the available locales and a setter that persists the choice, while `getLocalizedUrl` rewrites the current path into the target language so the user stays on the same page instead of landing on the home page.
</Question>
<Question title="How do I handle 404 pages on localized routes?">
Step 14 covers it. `validatePrefix` tells you whether the locale segment of the URL is a declared locale, so `/xx/about` returns a real 404 instead of being treated as a path. Without it, an unknown prefix silently resolves and search engines index a duplicate page.
</Question>
<Question title="How do I translate a TanStack Start app automatically with AI?">
Run `npx intlayer fill`. The CLI finds missing translations and fills them with the LLM of your choice, using your own provider and API key. Add `--git-diff` to translate only the content changed on the current branch, which keeps CI runs cheap. See the [fill command](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/fill.md) and [CI/CD integration](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/CI_CD.md).
- [fill command](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/fill.md)
- [CI/CD integration](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/CI_CD.md)
</Question>
<Question title="Does Intlayer support plurals, gender and rich text?">
Yes. Content declarations support [plural forms](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/plurial.md), [gender based content](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/gender.md), conditions, [insertions](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/insertion.md) and [Markdown](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/markdown.md) for long form text, with [formatters](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/formatters.md) for numbers, dates and currencies.
- [plural forms](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/plurial.md)
- [gender based content](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/gender.md)
- [insertions](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/insertion.md)
- [Markdown](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/markdown.md)
- [formatters](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/formatters.md)
</Question>
<Question title="How can translators edit the content without touching the code?">
Through the [visual editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_visual_editor.md), which runs on your own infrastructure and lets anyone edit text in place on the running site, or the [CMS](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_CMS.md), which externalizes content so it can change without a deployment.
- [visual editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_visual_editor.md)
- [CMS](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_CMS.md)
</Question>
<Question title="What is the cost of the visual editor? Is it overkill if I don't need it?">
The [Intlayer visual editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_visual_editor.md) has **zero cost** on your application if it is not set up. The extra logic is only loaded if explicitly enabled and needed.
- [Intlayer visual editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_visual_editor.md)
If enabled, the cost is extremely light (+5 KB, dynamically loaded only when activated) because the main logic is handled by the server editor on [app.intlayer.org](https://app.intlayer.org) or via the `intlayer-editor` package. If you only need a simple translation setup without visual editing, Intlayer adds no overhead to your app.
</Question>
<Question title="Is Intlayer free and open source?">
Yes, under the Apache 2.0 license, commercial use included. The hosted CMS is an optional paid service that can also be [self hosted](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/self_hosting.md).
- [self hosted](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/self_hosting.md)
</Question>
</FAQ>
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation). | Stars: 321k | Updated | Claude CodeCodex | Verified | Install |
| brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |
| frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |
| mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK). | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |