Skip to content
aq-ui
Back to HooksHook

Use Direction

Open-code aq-ui React hook for Use Direction.

Installation

pnpm dlx aq-ui@alpha add use-direction

API reference

Client module

Import the parts you need, then jump to an export for its contract.

View full source

Quick start

"use client"

import { useDirection } from "@/hooks/use-direction"

const result = useDirection()

Direction

typeSource L5

Type contract for Direction.

type Direction = "ltr" | "rtl"

useDirection

functionSource L59

Open-code aq-ui React hook for Use Direction.

function useDirection(defaultDirection: Direction = "ltr"): Direction
Returns
Direction

Parameters

NameTypeDefault
defaultDirection?Direction"ltr"
const result = useDirection()

Files

  • hooks/use-direction.ts

Source