Ask your question and get a summary of the document by referencing this page and the AI provider of your choice
Version History
- "Add `minify` and `purge` options to the build configuration"v8.7.04/8/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
Optimizing i18n Bundle Size & Performance
One of the most common challenges with traditional i18n solutions relying on JSON files is managing content size. If developers do not manually separate content into namespaces, users often end up downloading translations for every page and potentially every language just to view a single page.
For example, an application with 10 pages translated into 10 languages might result in a user downloading the content of 100 pages, even though they only need one (the current page in the current language). This leads to wasted bandwidth and slower load times.
Intlayer solves this problem through build-time optimization. It analyzes your code to detect which dictionaries are actually used per component and reinjects only the necessary content into your bundle.
Table of Contents
Scan your bundle
Analyzing your bundle is the first step in identifying "heavy" JSON files and code-splitting opportunities. These tools generate a visual treemap of your application's compiled code, allowing you to see exactly which libraries are consuming the most space.
Vite / Rollup
Vite uses Rollup under the hood. The rollup-plugin-visualizer generates an interactive HTML file showing the size of every module in your graph.
Copy the code to the clipboard
npm install -D rollup-plugin-visualizerCopy the code to the clipboard
import { defineConfig } from "vite";import { visualizer } from "rollup-plugin-visualizer";export default defineConfig({ plugins: [ visualizer({ open: true, // Automatically open the report in your browser filename: "stats.html", gzipSize: true, brotliSize: true, }), ],});How It Works
Intlayer uses a per-component approach. Unlike global JSON files, your content is defined alongside or within your components. During the build process, Intlayer:
- Analyzes your code to find
useIntlayercalls. - Builds the corresponding dictionary content.
- Replaces the
useIntlayercall with optimized code based on your configuration.
This ensures that:
- If a component is not imported, its content is not included in the bundle (Dead Code Elimination).
- If a component is lazy-loaded, its content is also lazy-loaded.
Setup by Platform
Next.js
Next.js requires the @intlayer/swc plugin to handle the transformation, as Next.js uses SWC for builds.
This plugin is not installed by default because SWC plugins are still experimental for Next.js. It may change in the future.
Copy the code to the clipboard
npm install -D @intlayer/swcOnce Installed. Intlayer will automatically detect and use the plugin.
Configuration
You can control how Intlayer optimizes your bundle via the build property in your intlayer.config.ts.
Copy the code to the clipboard
import { Locales, type IntlayerConfig } from "intlayer";const config: IntlayerConfig = { internationalization: { locales: [Locales.ENGLISH, Locales.FRENCH], defaultLocale: Locales.ENGLISH, }, dictionary: { importMode: "dynamic", }, build: { /** * Minify the dictionaries to reduce the bundle size. */ minify: true; /** * Purge the unused keys in a dictionaries */ purge: true; /** * Indicates if the build should check TypeScript types */ checkTypes: false; },};export default config;Keeping the default option for optimize is recommended in the most majority of cases.
See doc configuration for more details: Configuration
Build Options
The following options are available under the build configuration object:
Open the table in a modal to view all data content clearly
| Property | Type | Default | Description |
|---|---|---|---|
optimize | boolean | undefined | Controls whether build optimization is enabled. If true, Intlayer replaces dictionary calls with optimized injects. If false, optimization is disabled. Ideally set to true in production. |
minify | boolean | false | Whether to minify the dictionaries to reduce the bundle size. |
purge | boolean | false | Whether to purge the unused keys in dictionaries. |
Minification
Minifying dictionaries removes unnecessary whitespace, comments, and reduces the size of the JSON content. This is especially useful for large dictionaries.
Copy the code to the clipboard
import type { IntlayerConfig } from "intlayer";const config: IntlayerConfig = { build: { minify: true, },};export default config;Note: Minification is ignored if optimize is disabled or if the Visual Editor is enabled (as the editor needs the full content to allow editing).
Purging
Purging ensures that only the keys actually used in your code are included in the final dictionary bundle. This can significantly reduce the size of your bundle if you have large dictionaries with many keys that are not used in every part of your application.
Copy the code to the clipboard
import type { IntlayerConfig } from "intlayer";const config: IntlayerConfig = { build: { purge: true, },};export default config;Note: Purging is ignored if optimize is disabled.
Import Mode
For large applications, including several pages and locales, your JSON can represent a significant part of your bundle size. Intlayer allows you to control how dictionaries are loaded using the importMode option.
Global definition
The import mode can be defined by default globally in your intlayer.config.ts file.
Copy the code to the clipboard
import type { IntlayerConfig } from "intlayer";const config: IntlayerConfig = { dictionary: { importMode: "dynamic", // Default is 'static' },};export default config;Per dictionary fine-grained definition
As well as for each dictionaries in your .content.{{ts|tsx|js|jsx|mjs|cjs|json|jsonc|json5}} files.
Copy the code to the clipboard
import { type Dictionary, t } from "intlayer";const appContent: Dictionary = { key: "app", importMode: "dynamic", // Override the default import mode content: { // ... },};export default appContent;Open the table in a modal to view all data content clearly
| Property | Type | Default | Description |
|---|---|---|---|
importMode | 'static', 'dynamic', 'fetch' | 'static' | Deprecated: Use dictionary.importMode instead. Determines how dictionaries are loaded (see details below). |
The importMode setting dictates how the dictionary content is injected into your component.
You can define it globally in the intlayer.config.ts file under the dictionary object, or you can overwrite it for a specific dictionary in its .content.ts file.
1. Static Mode (default)
In static mode, Intlayer replaces useIntlayer with useDictionary and injects the dictionary directly into the JavaScript bundle.
- Pros: Instant rendering (synchronous), zero extra network requests during hydration.
- Cons: The bundle includes translations for all available languages for that specific component.
- Best for: Single Page Applications (SPA).
Transformed Code Example:
Copy the code to the clipboard
// Your codeconst content = useIntlayer("my-key");// Optimized code illustration after transformation (Static)// This is only for illustration purposes, the actual code will be different for optimization reasonsconst content = useDictionary({ key: "my-key", content: { nodeType: "translation", translation: { en: "My title", fr: "Mon titre", }, },});2. Dynamic Mode
In dynamic mode, Intlayer replaces useIntlayer with useDictionaryAsync. This uses import() (Suspense-like mechanism) to lazy-load specifically the JSON for the current locale.
- Pros: Locale-level tree shaking. A user viewing the English version will only download the English dictionary. The French dictionary is never loaded.
- Cons: Triggers a network request (asset fetch) per component during hydration.
- Best for: Large text blocks, articles, or applications supporting many languages where bundle size is critical.
Transformed Code Example:
Copy the code to the clipboard
// Your codeconst content = useIntlayer("my-key");// Optimized code illustration after transformation (Dynamic)// This is only for illustration purposes, the actual code will be different for optimization reasonsconst content = useDictionaryAsync({ en: () => import(".intlayer/dynamic_dictionary/my-key/en.json").then( (mod) => mod.default ), fr: () => import(".intlayer/dynamic_dictionary/my-key/fr.json").then( (mod) => mod.default ),});When usingimportMode: 'dynamic', if you have 100 components usinguseIntlayeron a single page, the browser will attempt 100 separate fetches. To avoid this "waterfall" of requests, group content into fewer.contentfiles (e.g., one dictionary per page section) rather than one per atom component. You can also use multiple.contentfiles using the same key. Intlayer will merge them into a single dictionary.
3. Fetch Mode
Behaves similarly to Dynamic mode but attempts to fetch dictionaries from the Intlayer Live Sync API first. If the API call fails or the content is not marked for live updates, it falls back to the dynamic import.
Transformed Code Example:
Copy the code to the clipboard
// Your codeconst content = useIntlayer("my-key");// Optimized code illustration (Fetch)const content = useDictionaryAsync({ en: () => fetch("https://intlayer.my-domain.com/dictionary/my-key/en").then((res) => res.json() ), fr: () => fetch("https://intlayer.my-domain.com/dictionary/my-key/fr").then((res) => res.json() ),});See CMS documentation for more details: CMS
In fetch mode, purge and minification can't be used.
Summary: Static vs Dynamic
Open the table in a modal to view all data content clearly
| Feature | Static Mode | Dynamic Mode |
|---|---|---|
| JS Bundle Size | Larger (includes all langs for the component) | Smallest (only code, no content) |
| Initial Load | Instant (Content is in bundle) | Slight delay (Fetches JSON) |
| Network Requests | 0 extra requests | 1 request per dictionary key |
| Tree Shaking | Component-level | Component-level + Locale-level |
| Best Use Case | UI Components, Small Apps | Pages with much text, Many Languages |