Skip to content

docs: use uppercase hotkey example #247

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.

Sign up for GitHub

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
markoub wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: use uppercase hotkey example #247

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions en/Plugins/User interface/Commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,13 +104,13 @@ The user can run commands using a keyboard shortcut, or _hot key_. While they ca
> [!warning]
> Avoid setting default hot keys for plugins that you intend for others to use. Hot keys are highly likely to conflict with those defined by other plugins or by the user themselves.

In this example, the user can run the command by pressing and holding Ctrl (or Cmd on Mac) and Shift together, and then pressing the letter `a` on their keyboard.
In this example, the user can run the command by pressing and holding Ctrl (or Cmd on Mac) and Shift together, and then pressing the letter `A` on their keyboard.

```ts
this.addCommand({
id: 'example-command',
name: 'Example command',
hotkeys: [{ modifiers: ['Mod', 'Shift'], key: 'a' }],
hotkeys: [{ modifiers: ['Mod', 'Shift'], key: 'A' }],
callback: () => {
console.log('Hey, you!');
},
Expand All @@ -119,3 +119,5 @@ this.addCommand({

> [!note]
> The Mod key is a special modifier key that becomes Ctrl on Windows and Linux, and Cmd on macOS.

For letter keys, use uppercase values for `key`, such as `A` instead of `a`. Lowercase letter values can cause hot keys to fail when the user uses a non-Latin keyboard layout.