TypeCellOS / TypeCellOS/BlockNote

Bilingual documents: unable to declare language on foreign language passages

Open
#2,823 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

a11y
Dominant language
TypeScript
Stars
10.2k
Forks
772
Avg merge
3d 11h
Merged PRs (30d)
17

Description

What’s broken?

When a document contains passages written in two different languages, it is not possible to declare the language on each portion of text. Passages in a foreign language cannot be tagged with the corresponding lang attribute, and passages in French cannot be explicitly assigned lang="fr" either.

What did you expect to happen?

The editor must allow the user to define the language of a selected text passage, so that the lang attribute is applied to the corresponding HTML element with the correct language code (e.g. lang="fr", lang="en", lang="de", etc.). Language changes in a document must be reflected in the generated markup.

Steps to reproduce

Create a document containing passages in French and passages in another language.
Select a passage in a foreign language.
Look for an option to declare the language of this passage.
Observe that no such functionality is available.
Possible solution

Add a "Text language" option in the formatting menu or in a context menu, which applies the lang attribute to the or block element surrounding the selection:

Impact

A blind user navigating with a screen reader reads a bilingual document. The screen reader renders passages in a foreign language with the French speech synthesis voice, producing incorrect and incomprehensible pronunciation. The user cannot access content in a foreign language under normal reading conditions.

BlockNote version

0.51.4

Environment

No response

Additional context

No response

Contribution
  • I'd be interested in contributing a fix for this issue
Sponsor
  • I'm a sponsor and would appreciate if you could look into this sooner than later 💖

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the formatting menu or context-menu entry point and trace how a selected text passage becomes an HTML element in the generated markup. Done means users can choose a language such as French, English, or German for the selection, the corresponding lang attribute appears on the surrounding inline or block element, and changes are reflected in generated markup.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
accessibility, frontend, internationalization
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.