131 lines
3.4 KiB
Markdown
131 lines
3.4 KiB
Markdown
|
# Right-to-left support
|
|||
|
|
|
|||
|
|
<p class="description">Learn how to implement right-to-left (RTL) text with Joy UI to support languages such as Arabic, Persian, and Hebrew.</p>
|
|||
|
|
|
|||
|
|
## Setup
|
|||
|
|
|
|||
|
|
This guide outlines the three steps necessary to change the direction of text-based components in Joy UI to support RTL languages, as shown in the demo below:
|
|||
|
|
|
|||
|
|
{{"demo": "RtlDemo.js"}}
|
|||
|
|
|
|||
|
|
### 1. Set the HTML direction
|
|||
|
|
|
|||
|
|
You can set the text direction either globally (across the entire app) or locally (specific to individual components), depending on your use case.
|
|||
|
|
|
|||
|
|
#### Globally
|
|||
|
|
|
|||
|
|
Add `dir="rtl"` to the app's root `<html>` tag to set the global text direction:
|
|||
|
|
|
|||
|
|
```html
|
|||
|
|
<html dir="rtl"></html>
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
If you can't set the `dir` attribute directly on the root `<html>` element, as a workaround, use the JavaScript API before the page is rendered:
|
|||
|
|
|
|||
|
|
```js
|
|||
|
|
document.documentElement.setAttribute('dir', 'rtl');
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
#### Locally
|
|||
|
|
|
|||
|
|
Add the `dir="rtl"` attribute to any other HTML element or React component if you need limit the scope of the text direction to that element and its children.
|
|||
|
|
|
|||
|
|
:::warning
|
|||
|
|
Components that use React portals (like the [Modal](/joy-ui/react-modal/)) do _not_ inherit the `dir` attribute from parents, because they actually render outside of their parental DOM trees.
|
|||
|
|
|
|||
|
|
You must apply the `dir` attribute directly to these components if it's not globally defined as right-to-left:
|
|||
|
|
|
|||
|
|
```jsx
|
|||
|
|
<Box dir="rtl">
|
|||
|
|
<Modal /> // ❌ this Modal will still be left-to-right (the default)
|
|||
|
|
</Box>
|
|||
|
|
<Box dir="rtl">
|
|||
|
|
<Modal dir="rtl" /> // ✅ this Modal will be right-to-left as intended
|
|||
|
|
</Box>
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
:::
|
|||
|
|
|
|||
|
|
### 2. Set the theme direction
|
|||
|
|
|
|||
|
|
Use the `extendTheme` API to set the theme direction to `'rtl'`:
|
|||
|
|
|
|||
|
|
```js
|
|||
|
|
import { extendTheme } from '@mui/joy/styles';
|
|||
|
|
|
|||
|
|
const theme = extendTheme({
|
|||
|
|
direction: 'rtl',
|
|||
|
|
});
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 3. Configure RTL style plugin
|
|||
|
|
|
|||
|
|
Install the `@mui/stylis-plugin-rtl` using one of the commands below:
|
|||
|
|
|
|||
|
|
<codeblock storageKey="package-manager">
|
|||
|
|
|
|||
|
|
```bash npm
|
|||
|
|
npm install stylis @mui/stylis-plugin-rtl
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
```bash pnpm
|
|||
|
|
pnpm add stylis @mui/stylis-plugin-rtl
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
```bash yarn
|
|||
|
|
yarn add stylis @mui/stylis-plugin-rtl
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
</codeblock>
|
|||
|
|
|
|||
|
|
#### With Emotion
|
|||
|
|
|
|||
|
|
If you're using Emotion, use the [CacheProvider](https://emotion.sh/docs/cache-provider) to create a new cache instance that uses `rtlPlugin` from `@mui/stylis-plugin-rtl` and add that to the top of your application tree:
|
|||
|
|
|
|||
|
|
```jsx
|
|||
|
|
import { CacheProvider } from '@emotion/react';
|
|||
|
|
import createCache from '@emotion/cache';
|
|||
|
|
import { prefixer } from 'stylis';
|
|||
|
|
import rtlPlugin from '@mui/stylis-plugin-rtl';
|
|||
|
|
|
|||
|
|
// Create rtl cache
|
|||
|
|
const cacheRtl = createCache({
|
|||
|
|
key: 'muirtl',
|
|||
|
|
stylisPlugins: [prefixer, rtlPlugin],
|
|||
|
|
});
|
|||
|
|
|
|||
|
|
function Rtl(props) {
|
|||
|
|
return <CacheProvider value={cacheRtl}>{props.children}</CacheProvider>;
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
#### With styled-components
|
|||
|
|
|
|||
|
|
If you're using styled-components, use the [StyleSheetManager](https://styled-components.com/docs/api#stylesheetmanager) and provide `rtlPlugin` to the `stylisPlugins` property:
|
|||
|
|
|
|||
|
|
```jsx
|
|||
|
|
import { StyleSheetManager } from 'styled-components';
|
|||
|
|
import rtlPlugin from '@mui/stylis-plugin-rtl';
|
|||
|
|
|
|||
|
|
function Rtl(props) {
|
|||
|
|
return (
|
|||
|
|
<StyleSheetManager stylisPlugins={[rtlPlugin]}>
|
|||
|
|
{props.children}
|
|||
|
|
</StyleSheetManager>
|
|||
|
|
);
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## Opting out of RTL locally
|
|||
|
|
|
|||
|
|
To turn off RTL on specific components, use the template literal syntax and add the `/* @noflip */` directive:
|
|||
|
|
|
|||
|
|
```js
|
|||
|
|
const LeftToRightTextInRtlApp = styled('div')`
|
|||
|
|
/* @noflip */
|
|||
|
|
text-align: left;
|
|||
|
|
`;
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
{{"demo": "RtlOptOut.js"}}
|