Ask your question and get a summary of the document by referencing this page and the AI provider of your choice
Version History
- "Update Solid useIntlayer API usage to direct property access"v8.9.05/4/2026
- "Add pre-render & sitemap"v8.6.03/29/2026
- "Added for Tanstack Start Solid.js"v8.5.13/25/2026
If you have an idea for improving this documentation, please feel free to contribute by submitting a pull request on GitHub.
GitHub link to the documentationCopy doc Markdown to clipboard
Translate your Tanstack Start with Solid.js website using Intlayer | Internationalization (i18n)
Table of Contents
This guide demonstrates how to integrate Intlayer for seamless internationalization in Tanstack Start projects with Solid.js, locale-aware routing, TypeScript support, and modern development practices.
What is Intlayer?
Intlayer is an innovative, open-source internationalization (i18n) library designed to simplify multilingual support in modern web applications.
With Intlayer, you can:
- Easily manage translations using declarative dictionaries at the component level.
- Dynamically localize metadata, routes, and content.
- Ensure TypeScript support with autogenerated types, improving autocompletion and error detection.
- Benefit from advanced features, like dynamic locale detection and switching.
- Enable locale-aware routing with Tanstack Start's file-based routing system.
Step-by-Step Guide to Set Up Intlayer in a Tanstack Start Application
See Application Template on GitHub.
Step 1: Create Project
Start by creating a new TanStack Start project by following the Start new project guide on the TanStack Start website.
Step 2: Install Intlayer Packages
Install the necessary packages using your preferred package manager:
Copy the code to the clipboard
npm install intlayer solid-intlayernpm install vite-intlayer --save-devnpx intlayer initintlayer
The core package that provides internationalization tools for configuration management, translation, content declaration, transpilation, and CLI commands.
solid-intlayer The package that integrates Intlayer with Solid application. It provides context providers and hooks for Solid internationalization.
vite-intlayer Includes the Vite plugin for integrating Intlayer with the Vite bundler, as well as middleware for detecting the user's preferred locale, managing cookies, and handling URL redirection.
Step 3: Configuration of your project
Create a config file to configure the languages of your application:
Copy the code to the clipboard
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.
Step 4: Integrate Intlayer in Your Vite Configuration
Add the intlayer plugin into your configuration:
Copy the code to the clipboard
import { intlayer } from "vite-intlayer";import { defineConfig } from "vite";import { devtools } from "@tanstack/devtools-vite";import { tanstackStart } from "@tanstack/solid-start/plugin/vite";import solidPlugin from "vite-plugin-solid";export default defineConfig({ plugins: [ devtools(), tanstackStart({ router: { routeFileIgnorePattern: ".content.(ts|tsx|js|mjs|cjs|jsx|json|jsonc|json5)$", }, }), solidPlugin({ ssr: true }), intlayer(), ],});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 5: 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.
Copy the code to the clipboard
import { HeadContent, Scripts, createRootRouteWithContext,} from "@tanstack/solid-router";import { HydrationScript } from "solid-js/web";import { Suspense, type ParentComponent } from "solid-js";import { IntlayerProvider } from "solid-intlayer";import { defaultLocale, getHTMLTextDir } from "intlayer";import { Route as LocaleRoute } from "./{-$locale}/route";export const Route = createRootRouteWithContext()({ shellComponent: RootComponent,});const RootComponent: ParentComponent = (props) => { const params = LocaleRoute.useParams(); const locale = params()?.locale ?? defaultLocale; return ( <html dir={getHTMLTextDir(locale)} lang={locale}> <head> <HydrationScript /> <HeadContent /> </head> <body> <IntlayerProvider locale={locale}> <Suspense>{props.children}</Suspense> </IntlayerProvider> <Scripts /> </body> </html> );};Step 6: Create Locale Layout (Optional)
Create a layout that handles the locale prefix and performs validation. This layout will ensure that only valid locales are processed.
This step is optional if you don't need to validate the locale prefix at the route level.
Copy the code to the clipboard
import { createFileRoute, Outlet, redirect } from "@tanstack/solid-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 }, replace: true, }); } }, 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$localeinstead. For the'no-prefix'or'search-params'mode, you can remove the slot entirely.
Step 7: Declare Your Content
Create and manage your content declarations to store translations:
Copy the code to the clipboard
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 thecontentDirdirectory (by default,./app). And match the content declaration file extension (by default,.content.{json,ts,tsx,js,jsx,mjs,cjs}).
For more details, refer to the content declaration documentation.
Step 7: Create Locale-Aware Components and Hooks
Create a LocalizedLink component for locale-aware navigation:
Copy the code to the clipboard
import { Link, type LinkProps } from "@tanstack/solid-router";import { getPrefix } from "intlayer";import { useLocale } from "solid-intlayer";import type { JSX } from "solid-js";export const LOCALE_ROUTE = "{-$locale}" as const;export type RemoveLocaleParam<TVal> = TVal extends string ? RemoveLocaleFromString<TVal> : TVal;export type To = RemoveLocaleParam<LinkProps["to"]>;type CollapseDoubleSlashes<TString extends string> = TString extends `${infer THead}//${infer TTail}` ? CollapseDoubleSlashes<`${THead}/${TTail}`> : TString;export type LocalizedLinkProps = Omit<LinkProps, "to"> & { to?: To;} & JSX.AnchorHTMLAttributes<HTMLAnchorElement>;type RemoveAll< TString extends string, TSub extends string,> = TString extends `${infer THead}${TSub}${infer TTail}` ? RemoveAll<`${THead}${TTail}`, TSub> : TString;type RemoveLocaleFromString<TString extends string> = CollapseDoubleSlashes< RemoveAll<TString, typeof LOCALE_ROUTE>>;export const LocalizedLink = (props: LocalizedLinkProps) => { const { locale } = useLocale(); return ( <Link {...props} params={{ locale: getPrefix(locale()).localePrefix, ...(typeof props.params === "object" ? props.params : {}), }} to={`/${LOCALE_ROUTE}${props.to ?? ""}` as LinkProps["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:
Copy the code to the clipboard
import { useNavigate } from "@tanstack/solid-router";import { getLocalizedUrl } from "intlayer";import { useLocale } from "solid-intlayer";export const useLocalizedNavigate = () => { const navigate = useNavigate(); const { locale } = useLocale(); const localizedNavigate = (to: string) => { const localizedTo = getLocalizedUrl(to, locale()); return navigate({ to: localizedTo }); }; return localizedNavigate;};Step 8: Utilize Intlayer in Your Pages
Access your content dictionaries throughout your application:
Localized Home Page
Copy the code to the clipboard
import { createFileRoute } from "@tanstack/solid-router";import { useIntlayer } from "solid-intlayer";import { LocalizedLink } from "@/components/LocalizedLink";export const Route = createFileRoute("/{-$locale}/")({ component: RouteComponent,});function RouteComponent() { const content = useIntlayer("index-page"); return ( <main> <h1>{content.heroTitle}</h1> <p>{content.heroDesc}</p> <div> <LocalizedLink to="/">{content.navHome}</LocalizedLink> <LocalizedLink to="/about">{content.navAbout}</LocalizedLink> </div> </main> );}In Solid,
useIntlayerreturns reactive content (e.g.,content). You can access its properties directly.If you want to use your content in a
stringattribute, such asalt,title,href,aria-label, etc., you can use the value of the function, like:htmlCopy codeCopy the code to the clipboard
<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.
Step 9: Create a Locale Switcher Component
Create a component to allow users to change languages:
Copy the code to the clipboard
import { useLocation } from "@tanstack/solid-router";import { getLocaleName, getPathWithoutLocale, getPrefix } from "intlayer";import { For } from "solid-js";import { useIntlayer, useLocale } from "solid-intlayer";import { LocalizedLink, type To } from "./LocalizedLink";export const LocaleSwitcher = () => { const content = useIntlayer("locale-switcher"); const location = useLocation(); const { availableLocales, locale, setLocale } = useLocale(); const pathWithoutLocale = () => getPathWithoutLocale(location().pathname); return ( <div class="flex flex-row gap-2"> <For each={availableLocales}> {(localeEl) => ( <LocalizedLink aria-current={localeEl === locale() ? "page" : undefined} onClick={() => setLocale(localeEl)} params={{ locale: getPrefix(localeEl).localePrefix }} to={pathWithoutLocale() as To} > {getLocaleName(localeEl)} </LocalizedLink> )} </For> </div> );};export default LocaleSwitcher;In Solid,
localefromuseLocaleis a signal accessor. Uselocale()(with parentheses) to read its current value reactively.To Learn more about the
useLocalehook, refer to the documentation.
Step 10: 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.
Copy the code to the clipboard
const RootComponent: ParentComponent = (props) => { const params = LocaleRoute.useParams(); const locale = params()?.locale ?? defaultLocale; return ( <html dir={getHTMLTextDir(locale)} lang={locale}> {/* ... */} </html> );};Step 11: Add middleware (Optional)
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 theintlayerProxyin production, you need to switch thevite-intlayerpackage fromdevDependenciestodependencies.
Copy the code to the clipboard
import { tanstackStart } from "@tanstack/solid-start/plugin/vite";import solid from "vite-plugin-solid";import { nitro } from "nitro/vite";import { defineConfig } from "vite";import { intlayer, intlayerProxy } from "vite-intlayer";export default defineConfig({ plugins: [ intlayerProxy(), // The proxy should be placed before server if you use Nitro nitro(), intlayer(), tanstackStart({ router: { routeFileIgnorePattern: ".content.(ts|tsx|js|mjs|cjs|jsx|json|jsonc|json5)$", }, }), solid(), ],});Step 12: Internationalize your Metadata (Optional)
You can also use the getIntlayer function to access your content dictionaries inside the head loader for locale-aware metadata:
Copy the code to the clipboard
import { createFileRoute } from "@tanstack/solid-router";import { getIntlayer } from "intlayer";export const Route = createFileRoute("/{-$locale}/")({ component: RouteComponent, head: ({ params }) => { const { locale } = 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 }, ], }; },});Step 13: Retrieve the locale in your server actions (Optional)
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:
Copy the code to the clipboard
import { createServerFn } from "@tanstack/solid-start";import { getRequestHeader, getRequestHeaders,} from "@tanstack/solid-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 getIntlayer() const content = getIntlayer("app", locale); return { locale, content };});Step 14: Manage not found pages (Optional)
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:
- Dedicated 404 route: A specific route to display the 404 UI
- Route-level validation: Validates locale prefixes and redirects invalid ones to 404
- Catch-all route: Captures any unmatched paths within the locale segment
Copy the code to the clipboard
import { createFileRoute } from "@tanstack/solid-router";// This creates a dedicated /[locale]/404 route// It's used both as a direct route and imported as a component in other filesexport const Route = createFileRoute("/{-$locale}/404")({ component: NotFoundComponent,});// Exported separately so it can be reused in notFoundComponent and catch-all routesexport function NotFoundComponent() { return ( <div> <h1>404</h1> </div> );}Copy the code to the clipboard
import { createFileRoute, Outlet, redirect } from "@tanstack/solid-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,});Copy the code to the clipboard
import { createFileRoute } from "@tanstack/solid-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 errorexport const Route = createFileRoute("/{-$locale}/$")({ component: NotFoundComponent,});(Optional) Step 15: Extract the content of your components
If you have an existing codebase, transforming thousands of files can be time-consuming.
To ease this process, Intlayer propose a compiler / extractor to transform your components and extract the content.
To set it up, you can add a compiler section in your intlayer.config.ts file:
Copy the code to the clipboard
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;Run the extractor to transform your components and extract the content
Copy the code to the clipboard
npx intlayer extractStep 16: Pre-render & Generate Sitemap (Optional)
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 thexhtml:linknamespace (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.
Copy the code to the clipboard
import { localeMap, localeFlatMap } from "intlayer";// ... other importsexport 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:
Copy the code to the clipboard
import { createFileRoute } from "@tanstack/solid-router";import { generateSitemap } from "intlayer";const SITE_URL = "http://localhost:3000";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: SITE_URL } ); return new Response(sitemap, { headers: { "Content-Type": "application/xml" }, }); }, }, },});Step 17: Configure TypeScript (Optional)
Intlayer uses module augmentation to get benefits of TypeScript and make your codebase stronger.
Ensure your TypeScript configuration includes the autogenerated types:
Copy the code to the clipboard
{ // ... your existing configurations include: [ // ... your existing includes ".intlayer/**/*.ts", // Include the auto-generated types ],}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:
Copy the code to the clipboard
# Ignore the files generated by Intlayer.intlayerVS Code Extension
To improve your development experience with Intlayer, you can install the official Intlayer VS Code Extension.
Install from the VS Code Marketplace
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.
Go Further
To go further, you can implement the visual editor or externalize your content using the CMS.