Important changes to Tiny Cloud pricing > Find out more

NOTE: TinyMCE 5 reached End of Support in April 2023. No more bug fixes, security updates, or new features will be introduced to TinyMCE 5. We recommend you upgrade to TinyMCE 6 or consider TinyMCE 5 Long Term Support (LTS) if you need more time.

tinymce.Shortcuts

Contains logic for handling keyboard shortcuts.

Examples

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!');
});

Methods

name summary defined by
add() Adds a keyboard shortcut for some command or function. tinymce.Shortcuts
remove() Remove a keyboard shortcut by pattern. tinymce.Shortcuts

Methods

add

add(pattern:String, desc:String, cmdFunc:String, 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) - 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

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.

Can't find what you're looking for? Let us know.

Except as otherwise noted, the content of this page is licensed under the Creative Commons BY-NC-SA 3.0 License, and code samples are licensed under the Apache 2.0 License.