Upstream/waveterm
1
0
Fork 0
mirror of https://github.com/wavetermdev/waveterm.git synced 2024-12-21 16:38:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Better Hotkey Example (#1563)

Browse Source 
- adds a more practical example
- moves the examples above this list of allowed keys
- adds the word "Space" as an option for the space character to the docs

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Documentation**
- Updated the configuration documentation for improved clarity and
additional examples.
- Expanded section on customizable global hotkeys with practical
examples.
	- Clarified representation of the space key in allowed key names.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
This commit is contained in:
Sylvie Crowe 2024-12-18 15:57:52 -08:00 committed by GitHub
parent 007c2391f1
commit 9f471cfde6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/docs/config.mdx
View File

@ -194,7 +194,17 @@ wsh editconfig termthemes.json
### Customizable Systemwide Global Hotkey ### Customizable Systemwide Global Hotkey
Wave allows settings a custom global hotkey to open your most recent window from anywhere in your computer. This has the name `"app:globalhotkey"` in the `settings.json` file and takes the form of a series of key names separated by the `:` character. We support the following key names: Wave allows settings a custom global hotkey to open your most recent window from anywhere in your computer. This has the name `"app:globalhotkey"` in the `settings.json` file and takes the form of a series of key names separated by the `:` character.
#### Examples
As a practical example, suppose you want a value of `F5` as your global hotkey. Then you can simply set the value of `"app:globalhotkey"` to `"F5"` and reboot Wave to make that your global hotkey.
As a less practical example, suppose you use the combination of the keys `Ctrl`, `Option`, and `e`. Then the value for this keybinding would be `"Ctrl:Option:e"`.
#### Allowed Key Names
We support the following key names:
- `Ctrl` - `Ctrl`
- `Cmd` - `Cmd`
@ -207,7 +217,7 @@ Wave allows settings a custom global hotkey to open your most recent window from
- Letters `a` though `z` - Letters `a` though `z`
- F keys `F1` through `F20` - F keys `F1` through `F20`
- Soft keys `Soft1` through `Soft4`. These are essentially the same as `F21` through `F24`. - Soft keys `Soft1` through `Soft4`. These are essentially the same as `F21` through `F24`.
- Space represented as a literal space &nbsp;<code>&nbsp;</code> - Space represented as either `Space` or a literal space &nbsp;<code>&nbsp;</code>
- `Enter` (This is labeled as return on Mac) - `Enter` (This is labeled as return on Mac)
- `Tab` - `Tab`
- `CapsLock` - `CapsLock`
@ -230,5 +240,3 @@ Wave allows settings a custom global hotkey to open your most recent window from
- The numpad minus/subtract represented by `Subtract` - The numpad minus/subtract represented by `Subtract`
- The numpad star/multiply represented by `Multiply` - The numpad star/multiply represented by `Multiply`
- The numpad slash/divide represented by `Divide` - The numpad slash/divide represented by `Divide`
As an example, to set the key to the combination of Control, Option, and the letter E, you would configure it to `"Ctrl:Opt:e"`.