Translate your Vite and Svelte website using Intlayer | Internationalisation (i18n)

Table of Contents

What is Intlayer?

Intlayer is an innovative, open-source internationalisation (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 localise 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.

Step-by-Step Guide to Set Up Intlayer in a Vite and Svelte Application

See Application Template on GitHub.

Step 1: Install Dependencies

Install the necessary packages using npm:

npm install intlayer svelte-intlayernpm install vite-intlayer --save-dev

• intlayer

  The core package that provides internationalisation tools for configuration management, translation, content declaration, transpilation, and CLI commands.

• svelte-intlayer The package that integrates Intlayer with Svelte applications. It provides context providers and hooks for Svelte internationalisation.

• 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 2: Configuration of your project

Create a config file to configure the languages of your application:

import { Locales, type IntlayerConfig } from "intlayer";const config: IntlayerConfig = {  internationalization: {    locales: [      Locales.ENGLISH,      Locales.FRENCH,      Locales.SPANISH,      // Your other locales    ],    defaultLocale: Locales.ENGLISH,  },};export default config;

Through this configuration file, you can set up localised 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 3: Integrate Intlayer in Your Vite Configuration

Add the intlayer plugin into your configuration.

import { defineConfig } from "vite";import { svelte } from "@sveltejs/vite-plugin-svelte";import { intlayer } from "vite-intlayer";// https://vitejs.dev/config/export default defineConfig({  plugins: [svelte(), 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 optimise performance.

Step 4: Declare Your Content

Create and manage your content declarations to store translations:

import { t, type Dictionary } from "intlayer";const appContent = {  key: "app",  content: {    title: t({      en: "Hello World",      fr: "Bonjour le monde",      es: "Hola mundo",    }),  },} satisfies Dictionary;export default appContent;

Your content declarations can be defined anywhere in your application as soon as they are included in the contentDir directory (by default, ./src). And match the content declaration file extension (by default, .content.{json,ts,tsx,js,jsx,mjs,mjx,cjs,cjx}).

For more details, refer to the content declaration documentation.

Step 5: Utilise Intlayer in Your Code

<script>  import { useIntlayer } from "svelte-intlayer";  const content = useIntlayer("app");</script><div><!-- Render content as simple content  --><h1>{$content.title}</h1><!-- To render the content editable using the editor --><h1><svelte:component this={$content.title} /></h1><!-- To render the content as a string --><div aria-label={$content.title.value}></div>

(Optional) Step 6: Change the language of your content

<script lang="ts">import  { getLocaleName } from 'intlayer';import { useLocale } from 'svelte-intlayer';// Get locale information and setLocale functionconst { locale, availableLocales, setLocale } = useLocale();// Handle locale changeconst changeLocale = (event: Event) => {  const target = event.target as HTMLSelectElement;  const newLocale = target.value;  setLocale(newLocale);};</script><div>  <select value={$locale} on:change={changeLocale}>    {#each availableLocales ?? [] as loc}      <option value={loc}>        {getLocaleName(loc)}      </option>    {/each}  </select></div>

(Optional) Step 7: Render Markdown

Intlayer supports rendering Markdown content directly in your Svelte application. By default, Markdown is treated as plain text. To convert Markdown into rich HTML, you can integrate @humanspeak/svelte-markdown, or another markdown parser.

To see how to declare markdown content using the intlayer package, see the markdown doc.

<script>  import { setIntlayerMarkdown } from "svelte-intlayer";  setIntlayerMarkdown((markdown) =>   // render the markdown content as a string   return markdown;  );</script><h1>{$content.markdownContent}</h1>

You can also access your markdown front-matter data using the content.markdownContent.metadata.xxx property.

(Optional) Step 8: Set up the intlayer editor / CMS

To set up the intlayer editor, you must follow the intlayer editor documentation.

To set up the intlayer CMS, you must follow the intlayer CMS documentation.

In parallel, in your Svelte application, you must add the following line in a layout, or at the root of your application:

import { useIntlayerEditor } from "svelte-intlayer";useIntlayerEditor();

(Optional) Step 7: Add localised Routing to your application

To handle localised routing in your Svelte application, you can use svelte-spa-router along with Intlayer's localeFlatMap to generate routes for each locale.

First, install svelte-spa-router:

npm install svelte-spa-router

Then, create a Router.svelte file to define your routes:

<script lang="ts">import { localeFlatMap } from "intlayer";import Router from "svelte-spa-router";import { wrap } from "svelte-spa-router/wrap";import App from "./App.svelte";const routes = Object.fromEntries(    localeFlatMap(({locale, urlPrefix}) => [    [        urlPrefix || '/',        wrap({            component: App as any,            props: {                locale,            },        }),    ],    ]));</script><Router {routes} />

Update your main.ts to mount the Router component instead of App:

import { mount } from "svelte";import Router from "./Router.svelte";const app = mount(Router, {  target: document.getElementById("app")!,});export default app;

Finally, update your App.svelte to receive the locale prop and use it with useIntlayer:

<script lang="ts">import type { Locale } from 'intlayer';import { useIntlayer } from 'svelte-intlayer';import Counter from './lib/Counter.svelte';import LocaleSwitcher from './lib/LocaleSwitcher.svelte';export let locale: Locale;$: content = useIntlayer('app', locale);</script><main>  <div class="locale-switcher-container">    <LocaleSwitcher currentLocale={locale} />  </div>  <!-- ... rest of your app ... --></main>

Configure Server-Side Routing (Optional)

In parallel, 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.

import { defineConfig } from "vite";import { svelte } from "@sveltejs/vite-plugin-svelte";import { intlayer, intlayerProxy } from "vite-intlayer";// https://vitejs.dev/config/export default defineConfig({  plugins: [svelte(), intlayer(), intlayerProxy()],});

(Optional) Step 8: Change the URL when the locale changes

To allow users to switch languages and update the URL accordingly, you can create a LocaleSwitcher component. This component will use getLocalizedUrl from intlayer and push from svelte-spa-router.

<script lang="ts">import { getLocaleName, getLocalizedUrl } from "intlayer";import { useLocale } from "svelte-intlayer";import { push } from "svelte-spa-router";export let currentLocale: string | undefined = undefined;// Get locale informationconst { locale, availableLocales } = useLocale();// Handle locale changeconst changeLocale = (event: Event) => {  const target = event.target as HTMLSelectElement;  const newLocale = target.value;  const currentUrl = window.location.pathname;  const url = getLocalizedUrl(currentUrl, newLocale);  push(url);};</script><div class="locale-switcher">  <select value={currentLocale ?? $locale} onchange={changeLocale}>    {#each availableLocales ?? [] as loc}      <option value={loc}>        {getLocaleName(loc)}      </option>    {/each}  </select></div>

Git Configuration

It is recommended to ignore the files generated by Intlayer. This prevents you from committing them to your Git repository.

To do this, you can add the following instructions to your .gitignore file:

# 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

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 externalise your content using the CMS.