[Documentation] Add examples for core/keyboard-shortcut package #42831
Conversation
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
|
Size Change: 0 B Total Size: 1.44 MB ℹ️ View Unchanged
|
19 tasks
|
Nice work @t-hamano. Thank you for your another contribution. We need help with reviewing those examples. |
|
This PR was reviewed in today's Block Editor Handbook Docs Scrub, and we wanted to see if anything is holding up this PR besides a thorough review? |
14b3c77 to
62f11a1
Compare
|
I rebased this PR with the latest trunk branch and tested all the examples again. All samples appear to be working as expected. |
ryanwelcher
approved these changes
Jun 29, 2023
There was a problem hiding this comment.
Testing via the plugin and everything worked as expected. This is fantastic work @t-hamano (as usual)! Let's get it merged!
|
I merged latest trunk and pushed to trigger the checks that didn't report correctly. Hopefully that will get this moved forward. I'll enable auto-merge as well. |
|
Thanks for the review, @ryanwelcher! |
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.
What?
This PR adds examples for the
core/keyboard-shortcutpackage docs. Part of #42125I used
createInterpolateElementto display the key in the codetag, but that made the code a bit longer.To make example code more simpler, it might be good to remove this function.
Testing Instructions
Paste the example code from the documentation page using the following code:
I also created a minimal plugin to test all examples.
keybard-shortcut-example.zip
Import only the examples you wish to test and then build:
Screenshots or screencast
When you run the example code, you should get the following results:
Selectors
getAllShortcutKeyCombinations
getAllShortcutRawKeyCombinations
getCategoryShortcuts
getShortcutAliases
getShortcutDescription
getShortcutKeyCombination
getShortcutRepresentation
Actions
registerShortcut
unregisterShortcut