[Documentation][lexical-website]: Documentation for useLexical node selection hook #6976
Conversation
This file contains 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
Kingscliq
requested review from
zurfyx,
fantactuka,
acywatson,
Fetz,
ivailop7,
Sahejkm and
potatowagon
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
facebook-github-bot
added
the
CLA Signed
size-limit report 📦
|
etrepum
approved these changes
Dec 18, 2024
There was a problem hiding this comment.
Looks like a nice straightforward improvement and it renders well on the doc portal https://lexical-oyrm7dqtd-fbopensource.vercel.app/docs/api/modules/lexical_react_useLexicalNodeSelection
I don't see any usage examples but I don't see any reason not to approve this as-is, those could always be added separately
Comment on lines
+24
to
+26
| * @param {LexicalEditor} editor - The LexicalEditor instance. | ||
| * @param {NodeKey} key - The key of the node to check. | ||
| * @returns {boolean} Whether the node is selected. |
There was a problem hiding this comment.
nit: it's redundant to repeat the types in the comments, because typedoc will fill that in using the actual types. This function also isn't exported so there's not as much reason to spend the time on it, the purpose is fairly clear from the name and types alone.
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
Add documentation for the
useLexicalNodeSelectionhook.Closes #6975
Before
No documentation existed for the
useLexicalNodeSelectionhook, making it harder for developers to integrate and use.After
Comprehensive documentation added for the
useLexicalNodeSelectionhook, including usage examples, parameter details, and return values for improved clarity and ease of integration.