Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/mui/base-ui/llms.txt

Use this file to discover all available pages before exploring further.

DirectionProvider

Enables RTL (right-to-left) behavior for Base UI components.

Import

import { DirectionProvider, useDirection } from '@base-ui/react/direction-provider';
import type { TextDirection } from '@base-ui/react/direction-provider';

Component Signature

const DirectionProvider: React.FC<DirectionProvider.Props>

Props

children
React.ReactNode
The content to be wrapped by the direction provider.
direction
TextDirection | undefined
default:"'ltr'"
The reading direction of the text. Can be 'ltr' (left-to-right) or 'rtl' (right-to-left).

Type Definitions

DirectionProvider.Props

interface DirectionProviderProps {
  children?: React.ReactNode;
  direction?: TextDirection | undefined;
}

TextDirection

type TextDirection = 'ltr' | 'rtl';

useDirection Hook

A hook to access the current text direction from context.

Signature

function useDirection(): TextDirection

Return Value

Returns the current text direction ('ltr' or 'rtl'). Defaults to 'ltr' if used outside a DirectionProvider.

Usage Example

import { DirectionProvider, useDirection } from '@base-ui/react/direction-provider';

function MyComponent() {
  const direction = useDirection();
  return <div dir={direction}>Content</div>;
}

function App() {
  return (
    <DirectionProvider direction="rtl">
      <MyComponent />
    </DirectionProvider>
  );
}

Build docs developers (and LLMs) love