Документация: Функция getHTMLTextDir в intlayer

    Описание

    Функция 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); // Вывод: "ltr"getHTMLTextDir(Locales.FRENCH); // Вывод: "ltr"getHTMLTextDir(Locales.ARABIC); // Вывод: "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 задается динамически на основе локали.

    Если у вас есть идея по улучшению этой документации, не стесняйтесь внести свой вклад, подав запрос на вытягивание на GitHub.

    Ссылка на документацию GitHub
    getEnumerationexpress-intlayer