useIntlayer Hook Dokumentation

Mit dem useIntlayer-Hook können Sie lokalisierte Inhalte aus einem Intlayer-Wörterbuch anhand eines Schlüssels in Remix 3-Anwendungen abrufen.

Er liest automatisch die aktive Locale aus dem aktuellen Anfragekontext (über AsyncLocalStorage), sodass Sie die Locale nicht manuell durch Routen-Handler, Ansichtsvorlagen oder Komponenten weiterreichen müssen.

Verwendung

In Routen-Handlern

import { createRouter } from "remix/router";
import { intlayer, useIntlayer } from "remix-intlayer";

const router = createRouter({
  middleware: [intlayer()],
});

router.get("/api/welcome", () => {
  const content = useIntlayer("home");

  return Response.json({
    title: content.title,
    subtitle: content.subtitle,
  });
});

In Ansichtsvorlagen / Komponenten

import { useIntlayer } from "remix-intlayer";

export const HomeView = () => {
  const content = useIntlayer("home");

  return `
    <main>
      <h1>${content.title}</h1>
      <p>${content.subtitle}</p>
    </main>
  `;
};

Parameter

useIntlayer(key, localeOrSelector?)

1. key: Der eindeutige Schlüssel des Wörterbuchs (wie in Ihren .content.ts-Deklarationsdateien definiert).
2. localeOrSelector (optional): Eine spezifische Locale oder ein Selektorobjekt ({ item }, { variant }, optional mit locale). Wenn angegeben, überschreibt dies die aus dem Anfragekontext erkannte Locale.

Beschreibung

Der Hook führt folgende Aufgaben aus:

1. Kontext-Locale-Ermittlung: Erkennt die aktuelle Locale aus dem anfragegebundenen AsyncLocalStorage-Bereich, der von der intlayer()-Middleware eingerichtet wurde.
2. Wörterbuch-Abruf: Ruft das vorkompilierte Wörterbuch ab, das dem angegebenen Schlüssel entspricht.
3. Übersetzungsverarbeitung: Löst Übersetzungen, Aufzählungen, Markdown und bedingte Inhalte für die aufgelöste Locale auf.
4. Fallback-Behandlung: Bei Aufruf außerhalb eines aktiven HTTP-Request-Kontexts greift er sauber auf die konfigurierte defaultLocale zurück.

Zugehörige Dokumentation

• intlayer Middleware
• useDictionary Hook
• useLocale Hook