Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/free-crabs-watch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@radix-ui/react-direction': patch
---

Respect document-level dir attribute in useDirection when no DirectionProvider is present
107 changes: 107 additions & 0 deletions packages/react/direction/src/direction.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
import React from 'react';
import type { RenderResult } from '@testing-library/react';
import { cleanup, render } from '@testing-library/react';
import { DirectionProvider, useDirection } from './direction';
import { afterEach, describe, it, beforeEach, expect } from 'vitest';

// Helper component that renders the resolved direction as text
function DirectionDisplay({ localDir }: { localDir?: 'ltr' | 'rtl' }) {
const direction = useDirection(localDir);
return <span data-testid="direction">{direction}</span>;
}

describe('useDirection', () => {
let rendered: RenderResult;

afterEach(() => {
cleanup();
// Reset document dir after each test
document.documentElement.dir = '';
});

describe('given no DirectionProvider and no local dir', () => {
describe('when document dir is not set', () => {
beforeEach(() => {
document.documentElement.dir = '';
rendered = render(<DirectionDisplay />);
});

it('should default to ltr', () => {
expect(rendered.getByTestId('direction').textContent).toBe('ltr');
});
});

describe('when document dir is rtl', () => {
beforeEach(() => {
document.documentElement.dir = 'rtl';
rendered = render(<DirectionDisplay />);
});

it('should return rtl from document', () => {
expect(rendered.getByTestId('direction').textContent).toBe('rtl');
});
});

describe('when document dir is ltr', () => {
beforeEach(() => {
document.documentElement.dir = 'ltr';
rendered = render(<DirectionDisplay />);
});

it('should return ltr from document', () => {
expect(rendered.getByTestId('direction').textContent).toBe('ltr');
});
});
});

describe('given a DirectionProvider with dir="rtl"', () => {
describe('when document dir is ltr', () => {
beforeEach(() => {
document.documentElement.dir = 'ltr';
rendered = render(
<DirectionProvider dir="rtl">
<DirectionDisplay />
</DirectionProvider>,
);
});

it('should return rtl from provider (overrides document)', () => {
expect(rendered.getByTestId('direction').textContent).toBe('rtl');
});
});
});

describe('given a DirectionProvider with dir="ltr"', () => {
describe('when document dir is rtl', () => {
beforeEach(() => {
document.documentElement.dir = 'rtl';
rendered = render(
<DirectionProvider dir="ltr">
<DirectionDisplay />
</DirectionProvider>,
);
});

it('should return ltr from provider (overrides document)', () => {
expect(rendered.getByTestId('direction').textContent).toBe('ltr');
});
});
});

describe('given a local dir prop', () => {
describe('when DirectionProvider is rtl and document is rtl', () => {
beforeEach(() => {
document.documentElement.dir = 'rtl';
rendered = render(
<DirectionProvider dir="rtl">
<DirectionDisplay localDir="ltr" />
</DirectionProvider>,
);
});

it('should return ltr from local dir (highest priority)', () => {
expect(rendered.getByTestId('direction').textContent).toBe('ltr');
});
});
});
});
9 changes: 8 additions & 1 deletion packages/react/direction/src/direction.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,16 @@ const DirectionProvider: React.FC<DirectionProviderProps> = (props) => {

function useDirection(localDir?: Direction) {
const globalDir = React.useContext(DirectionContext);
return localDir || globalDir || 'ltr';
const documentDir = getDocumentDirection();
return localDir || globalDir || documentDir;
}

function getDocumentDirection(): Direction {
if (typeof document === 'undefined') return 'ltr';
return document.documentElement.dir === 'rtl' ? 'rtl' : 'ltr';
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can be simplified like this @ahmadaurwahaj.

Suggested change
return document.documentElement.dir === 'rtl' ? 'rtl' : 'ltr';
return document.documentElement.dir || 'ltr';

}


const Provider = DirectionProvider;

export {
Expand Down