Функція getHTMLTextDir визначає напрямок тексту (ltr, rtl або auto) на основі заданої локалі. Вона призначена, щоб допомогти розробникам встановити атрибут dir в HTML для коректного відображення тексту.

Параметри

locale?: Locales
- Опис: Рядок локалі (наприклад, Locales.ENGLISH, Locales.ARABIC), що використовується для визначення напрямку тексту.
- Тип: Locales (необов'язковий)

Повертає

Тип: Dir ('ltr' | 'rtl' | 'auto')
Опис: Напрямок тексту, що відповідає локалі:
- 'ltr' для мов з напрямком зліва направо.
- 'rtl' для мов з напрямком справа наліво.
- 'auto' якщо локаль не розпізнана.

Приклад використання

Визначення напряму тексту

typescript

Копіювати код

Скопіюйте код у буфер обміну

import { getHTMLTextDir } from "intlayer";

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

Крайні випадки

Локаль не вказано:
- Функція повертає 'auto', коли locale має значення undefined.
Невідома локаль:
- Для невідомих локалей функція за замовчуванням повертає 'auto'.

Використання в компонентах:

Функцію getHTMLTextDir можна використовувати для динамічної установки атрибута dir в HTML-документі для коректного відображення тексту залежно від локалі.

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

У наведеному вище прикладі атрибут dir динамічно встановлюється на основі локалі.

Чому Intlayer?

Історія версій

Документація: функція getHTMLTextDir в intlayer

Опис