The Air Keyboard Shortcut plugin allows you to define shortcut key combination and use it to trigger workflow actions.
For modifier keys you can use
You can substitute
Other special keys are
Any other key you should be able to reference by name like
Keys that require
?, are handled magically for you. They should just work.
Cross platform support
The plugin provides a generic mod helper which lets you set cross platform shortcuts.
So if you define a shortcut binding as
mod+k, on Mac this ends up mapping to
command+s whereas on Windows and Linux it maps to
Plugin element properties
This plugin is a non-visual element. Which means when it is added to a page it will not be showed on preview.
There are only two fields to set in the element properties as show below.
There are two ways to define shortcut keys
This allow you to define a shortcut key combinations that must be pressed together. e.g.
Use a + to specify the key combination. e.g.
ctrl+k. This will allow you to trigger an action when the ctrl and k keys are pressed together
Note do not use more than one character key in a combination. If you do the shortcut will be triggered by only that last key specified in the combination.
You can use a sequence in that case or use the character key in combination with a special or modifier key.
This feature is inspired by Gmail-style shortcuts. If you type each key in order the final one in the sequence will cause the trigger. If you type a key not in the sequence or wait too long the sequence will reset.
You specify a sequence by separating the keys with space. e.g.
Or you can even have a complex key sequence like
up up down down left right left right b a enter. Hellooo Mortal Kombat fans
You can also make a sequence that includes key combinations within it.
g o command+enter: this means that to trigger this shortcut the user has to press
gquickly followed by
oand then press
Allow globally option
By default the shortcuts will not work in input elements like text input and textareas.
But when this option is checked the keyboard shortcut bindings will work in all inputs including text inputs.
Use this with caution because it can cause some issues with default keyboard shortcut bindings in inputs.
Plugin actions Removed, see EDIT below
The plugin also provides two workflow actions
1. Pause AirKeyboardShortcut - for pausing the keyboard shortcut bindings. You can use this allow users to enable and disable shortcut functionality.
2. Resume AirKeyboardShortcut - for resuming the keyboard shortcut bindings
How to use:
- Install the plugin
- Add the element to the page.
- Define the two properties as explained above
- In the workflow page add a new event
- Choose one of your AirKeyboardShorcuts elements
- Define your action as usual
The plugin actions can be assessed from the Workflow page, the Plugin as shown below
I’ve decided to removed the actions.
They’re not really needed as you can hide simply hide the element to stop triggering the shortcut binding
Most importantly with the actions, i had to put the plugin library in the shared header which seems not to be playing well with other plugins.