feat: Expose getActiveEditor and getActiveEditorState #5409
Conversation
yf-yang
requested review from
zurfyx,
fantactuka and
acywatson
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
facebook-github-bot
added
the
CLA Signed
|
If we do expose them, I'd like to add typedoc doc blocks to them so they show up in the API docs and people have a sense of how they work (e.g., what is the concept of "active" editor) |
yf-yang
force-pushed
the
feat/expose-utils
branch
from
f14b4ab
to
73e647d
Compare
|
@acywatson I've added two $-prefixed functions. Do you have any comments on the naming/doc? |
packages/lexical/src/LexicalUtils.ts
Outdated
| export function $getEditorState(): EditorState { | ||
| return getActiveEditorState(); | ||
| } |
There was a problem hiding this comment.
The pending editor state was always meant to be kept private (by design), that's why we provide a rich set of utilities to modify its content and should be treated as an implementation detail. It's also one of the mutable parts of Lexical. Hence, it is dangerous to expose externally.
Can you provide more details on why you think it's important to expose this please?
There was a problem hiding this comment.
Yes, I agree with you. Let me try to summarize my thoughts:
$getEditorState is almost equivalent to $getRoot and $getSelection, so it is not necessary.
However, by exposing $getEditor, then one can always do $getEditor().getEditorState(), which is equivalent (isn't it? not so sure), so I just added it here without too much thoughts.
I am OK to remove this API, but your comment makes me consider if exposing $getEditor is a good idea. The only reason to expose $getEditor is to access the editor from within a node because you can always do so when calling editor.update or editorState.read by accessing the parent scope. What's your opinion?
There was a problem hiding this comment.
$getEditor().getEditorState() always returns the rendered EditorState (as opposed to the pending). $getRoot allows you to read or manipulate the rendered or pending editor state without any knowledge on whether the EditorState or nodes have been cloned. That is the reason why we're inclined to think that pending editor state should always be kept private!
yf-yang
force-pushed
the
feat/expose-utils
branch
from
73e647d
to
f386eb2
Compare
Partially implements feature request #5333
Submit a pull request and waiting for the team's opinion.
By the way, do we have any bot that builds this commit online so that I can directly install this commit via npm? Need this one to access parent editor during
importJSONfor my own purpose.