Creation:2025-08-23Last update:2025-08-23

    Dokumentacja: funkcja getHTMLTextDir w intlayer

    Opis

    Funkcja getHTMLTextDir określa kierunek tekstu (ltr, rtl lub auto) na podstawie podanego locale. Została zaprojektowana, aby pomóc deweloperom ustawić atrybut dir w HTML dla prawidłowego renderowania tekstu.

    Parametry

    • locale?: Locales
      • Opis: Ciąg znaków locale (np. Locales.ENGLISH, Locales.ARABIC) używany do określenia kierunku tekstu.
      • Typ: Locales (opcjonalny)

    Zwracana wartość

    • Typ: Dir ('ltr' | 'rtl' | 'auto')
    • Opis: Kierunek tekstu odpowiadający locale:
      • 'ltr' dla języków pisanych od lewej do prawej.
      • 'rtl' dla języków pisanych od prawej do lewej.
      • 'auto' jeśli locale nie jest rozpoznane.

    Przykład użycia

    Określanie kierunku tekstu

    typescript
    import { getHTMLTextDir } from "intlayer";

getHTMLTextDir(Locales.ENGLISH); // Wynik: "ltr"
getHTMLTextDir(Locales.FRENCH); // Wynik: "ltr"
getHTMLTextDir(Locales.ARABIC); // Wynik: "rtl"

    Przypadki brzegowe

    • Brak podanego locale:

      • Funkcja zwraca 'auto', gdy locale jest undefined.

    • Nieznane locale:

      • Dla nieznanych locale funkcja domyślnie zwraca 'auto'.

    Użycie w komponentach:

    Funkcja getHTMLTextDir może być użyta do dynamicznego ustawienia atrybutu dir w dokumencie HTML, aby poprawnie renderować tekst w zależności od locale.

    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>
);

    W powyższym przykładzie atrybut dir jest dynamicznie ustawiany na podstawie lokalizacji (locale).

    Dlaczego Intlayer?