Skip to content

Full bidirectional (RTL) support #2610

@Nirlah

Description

@Nirlah

The following is a short overview of bi-directional editing surfaces and my suggestion for improving Lexical’s implementation. (Continued from the Discord discussion)

Overview

Modern editing surfaces’ default behavior today is to support bi-directional content by setting the direction based on the first letter’s language. This can be seen in the current Lexical implementation, Apple Notes, Gmail, and Google Docs:

Screen.Recording.2022-07-07.at.10.54.24.mp4

One implementation detail crucial for longer-form and complex content (like a letter or an article) is maintaining the previous paragraph setting if the user manually sets it. Microsoft Office Word gets this correctly:

Screen.Recording.2022-07-07.at.10.57.01.mp4

The recordings demonstrate Hebrew, but the behavior is similar in Arabic.

Implementation Suggestions

The following are my suggestions for scalable bi-directional support in Lexical:

  1. Maintain the current dynamic evaluation of direction as the default behavior.
  2. Add support for manually toggling/setting the node’s direction.
  3. If a node has a direction manually set, it should be respected. (When parsing a serialized editor state, the current implementation dynamically evaluates the content, disregarding the provided configuration.)
  4. One (or both) of the following will allow composing more complex content (letter/article) without constant friction:
    4.1. If the root node’s direction is manually set, it should be the default direction for child nodes.
    4.2. When creating a following paragraph, if the previous paragraph has a manual direction set, it should be copied into the next paragraph.

Metadata

Metadata

Assignees

No one assigned

    Labels

    coreReconciler, DOM, Selection, Node, Events, CompositionenhancementImprovement over existing featuretext directionRelated to bidirectional text input (rtl, ltr)

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions