Stay organized with collections
Save and categorize content based on your preferences.
blockly > ShortcutRegistry > addKeyMapping
ShortcutRegistry.addKeyMapping() method
Adds a mapping between a keycode and a keyboard shortcut.
Normally only one shortcut can be mapped to any given keycode, but setting allowCollisions to true allows a keyboard to be mapped to multiple shortcuts. In that case, when onKeyDown is called with the given keystroke, it will process the mapped shortcuts in reverse order, from the most- to least-recently mapped).
Signature:
addKeyMapping(keyCode: string | number | KeyCodes, shortcutName: string, allowCollision?: boolean): void;
Parameters
| Parameter |
Type |
Description |
| keyCode |
string | number | KeyCodes |
The key code for the keyboard shortcut. If registering a key code with a modifier (ex: ctrl+c) use ShortcutRegistry.registry.createSerializedKey; |
| shortcutName |
string |
The name of the shortcut to execute when the given keycode is pressed. |
| allowCollision |
boolean |
(Optional) True to prevent an error when adding a shortcut to a key that is already mapped to a shortcut. |
Returns:
void
Exceptions
{Error} if the given key code is already mapped to a shortcut.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-16 UTC."],[[["The `ShortcutRegistry.addKeyMapping()` method associates a key code with a keyboard shortcut's name for execution."],["It takes the key code, shortcut name, and an optional collision allowance as parameters."],["An error is thrown if the key code is already assigned unless `opt_allowCollision` is set to true."]]],["The `addKeyMapping` method in `ShortcutRegistry` establishes a link between a key code and a keyboard shortcut name. It takes the `keyCode` (string, number, or `KeyCodes` enum), the `shortcutName` (string), and an optional `opt_allowCollision` (boolean) parameter. It maps a key to a shortcut. If the key is already mapped and `opt_allowCollision` is false, it throws an error. Otherwise no error will be thrown. This method returns void.\n"]]
