List: add RTL documentation

dojo · May 12, 2020 · 0da7bb9 · 0da7bb9
1 parent d8d2a16
commit 0da7bb9
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/doc/components/core-components/List.md b/doc/components/core-components/List.md
@@ -89,3 +89,14 @@ When a dgrid instance is created with no ID specified (via the `id` property in
 
 As of dgrid 0.4.1, the `dgrid_` prefix for auto-generated IDs is exposed via `List.autoIdPrefix` (a property on the
 constructor, not the prototype) and can be overridden if desired.
+
+## Right-to-left (RTL) support
+
+dgrid is designed to support RTL rendering. dgrid detects any of the following standard ways of setting a document's rendering direction:
+
+* `<html dir="rtl">`
+* `<body dir="rtl">`
+* `<body style="direction: rtl">`
+  * Note: using a CSS rule or class to apply `direction` to the `body` will not work, it must be set directly on the `style` attribute.
+
+Tests and examples can be seen in [`test/rtl.html`](../../../test/rtl.html).