Function useWritingMode

useWritingMode<E extends Element>(
    ref?: E | null,
):
    | {
        contentFlow: LeftToRight;
        direction: DocumentDirection;
        textFlow: LeftToRight;
        writingMode: WritingMode;
    }
    | {
        contentFlow: TopToBottom;
        direction: DocumentDirection;
        textFlow: LeftToRight;
        writingMode: WritingMode;
    }
    | {
        contentFlow: TopToBottom;
        direction: DocumentDirection;
        textFlow: LeftToRight;
        writingMode: WritingMode;
    }
    | {
        contentFlow: TopToBottom;
        direction: DocumentDirection;
        textFlow: LeftToRight;
        writingMode: WritingMode;
    }
    | {
        contentFlow: BottomToTop;
        direction: DocumentDirection;
        textFlow: LeftToRight;
        writingMode: WritingMode;
    }
    | {
        contentFlow: RightToLeft;
        direction: DocumentDirection;
        textFlow: RightToLeft;
        writingMode: WritingMode;
    }
    | {
        contentFlow: BottomToTop;
        direction: DocumentDirection;
        textFlow: RightToLeft;
        writingMode: WritingMode;
    }
    | {
        contentFlow: BottomToTop;
        direction: DocumentDirection;
        textFlow: RightToLeft;
        writingMode: WritingMode;
    }
    | {
        contentFlow: BottomToTop;
        direction: DocumentDirection;
        textFlow: RightToLeft;
        writingMode: WritingMode;
    }
    | {
        contentFlow: TopToBottom;
        direction: DocumentDirection;
        textFlow: LeftToRight;
        writingMode: WritingMode;
    }
Detects the writing mode and direction of an element.
Type Parameters
- E extends Element
  The element type.
Parameters
- Optionalref: E | null
  The element to observe (defaults to document.body).
Returns
    | {
        contentFlow: LeftToRight;
        direction: DocumentDirection;
        textFlow: LeftToRight;
        writingMode: WritingMode;
    }
    | {
        contentFlow: TopToBottom;
        direction: DocumentDirection;
        textFlow: LeftToRight;
        writingMode: WritingMode;
    }
    | {
        contentFlow: TopToBottom;
        direction: DocumentDirection;
        textFlow: LeftToRight;
        writingMode: WritingMode;
    }
    | {
        contentFlow: TopToBottom;
        direction: DocumentDirection;
        textFlow: LeftToRight;
        writingMode: WritingMode;
    }
    | {
        contentFlow: BottomToTop;
        direction: DocumentDirection;
        textFlow: LeftToRight;
        writingMode: WritingMode;
    }
    | {
        contentFlow: RightToLeft;
        direction: DocumentDirection;
        textFlow: RightToLeft;
        writingMode: WritingMode;
    }
    | {
        contentFlow: BottomToTop;
        direction: DocumentDirection;
        textFlow: RightToLeft;
        writingMode: WritingMode;
    }
    | {
        contentFlow: BottomToTop;
        direction: DocumentDirection;
        textFlow: RightToLeft;
        writingMode: WritingMode;
    }
    | {
        contentFlow: BottomToTop;
        direction: DocumentDirection;
        textFlow: RightToLeft;
        writingMode: WritingMode;
    }
    | {
        contentFlow: TopToBottom;
        direction: DocumentDirection;
        textFlow: LeftToRight;
        writingMode: WritingMode;
    }
An object containing writingMode, direction, contentFlow, and textFlow.
Remarks
This hook observes changes to the dir attribute (on body/document) and writing-mode style (on the element). It returns the current writing mode, text direction, and derived content/text flow.
Example
```
const { writingMode, direction } = useWritingMode(ref.current);
```
- Defined in hook/useWritingMode/index.ts:111

Function useWritingMode

Type Parameters

Parameters

Remarks

Example

Settings