Der Inhalt dieser Seite wurde mit einer KI übersetzt.

Dokumentation: getHTMLTextDir Funktion in intlayer

Beschreibung

Die Funktion getHTMLTextDir bestimmt die Schreibrichtung (ltr, rtl oder auto) basierend auf der angegebenen Locale. Sie ist dafür gedacht, Entwicklern zu helfen, das dir-Attribut im HTML für eine korrekte Textdarstellung zu setzen.

Parameter

locale?: Locales
- Beschreibung: Der Locale-String (z.B. Locales.ENGLISH, Locales.ARABIC), der zur Bestimmung der Schreibrichtung verwendet wird.
- Typ: Locales (optional)

Rückgabewert

Typ: Dir ('ltr' | 'rtl' | 'auto')
Beschreibung: Die Schreibrichtung, die der Locale entspricht:
- 'ltr' für Sprachen von links nach rechts.
- 'rtl' für Sprachen von rechts nach links.
- 'auto' wenn die Locale nicht erkannt wird.

Beispielanwendung

Bestimmung der Schreibrichtung

typescript

import { getHTMLTextDir } from "intlayer";getHTMLTextDir(Locales.ENGLISH); // Ausgabe: "ltr"getHTMLTextDir(Locales.FRENCH); // Ausgabe: "ltr"getHTMLTextDir(Locales.ARABIC); // Ausgabe: "rtl"

Randfälle

Keine Locale angegeben:
- Die Funktion gibt 'auto' zurück, wenn locale undefined ist.
Nicht erkannte Locale:
- Für nicht erkannte Locales verwendet die Funktion standardmäßig 'auto'.

Verwendung in Komponenten:

Die Funktion getHTMLTextDir kann verwendet werden, um das dir-Attribut in einem HTML-Dokument dynamisch zu setzen, damit der Text basierend auf der Locale korrekt dargestellt wird.

tsx

import type { FC } from "react";import { getHTMLTextDir, type Locales } from "intlayer";export const HTMLLayout: FC<PropsWithChildren<{ locale: Locales }>> = ({  children,  locale,}) => (  <html dir={getHTMLTextDir(locale)} locale={locale}>    <body>{children}</body>  </html>);

Im obigen Beispiel wird das dir-Attribut dynamisch basierend auf der Locale gesetzt.

Dokumentationshistorie

5.5.10 - 2025-06-29: Initiale Historie

Wenn Sie eine Idee haben, um diese Dokumentation zu verbessern, zögern Sie bitte nicht, durch das Einreichen eines Pull-Requests auf GitHub beizutragen.

GitHub-Link zur Dokumentation

Anfangen