Intlayerの今後のリリースに関する通知を受け取る
    作成:2024-08-11最終更新:2025-06-29

    ドキュメント: intlayergetHTMLTextDir 関数

    説明

    getHTMLTextDir 関数は、指定されたロケールに基づいてテキストの方向(ltrrtl、または auto)を決定します。これは、開発者がHTMLの dir 属性を適切に設定してテキストを正しく表示できるように設計されています。

    パラメーター

    • locale?: Locales

      • 説明: テキスト方向を決定するために使用されるロケール文字列(例:Locales.ENGLISHLocales.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"

    エッジケース

    • ロケールが指定されていない場合:

      • localeundefined の場合、関数は 'auto' を返します。
    • 認識されないロケールの場合:

      • 認識されないロケールの場合、関数はデフォルトで 'auto' を返します。

    コンポーネントでの使用方法:

    getHTMLTextDir 関数は、ロケールに基づいて適切なテキストレンダリングのために HTML ドキュメントの dir 属性を動的に設定するために使用できます。

    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属性がlocaleに基づいて動的に設定されています。

    ドキュメント履歴

    • 5.5.10 - 2025-06-29: 履歴の初期化
    Intlayerの今後のリリースに関する通知を受け取る