aymericzip/intlayer-skills / skills/intlayer-remix
intlayer-remix
VerifiedIntegrates Intlayer internationalization with Remix 3 applications. Use when the user asks to "setup Remix i18n", register the Intlayer router middleware, or use the "useIntlayer" / "useLocale" hooks in Remix route handlers and views.
| File | Kind | Size |
|---|---|---|
| LICENCE.md | markdown | 10.7 KB |
| SKILL.md | skill md | 3.1 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_remix-3.md | markdown | 20.8 KB |
| references/formatters.md | markdown | 17.3 KB |
| references/packages_intlayer_exports.md | markdown | 12.4 KB |
| references/packages_remix-intlayer_Intlayer.md | markdown | 2.5 KB |
| references/packages_remix-intlayer_exports.md | markdown | 10.2 KB |
| references/packages_remix-intlayer_intlayerMiddleware.md | markdown | 4.0 KB |
| references/packages_remix-intlayer_useDictionary.md | markdown | 2.8 KB |
| references/packages_remix-intlayer_useIntlayer.md | markdown | 2.9 KB |
| references/packages_remix-intlayer_useLocale.md | markdown | 3.4 KB |
references/packages_remix-intlayer_useLocale.md
View on GitHub---
createdAt: 2026-09-19
updatedAt: 2026-09-19
priority: 5
title: useLocale Hook Documentation | remix-intlayer
description: See how to use the useLocale hook in Remix applications to get the current request locale, default locale, and available locales.
keywords:
- useLocale
- locale
- remix
- remix-3
- Intlayer
- intlayer
- Internationalization
- Documentation
slugs:
- doc
- packages
- remix-intlayer
- useLocale
history:
- version: 9.5.5
date: 2026-09-19
changes: "Init doc"
author: aymericzip
---
# useLocale Hook Documentation
The `useLocale` hook from `remix-intlayer` provides access to the locale of the HTTP request currently being processed, along with the project's configured default and available locales.
## Usage
In a Remix component (for example a language switcher):
```tsx fileName="src/components/LocaleSwitcher.tsx"
import { type FC } from "react";
import { Link } from "@remix-run/react";
import { useLocale } from "remix-intlayer";
import { getLocalizedUrl, getPathWithoutLocale } from "intlayer";
export const LocaleSwitcher: FC = () => {
const { locale, availableLocales } = useLocale();
const pathWithoutLocale = getPathWithoutLocale();
return (
<nav>
<ul>
{availableLocales.map((localeItem) => (
<li key={localeItem} className="p-1">
<Link
href={getLocalizedUrl(pathWithoutLocale, localeItem)}
aria-current={localeItem === locale ? "page" : undefined}
>
{localeItem.toUpperCase()}
</Link>
</li>
))}
</ul>
</nav>
);
};
```
In a route handler:
```ts fileName="src/server.ts"
import { createRouter } from "remix/router";
import { intlayer, useLocale } from "remix-intlayer";
const router = createRouter({
middleware: [intlayer()],
});
router.get("/api/locale-info", () => {
const { locale, defaultLocale, availableLocales } = useLocale();
return Response.json({
locale,
defaultLocale,
availableLocales,
});
});
```
## Return Values
The hook returns an object of type `UseLocaleResult`:
| Property | Type | Description |
| ------------------ | ------------------- | ------------------------------------------------------------------ |
| `locale` | `DeclaredLocales` | The locale resolved for the current request. |
| `defaultLocale` | `DeclaredLocales` | The default fallback locale configured in `intlayer.config.ts`. |
| `availableLocales` | `DeclaredLocales[]` | Array of all available locales configured in `intlayer.config.ts`. |
## Description
1. **Request-Scoped Resolution**: In an active request handled by the `intlayer()` middleware, `useLocale` reads the resolved locale from the request storage.
2. **Graceful Fallback**: If called outside of a request context (such as during initialization scripts or test suites), it defaults to the configured `defaultLocale`.
## Related Documentation
- [`intlayer` Middleware](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/remix-intlayer/intlayerMiddleware.md)
- [`useIntlayer` Hook](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/remix-intlayer/useIntlayer.md)
- [`useDictionary` Hook](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/remix-intlayer/useDictionary.md)
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack." | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |