[lexical-playground] Feature: Add more keyboard shortcuts #6754
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
bedre7
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 📦
|
bedre7
changed the title
add ShortcutsPlugin add ToolbarContext to share state between ShortcutsPlugin and ToolbarPlugin
etrepum
previously approved these changes
Nov 2, 2024
There was a problem hiding this comment.
The code here looks great, very straightforward and easy to read through. I like the extensive tests and other refactoring here. I think this would provide a great example for someone who wanted to implement a full suite of keyboard shortcuts for their own editor.
etrepum
reviewed
Nov 3, 2024
packages/lexical-playground/src/plugins/ShortcutsPlugin/shortcuts.ts
Outdated
Show resolved
Hide resolved
refactor keyboard shortcut helper functions
etrepum
previously approved these changes
Nov 5, 2024
The conflict has been resolved. |
etrepum
approved these changes
Nov 5, 2024
ivailop7
approved these changes
Nov 5, 2024
Merged
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
Closes #6734
This PR adds more keyboard shortcuts to the Lexical Playground with a new plugin called
ShortcutsPluginto improve keyboard accessibility and user experience.Changes Made
ShortcutsPluginto handle all keyboard shortcuts in one place and make adding more shortcuts in the future easier. (This doesn't include some existing shortcuts like, bold and italic which are implemented at the lower level.)ToolbarContextto manage the toolbar state which is shared between theToolbarPluginand theShortcutsPluginToolbarPluginto theShortcutsPlugin.ToolbarPlugin.tsxto a new fileutils.tsto be shared between theToolbarPluginand theShortcutsPlugin.Choices Made
The issue was intended to add the keyboard shortcuts from MS Word, however, certain key combinations are reserved for browser usage and cannot be intercepted by client-side JavaScript, even if
event.preventDefault()is called. (Ref: Chromium Issue 41081444). This is why we have chosen to use key bindings from well-known applications like Google Docs, Tiptap, and Slack, which are web-native applications. This choice ensures that users familiar with these applications will find the shortcuts intuitive and easy to use.Note
Test plan
End-to-end tests have been added for the new keyboard shortcuts.
Acknowledgement
@etrepum for his guidance and letting me work on this feature.
@BennyAlex for creating this useful feature request.