`useLocaleAdapter`

(no submodules)

Purpose

useLocaleAdapter<TLocale>(id) resolves a registered LocaleAdapterPlugin<TLocale> against the active locale and returns its library-specific output. The canonical use case is react-day-picker's <Calendar>, which wants a date-fns Locale object — the component calls useLocaleAdapter<Locale>("date-fns") and the consumer registers an adapter that maps the active BCP-47 locale to the corresponding date-fns reference. The package stays library-agnostic; the consumer wires the date / time library they already use.

Features

Strict resolution — throws REACT_I18N.LOCALE_ADAPTER_NOT_REGISTERED for an unknown id.
Memoized on (registry, id, locale) so a no-op re-render does not re-invoke plugin.resolve.
Built-in "intl" identity adapter is auto-registered by <RegistryProvider> so any consumer that just needs the locale string back gets it without registering a plugin.

Usage: Basic Example

import { useLocaleAdapter } from "@suaveplan/react-i18n";

function HtmlLang(): JSX.Element {
    const lang = useLocaleAdapter<string>("intl");
    return <meta name="content-language" content={lang} />;
}

Usage: Advanced Example

A <Calendar> component asks for the date-fns adapter:

import { useLocaleAdapter } from "@suaveplan/react-i18n";
import { DayPicker } from "react-day-picker";
import type { Locale as DateFnsLocale } from "date-fns";

function Calendar(props: CalendarProps): JSX.Element {
    const dateFnsLocale = useLocaleAdapter<DateFnsLocale>("date-fns");
    return <DayPicker {...props} locale={dateFnsLocale} />;
}

The consumer wires the adapter once in <RegistryProvider>:

import { createDateFnsLocaleAdapter, RegistryProvider } from "@suaveplan/react-i18n";
import { enGB, frFR, zhCN } from "date-fns/locale";

const dateFnsAdapter = createDateFnsLocaleAdapter({
    locales: { enGB, frFR, zhCN },
});

<RegistryProvider plugins={[{ kind: "locale-adapter", plugin: dateFnsAdapter }]}>
    {/* … Calendar resolves "date-fns" to the active locale's Locale object */}
</RegistryProvider>;

Without registering the adapter, <Calendar> throws REACT_I18N.LOCALE_ADAPTER_NOT_REGISTERED on first render. This is intentional — silent fallback to a hardcoded English locale would be surprising in an RTL locale.

API Reference