-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
feat: Keybind setting for plugins + shortcustScreenShare example #3614
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
Open
nicola02nb
wants to merge
28
commits into
Vendicated:main
Choose a base branch
from
nicola02nb:global-shortcuts-setting
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
…ey instead of discord keyCode
…eybind, clear false by default
…sktop app and Vesktop version implementation
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.
OptionType.KEYBIND
with the related new componentKeybinds.tsx
(custom version of the original component).keybindManager.ts
api to register and manage global shortcuts.global
property to set to return discordkeyCode
if true, else theKeyboardEvent.key
.DiscordUtils
window.addeventlistener()
ShortcutScrenshareScreen
plugin that uses the globalKeybinds as anexample
.Input support:
DiscordNative
)window.addeventlistener()
)KeyboardEvent.key
there is noleft/right
difference forctrl
,shift
,alt
,meta
)GamepadEvent
to triggerWeb Extension:
In web extension the global keybinds will be disabled and cannot be bound
Other consideration:
keybinds
(which can be done also forcommands
) where you canadd/remove
them,edit
the related keys that triggers them and the relatedfunction
to call... like it's done in discord settings; so users are not obligated to have the keybinds enabled (or also the commands).How to use:
Plugin Start
Atm you can also add to the plugin definition some the events with the related function to call:
that adds on the plugin
start
the eventsname
s to the KeybindManager with the associatedfunction
to call usingregisterKeybind()
, and then enables it usingenableKeybind()
if in the pluginsettings
exists a setting named with the samename
of the event.Setting Update
Settings updates automatically on states changes of the KEYBIND setting component in
Keybinds.tsx
Plugin Stop
On plugin stop, all keybinds will be unregisterd using
disableKeybind()
, and also the events will be unregistered usingunregisterKeybind()