aymericzip/intlayer-skills / skills/intlayer-vue
intlayer-vue
VerifiedIntegrates Intlayer internationalization with Vue.js and Nuxt applications. Use when the user asks to "setup Vue i18n", use the "useIntlayer" composable, or manage translations in Vue components.
| File | Kind | Size |
|---|---|---|
| LICENCE.md | markdown | 10.7 KB |
| SKILL.md | skill md | 2.3 KB |
| references/compiler.md | markdown | 14.6 KB |
| references/concept_collections.md | markdown | 5.6 KB |
| references/concept_variants.md | markdown | 20.9 KB |
| references/environment_astro_vue.md | markdown | 37.7 KB |
| references/environment_nuxt-and-vue.md | markdown | 34.8 KB |
| references/environment_vite-and-vue.md | markdown | 50.2 KB |
| references/formatters.md | markdown | 17.3 KB |
| references/packages_intlayer_exports.md | markdown | 12.4 KB |
| references/packages_nuxt-intlayer_exports.md | markdown | 1.2 KB |
| references/packages_vue-intlayer_exports.md | markdown | 4.9 KB |
| references/packages_vue-intlayer_usePathname.md | markdown | 3.2 KB |
| references/packages_vue-intlayer_useRewriteURL.md | markdown | 1.9 KB |
references/packages_intlayer_exports.md
View on GitHub---
createdAt: 2026-01-21
updatedAt: 2026-08-23
priority: 5
title: intlayer Package Documentation
description: The core package of Intlayer, providing the base functions and types for internationalization.
keywords:
- intlayer
- core
- internationalization
- i18n
slugs:
- doc
- packages
- intlayer
- exports
history:
- version: 9.4.0
date: 2026-08-23
changes: "Document getIntlayer, getIntlayerAsync, getDictionary and getDictionaryAsync"
- version: 9.0.0
date: 2026-06-23
changes: "Add comparePaths utility"
- version: 8.0.0
date: 2026-01-21
changes: "Unified documentation for all exports"
author: aymericzip
---
# intlayer Package
The `intlayer` package is the core library of the Intlayer ecosystem. It provides the essential functions, types, and utilities for managing multilingual content in JavaScript and TypeScript applications.
## Installation
```bash packageManager="npm"
npm install intlayer
```
```bash packageManager="yarn"
yarn add intlayer
```
```bash packageManager="pnpm"
pnpm add intlayer
```
```bash packageManager="bun"
bun add intlayer
```
## Exports
### Configuration
Import:
```tsx
import "intlayer";
```
| Variable | Type | Description | Related Doc |
| ------------------ | ---------------------- | ---------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `configuration` | `IntlayerConfig` | The Intlayer configuration object. | [getConfiguration](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getConfiguration.md) |
| `getConfiguration` | `() => IntlayerConfig` | Returns the Intlayer configuration object. (**Deprecated**: Use `configuration` instead) | [getConfiguration](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getConfiguration.md) |
| `locales` | `Locales[]` | The list of all supported locales. | - |
| `requiredLocales` | `Locales[]` | The list of all required locales. | - |
| `defaultLocale` | `Locales` | The default locale. | - |
### Types
Import:
```tsx
import "intlayer";
```
| Type | Description |
| --------------------- | ----------------------------------------------------------------- |
| `Dictionary` | The dictionary type used to define the structure of a dictionary. |
| `DeclarationContent` | (**Deprecated**) Use `Dictionary<T>` instead. |
| `IntlayerConfig` | The type defining the Intlayer configuration. |
| `ContentNode` | A node in the dictionary content. |
| `Locale` | The type representing a locale. |
| `LocalesValues` | The possible values for a locale. |
| `StrictModeLocaleMap` | A map of locales with strict type checking. |
### Content Functions
Import:
```tsx
import "intlayer";
```
| Function | Type | Description | Related Doc |
| ------------------------ | ---------- | ----------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `t` / `getTranslation` | `Function` | Picks content based on the current locale. | [translation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/translation.md) |
| `enu` / `getEnumeration` | `Function` | Picks content based on a quantity. | [enumeration](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/enumeration.md) |
| `cond` / `getCondition` | `Function` | Picks content based on a boolean condition. | [condition](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/condition.md) |
| `gender` | `Function` | Picks content based on a gender. | [gender](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/gender.md) |
| `insert` | `Function` | Inserts values into a content string. | [insertion](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/insertion.md) |
| `nest` / `getNesting` | `Function` | Nests another dictionary. | [nesting](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/nesting.md) |
| `md` | `Function` | Processes markdown content. | [markdown](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/markdown.md) |
| `html` | `Function` | Processes HTML content. | [html](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/html.md) |
| `file` | `Function` | Handles file content. | [file](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/file.md) |
| `getDictionary` | `Function` | Processes objects that look like dictionaries (key, content). It processes `t()` translations, enumerations, etc. | [getDictionary](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getDictionary.md) |
| `getDictionaryAsync` | `Function` | Loads a single locale chunk of a dictionary from a per-locale loader map, then processes it. | [getDictionaryAsync](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getDictionaryAsync.md) |
| `getIntlayer` | `Function` | Based on `getDictionary`, but injects an optimized version of the dictionary from the generated declaration. | [getIntlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getIntlayer.md) |
| `getIntlayerAsync` | `Function` | Async counterpart of `getIntlayer`, loading only the requested locale. For metadata, loaders, server functions. | [getIntlayerAsync](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getIntlayerAsync.md) |
### Localization Utilities
Import:
```tsx
import "intlayer";
```
| Function | Type | Description | Related Doc |
| ---------------------- | ---------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `getLocale` | `Function` | Detects the locale from a string or path. | [getLocale](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getLocale.md) |
| `getLocaleLang` | `Function` | Gets the language part of a locale. | [getLocaleLang](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getLocaleLang.md) |
| `getLocaleName` | `Function` | Gets the display name of a locale. | [getLocaleName](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getLocaleName.md) |
| `getLocalizedPath` | `Function` | Resolves a canonical path to localized. | [getLocalizedPath](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getLocalizedPath.md) |
| `getCanonicalPath` | `Function` | Resolves a localized path to canonical. | [getCanonicalPath](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getCanonicalPath.md) |
| `getLocalizedUrl` | `Function` | Generates a localized URL. | [getLocalizedUrl](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getLocalizedUrl.md) |
| `getMultilingualUrls` | `Function` | Generates URLs for all supported locales. | [getMultilingualUrls](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getMultilingualUrls.md) |
| `getPathWithoutLocale` | `Function` | Removes the locale prefix from a path. | [getPathWithoutLocale](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getPathWithoutLocale.md) |
| `getPrefix` | `Function` | Gets the locale prefix from a path. | [getPrefix](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getPrefix.md) |
| `comparePaths` | `Function` | Compares two paths ignoring the locale. | [comparePaths](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/comparePaths.md) |
| `normalizePath` | `Function` | Normalizes a path to a locale-agnostic one. | [comparePaths](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/comparePaths.md) |
| `getHTMLTextDir` | `Function` | Gets the text direction (LTR/RTL). | [getHTMLTextDir](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getHTMLTextDir.md) |
| `validatePrefix` | `Function` | Validates a locale prefix. | [validatePrefix](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/validatePrefix.md) |
### Browser Utilities
Import:
```tsx
import "intlayer";
```
| Function | Type | Description |
| ---------------------- | ---------- | --------------------------------------- |
| `getBrowserLocale` | `Function` | Detects the browser's preferred locale. |
| `getCookie` | `Function` | Retrieves a cookie value. |
| `getLocaleFromStorage` | `Function` | Retrieves the locale from storage. |
| `setLocaleInStorage` | `Function` | Saves the locale to storage. |
### Formatters
Import:
```tsx
import "intlayer";
```
| Function | Description |
| -------------- | --------------------------------- |
| `number` | Formats a number. |
| `currency` | Formats a currency value. |
| `percentage` | Formats a percentage. |
| `compact` | Formats a number in compact form. |
| `date` | Formats a date. |
| `relativeTime` | Formats relative time. |
| `units` | Formats a value with units. |
| `Intl` | The standard Intl object. |
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: 322k | 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: 198k | 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: 198k | 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: 198k | Updated | Claude CodeCodex | Verified | Install |