Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add commandPriority option to LexicalMenu and dependent components #5123

Merged
merged 1 commit into from
Oct 24, 2023

Conversation

huw
Copy link
Contributor

@huw huw commented Oct 16, 2023

Resolves #3714, which is a long-standing issue that multiple users seem to have faced. Previously, this repo has solved it by:

  1. Setting all of the commands to COMMAND_PRIORITY_NORMAL (LexicalTypeaheadMenuPlugin - Increase priority for keyboard commands #2885)
  2. Setting all of the commands to COMMAND_PRIORITY_CRITICAL (Typeaheads: Add scroll command and increase priority #3106)
  3. Setting all of the commands to COMMAND_PRIORITY_LOW (Change command priority in typeahead #3441)

It is pretty clear that a more generic solution is needed. This PR adds a commandPriority prop to LexicalMenu and its dependent components, including:

  • LexicalTypeaheadMenuPlugin (most often called out)
  • LexicalNodeMenuPlugin
  • LexicalContextMenuPlugin
  • LexicalAutoEmbedPlugin (under menuCommandPriority, because this plugin registers an insertion command that should remain at COMMAND_PRIORITY_EDITOR)

Future changes should address:

  1. Customising priority per-command (this is hard to implement today since commands don’t have string IDs in production builds)
  2. Customising priority for all components in @lexical/react

However, since LexicalMenu has been repeatedly and specifically changed, IMO this PR has a higher cost-benefit than doing those immediately (although I’d love a maintainer’s thoughts!).

@vercel
Copy link

vercel bot commented Oct 16, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
lexical ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 16, 2023 4:27am
lexical-playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 16, 2023 4:27am

@facebook-github-bot
Copy link
Contributor

Hi @huw!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Oct 16, 2023
@acywatson
Copy link
Contributor

Yea this makes sense to me. Not sure why we put this off so long.

@acywatson
Copy link
Contributor

Seems to be fully backwards compat

@huw
Copy link
Contributor Author

huw commented Oct 24, 2023

Do I need to get the build to green to merge this?

@acywatson acywatson merged commit df2a50b into facebook:main Oct 24, 2023
42 of 44 checks passed
@acywatson
Copy link
Contributor

Do I need to get the build to green to merge this?

Nope! All good. Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants