Infragistics
Close
Angular React Web Components Blazor React
Open Source

Right-to-Left (RTL) Support

Ignite UI for React components support right-to-left (RTL) layouts: set dir="rtl" on the page and the components mirror their layout and most of their keyboard interaction, with no separate RTL theme.

Overview

Ignite UI for React takes the direction from the standard HTML dir attribute. No component has a direction property, and there is no RTL version of a theme: the theme you already load serves both directions.

Layer How it follows the direction
Styles Component styles use CSS logical properties, such as margin-inline-start, and direction selectors, so the layout mirrors as soon as the direction changes.
Interaction Components with horizontal keyboard or pointer interaction, such as Carousel, Slider, Stepper and Tabs, read the direction when the user interacts with them. In RTL, the Arrow Left and Arrow Right keys follow the reading direction.

A few components follow the direction only in part. Known Limitations lists them for React.

Before You Start

RTL mirrors the layout; it does not translate text. The dir attribute changes the reading direction only. To show the component strings in another language, see Localization.

Set the direction in one place. For a whole application, set dir="rtl" on the body element. To mirror only part of a page, set it on a container instead, as described in Apply RTL to Part of a Page.

Your own content needs logical properties too. The components mirror themselves, but styles you write with physical properties, such as margin-left, stay where you put them. See Style Your Own Content for RTL.

Next Steps

Available Tools

Tool Where What it does
dir attribute Any HTML element, usually body Sets the direction of the element and of everything inside it. Accepts rtl, ltr and auto.
CSS logical properties Your stylesheets Place content relative to the reading direction, such as padding-inline-start in place of padding-left.
:dir(rtl) pseudo-class Your stylesheets Matches an element whose direction is right-to-left, whether the dir attribute is on the element or on an ancestor.

For directional icons, the Icon and the Icon Button also have a mirrored property. See Mirror a Directional Icon.

Common Workflows

Enable RTL for the Whole Application

Set dir="rtl" on the body element of the host page. Every Ignite UI for React component on the page renders right-to-left.

Set the attribute in the index.html of your application:

<!doctype html>
<html lang="ar">
  <head>
    <meta charset="utf-8" />
    <title>My App</title>
  </head>
  <body dir="rtl">
    <!-- application content -->
  </body>
</html>

Switch the Direction at Runtime

To change the direction while the application runs, for example when the user picks another language, set the dir attribute of the body element. The component styles update at once, and the components read the new direction the next time the user interacts with them.

function setDirection(dir: 'ltr' | 'rtl') {
  document.body.dir = dir;
}

Apply RTL to Part of a Page

To mirror only part of a page, such as a panel with Arabic or Hebrew content, set dir="rtl" on the element that contains it and leave the body left-to-right. The components inside the element follow its direction.

The following sample places a Calendar in a container with dir="rtl". Select Change Directionality to switch the container between right-to-left and left-to-right.

The Carousel and the Navigation Drawer mirror their navigation buttons, indicators and slide direction only when dir="rtl" is on the body element or on the component itself. Inside a right-to-left container, set dir="rtl" on these two components as well:

<div dir="rtl">
  <IgrCarousel dir="rtl"></IgrCarousel>
</div>

Mirror a Directional Icon

Icons are not mirrored automatically, because most icons look the same in both directions. For an icon that points in the reading direction, such as an arrow, set mirrored to flip it in a right-to-left layout. The Icon and the Icon Button support it.

Style Your Own Content for RTL

Write the styles of your own content with CSS logical properties, so they mirror together with the components. Use the :dir(rtl) pseudo-class for a rule that applies in one direction only:

.toolbar {
  padding-inline-start: 16px; /* left in LTR, right in RTL */
}

.next-icon:dir(rtl) {
  transform: scaleX(-1);
}

Known Limitations

The following components follow the direction only in part in Ignite UI for React.

Component What does not follow the direction
Grid, Tree Grid, Hierarchical Grid, Pivot Grid The layout and the horizontal scrolling follow the direction, but the keyboard navigation does not. Arrow Left moves the focus to the previous column and Arrow Right to the next one, so in RTL, Arrow Left moves the focus to the right.
Calendar, including the calendar of the Date Picker and the Date Range Picker Arrow Left moves to the previous day and Arrow Right to the next one in both directions.
Carousel, Navigation Drawer The navigation buttons, the indicators and the slide direction mirror only when dir="rtl" is on the body element or on the component itself, not on the html element or on another ancestor.

If a component does not follow the direction as described on this page, report it on the Ignite UI for React issue tracker.

Troubleshooting

The Carousel and the Navigation Drawer combine the direction of the body element with their own dir attribute. When dir="rtl" is on the html element only, they render left-to-right; when it is on both the body element and the component, the two cancel out. Set dir="rtl" in one place: on the body element for the whole page, or on the component for a component inside a right-to-left container.

Why does my own content stay on the left in RTL?

Styles that use physical properties, such as margin-left or float: left, do not mirror. Replace them with logical properties, such as margin-inline-start or float: inline-start, as shown in Style Your Own Content for RTL.

Additional Resources

FAQ

How do I enable RTL in Ignite UI for React?

Set dir="rtl" on the body element of the host page. Ignite UI for React components take their direction from the dir attribute, so no component setting or extra package is needed. To mirror only part of a page, set the attribute on a container element instead.

Do I need a separate theme for RTL in Ignite UI for React?

No. The Ignite UI for React themes support both directions, and the same theme CSS serves left-to-right and right-to-left pages.

Can I switch between LTR and RTL without reloading the page?

Yes. Change the dir attribute of the body element, or of the container that holds the components. The Ignite UI for React component styles update at once, and the components read the new direction the next time the user interacts with them.

Do the Ignite UI for React grids support RTL?

In part. The Grid, Tree Grid, Hierarchical Grid and Pivot Grid lay out their columns and scroll horizontally in the page direction, but their arrow-key navigation is not mirrored. In RTL, Arrow Left moves the focus to the previous column, which is on the right.

Does RTL translate the text of the Ignite UI for React components?

No. The dir attribute changes only the reading direction and the layout. Translating the built-in component strings is a separate localization step.