Properties

Here are all the properties available to you to provide as much customization as needed. All fields listed below can be dynamically controlled.

Name Description Options available Type
Global Allow shortcuts to work globally, even inside inputs. If "no," shortcuts will only fire when not typing in an input field.
yes, no Boolean
Shortcut Key(s) Define the key combinations, single keys, or sequences for the shortcuts. Each key bind follows the format:
<key combination>:<action> on <event>
You can define multiple shortcuts, separated by commas. With multiple shortcuts, the complete event will fire. You must specify which key you want to use as a condition. <user text> Text
Blocked Defaults List of common browser commands to block, separated by commas (e.g., ctrl+s, command+s). These commands will be prevented from triggering their default actions if global is set to yes. <user text> Text
Detect Any Key Set to "yes" to track any key press, even if it isn’t specified in the Shortcut Key(s) field. Useful for tracking general key activity beyond just the defined shortcuts. yes, no Boolean
Timeout Time in milliseconds for how long before states reset after a shortcut trigger. <user number> Integer
Hold Time Time (in seconds) that the key or combination must be held to trigger the action. <user number> Integer

<aside> 💡

For a list of most common hotkeys and commands for both devices, check out the link below.

</aside>

https://www.naturalnetworks.com/ultimate-windows-mac-hotkey-list/

Methods for Setting Up Shortcuts

<aside> 💡

Use keydown or keyup to specify whether or not you want to trigger the action on release or immediately after they press. The default will always be keydown.

</aside>

Single Keys

Single key shortcuts are the simplest form. You can define these by specifying the key followed by the action to perform.

Combinations

Combinations are key binds that require multiple keys to be pressed together. For example, ctrl+s to trigger an action. You’re able to specify as many commands as you want to the property (separated by commas).

Sequences (Multiple Steps)

In sequences, you can define a set of keys that must be pressed in order to trigger an action.