Direction Provider

Direction provider configures RTL/LTR for part of or the whole app

Bundle Size

Installation

Base UI components are all available as a single package.

npm install @base-ui-components/react

Once you have the package installed, import the component.

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

Usage

Use DirectionProvider to configure RTL keyboard behavior for an app or a group of components:

<html dir="rtl">
  <body>
    <DirectionProvider direction="rtl">{/* Your React app */}</DirectionProvider>
  </body>
</html>

Additionally, you must set the dir="rtl" attribute in your HTML to affect styling.

API Reference

DirectionProvider

A provider that configures RTL/LTR behavior for part of an app or a whole app.

PropTypeDefaultDescription
directionenum'ltr'The reading direction of the text

Contents