feat: configurable keyboard shortcuts via keyboardShortcuts option#19
Merged
Merged
Conversation
Adds a keyboardShortcuts option to createSlideshow() that lets users remap, extend, or disable any key binding without forking the library. - SlideshowOptions gains a keyboardShortcuts field (KeyboardShortcutsConfig) - Keyboard class now accepts an optional shortcuts config, merges it over DEFAULT_SHORTCUTS, and builds an inverted key→action map - Unified onto keydown + event.key (replaces the old keyCode/keypress mix) - Setting a shortcut to null disables the default binding for that action - Setting it to a string or string[] replaces the default binding - Unmentioned actions keep their defaults - DefaultController forwards options.keyboardShortcuts to Keyboard Closes #8
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
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.
Summary
keyboardShortcutsoption tocreateSlideshow()for remapping, extending, or disabling any key bindingKeyboardclass to useKeyboardEvent.key+keydown(replaces the deprecatedkeyCode/keypressapproach)API
Behaviour
stringstring[]nullImplementation notes
DEFAULT_SHORTCUTSis exported so callers can inspect or extend itKeyboardEvent.key(e.g.'ArrowRight','j',' ')gotoSlideNumber) is also a special case outside the keymapCloses #8