CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

EditingKeystrokeHandler (core)

@ckeditor/ckeditor5-core/src/editingkeystrokehandler

class
See source

A keystroke handler for editor editing. Its instance is available in keystrokes so plugins can register their keystrokes.

E.g. an undo plugin would do this:

editor.keystrokes.set( 'Ctrl+Z', 'undo' );
editor.keystrokes.set( 'Ctrl+Shift+Z', 'redo' );
editor.keystrokes.set( 'Ctrl+Y', 'redo' );

Filtering

Properties

  • editor : Editor

    readonly

    The editor instance.

    See source

  • _listener : Emitter

    protected inherited

    Listener used to listen to events for easier keystroke handler destruction.

    See source

Methods

  • constructor( editor )

    Creates an instance of the keystroke handler.

    See source

    Parameters

    editor : Editor

  • destroy()

    inherited

    Destroys the keystroke handler.

    See source

  • listenTo( emitter )

    inherited

    Starts listening for keydown events from a given emitter.

    See source

    Parameters

    emitter : Emitter

  • press( keyEvtData ) → Boolean

    inherited

    Triggers a keystroke handler for a specified key combination, if such a keystroke was defined.

    See source

    Parameters

    keyEvtData : KeyEventData

    Key event data.

    Returns

    Boolean

    Whether the keystroke was handled.

  • set( keystroke, callback, [ options ] = { [options.priority] } )

    Registers a handler for the specified keystroke.

    See source

    The handler can be specified as a command name or a callback.

    Parameters

    keystroke : String | Array.<(String | Number)>

    Keystroke defined in a format accepted by the parseKeystroke function.

    callback : function | String

    If a string is passed, then the keystroke will execute a command. If a function, then it will be called with the key event data object and a cancel() helper to both preventDefault() and stopPropagation() of the event.

    [ options ] : Object

    Additional options.

    Properties
    [ options.priority ] : PriorityString | Number

    The priority of the keystroke callback. The higher the priority value the sooner the callback will be executed. Keystrokes having the same priority are called in the order they were added.

    Defaults to 'normal'

    Defaults to {}