[lexical-website] Documentation Update: Add editor context gotcha documentation for editorState.read()#7731
Closed
mrdivyansh wants to merge 1 commit intofacebook:mainfrom
Closed
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Collaborator
|
Why not improve the error message and API docs? People will almost certainly find those a lot more easily. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Current behavior:
The documentation does not explain that
editor.getEditorState().read()lacks editor context by default, causing functions like$getEditor()to throw "Unable to find an active editor" errors. This is a common gotcha that developers discover through trial and error.Changes being added:
intro.mdandREADME.mdwith clear warnings about editor context differences$getEditor()fails ineditorState.read()and how to fix itconcepts/editor-state.mdright after theeditorState.read()exampleeditor.read()vseditor.getEditorState().read()Test plan
Before
Developers encountering this issue would:
editor.getEditorState().read(() => $getEditor()){ editor }optionAfter
With the updated documentation:
editor.read()insteadIntroduction._.Lexical.-.29.July.2025.mp4.mp4