Intlayer Usage

To use Intlayer effectively:

1. Retrieve Locales: Check intlayer.config.{ts,js,json,json5,jsonc,cjs,mjs}, .intlayerrc to see the configured locales.

2. Declare Content: We recommend creating one content declaration file per component or per section of your application, located alongside the component file. This keeps translations close to the code.

3. Consume Content: Use the provided hooks and functions to access your content.

   • Intlayer Exports
   • React Intlayer Exports

   Common Packages:

   • intlayer: Core package for content declaration and utility functions.
   • react-intlayer: React components and hooks (e.g., useIntlayer).
   • vite-intlayer: Vite plugin for integration.

4. CLI Commands: Useful commands for managing your content:

   • npx intlayer build: Build the dictionaries from your content declarations.

References

• Get Started
• How Intlayer Works
• Why Intlayer
• Per-locale File
• Website
• Doc

Packages

• intlayer comparePaths
• intlayer getCanonicalPath
• intlayer getConfiguration
• intlayer getDictionary
• intlayer getDictionaryAsync
• intlayer getEnumeration
• intlayer getHTMLTextDir
• intlayer getIntlayer
• intlayer getIntlayerAsync
• intlayer getLocale
• intlayer getLocaleLang
• intlayer getLocaleName
• intlayer getLocalizedPath
• intlayer getLocalizedUrl
• intlayer getMultilingualUrls
• intlayer getPathWithoutLocale
• intlayer getPrefix
• intlayer getTranslation
• intlayer validatePrefix
• vite-intlayer Exports
• vite-intlayer intlayer
• vite-intlayer intlayerCompiler
• vite-intlayer intlayerMinify
• vite-intlayer intlayerProxy
• vite-intlayer intlayerPrune