---
title: "tinymce.Shortcuts"
description: "Contains logic for handling keyboard shortcuts."
canonical_url: "https://www.tiny.cloud/docs/tinymce/latest/apis/tinymce.shortcuts/"
md_url: "https://www.tiny.cloud/docs/tinymce/5/apis/tinymce.shortcuts/index.md"
version: "5"
last_updated: "2024-03-26T08:09:19Z"
tokens: 515
---
Important This page documents TinyMCE 5. For new projects, Tiny recommends using the latest, most up-to-date version. [See TinyMCE 8 documentation](../../../latest/apis/tinymce.shortcuts/).
# tinymce.Shortcuts

Contains logic for handling keyboard shortcuts.

## Examples

```javascript
editor.shortcuts.add('ctrl+a', "description of the shortcut", function() {});
editor.shortcuts.add('ctrl+alt+a', "description of the shortcut", function() {});
// "meta" maps to Command on Mac and Ctrl on PC
editor.shortcuts.add('meta+a', "description of the shortcut", function() {});
// "access" maps to Control+Option on Mac and shift+alt on PC
editor.shortcuts.add('access+a', "description of the shortcut", function() {});

editor.shortcuts.add(
 'meta+access+c', 'Opens the code editor dialog.', function () {
   editor.execCommand('mceCodeEditor');
});

editor.shortcuts.add(
 'meta+shift+32', 'Inserts "Hello, World!" for meta+shift+space', function () {
   editor.execCommand('mceInsertContent', false, 'Hello, World!');
});
```

## Summary

### Methods

| Name | Summary | Defined by |
| --- | --- | --- |
| [add()](#add) | Adds a keyboard shortcut for some command or function. | `Shortcuts` |
| [remove()](#remove) | Remove a keyboard shortcut by pattern. | `Shortcuts` |

## Methods

### add()

```javascript
add(pattern: String, desc: String, cmdFunc: String | Function, scope: Object): Boolean
```
Adds a keyboard shortcut for some command or function.

#### Parameters

- `pattern (String)` - Shortcut pattern. Like for example: ctrl+alt+o.
- `desc (String)` - Text description for the command.
- `cmdFunc (String | Function)` - Command name string or function to execute when the key is pressed.
- `scope (Object)` - Optional scope to execute the function in.

#### Return value

- `Boolean` - true/false state if the shortcut was added or not.

### remove()

```javascript
remove(pattern: String): Boolean
```
Remove a keyboard shortcut by pattern.

#### Parameters

- `pattern (String)` - Shortcut pattern. Like for example: ctrl+alt+o.

#### Return value

- `Boolean` - true/false state if the shortcut was removed or not.