useRtl API

API reference for the useRtl composable.

Functions

(options?: RtlOptions) => RtlContext

Creates a new RTL direction instance.

() => RtlContext

<_E>(_options?: RtlContextOptions | undefined) => ContextTrinity<_E>

(_options?: RtlContextOptions | undefined) => Plugin

<_E>(namespace?: string) => _E

boolean | undefined

Initial direction. Defaults to false (LTR).

RtlAdapter | undefined

Adapter for framework-specific side-effects.

string | HTMLElement | null | undefined

Target element or selector for dir attribute. Defaults to documentElement.

Ref<boolean, boolean>

Writable ref — true = RTL, false = LTR

() => void

Convenience method to flip direction