@orderly.network/i18n

@orderly.network/i18n

Internationalization and CLI tools for Orderly SDK. Based on i18next ecosystem.

Quick start

Install the package, wrap your app root with LocaleProvider, and you get English by default.

import { LocaleProvider } from "@orderly.network/i18n";

export function App() {
  return (
    <LocaleProvider>
      <YourApp />
    </LocaleProvider>
  );
}

For multiple locales, custom keys, Vite bundling, HTTP loading, or the CLI, see the Documentation links below.

Documentation

Topic	Link
AI / Agent integration	docs/guide/AGENTS.md
Package exports	docs/guide/exports.md
Integration (providers, locales, extend keys, external resources)	docs/guide/integration.md
Utils (paths and locale helpers)	docs/guide/utils.md
Examples (recommended AsyncResources + alternatives)	docs/guide/examples.md
CLI (i18n binary)	docs/guide/cli.md

Suggested reading order: Agents start with AGENTS. Otherwise: Integration (API and behavior) → Examples (copy-paste recipes as needed) → CLI / Utils when relevant.

Generated API notes for src/ live under packages/i18n/docs/ in the monorepo only (not published in the npm package). The user guide under docs/guide/ is included in the package so links above work after npm install.

Package exports (summary)

Export	Description
@orderly.network/i18n	Main entry: providers, hooks, i18n, resource helpers, types — see exports guide
@orderly.network/i18n/locales/*	Built-in locale JSON files
@orderly.network/i18n/constant	Constants (LocaleEnum, defaultLanguages, …)
@orderly.network/i18n/utils	Utilities — see Utils

The default i18n namespace is translation (defaultNS).