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

  • readonly

    editor : Editor

    See source

    The editor instance.

Methods

  • constructor( editor )

    See source

    Creates an instance of the keystroke handler.

    Parameters

    editor : Editor

  • inherited

    destroy() → void

    See source

    Destroys the keystroke handler.

    Returns

    void

  • inherited

    listenTo( emitter ) → void

    See source

    Starts listening for keydown events from a given emitter.

    Parameters

    emitter : Window | Emitter | HTMLElement

    Returns

    void

  • inherited

    press( keyEvtData ) → boolean

    See source

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

    Parameters

    keyEvtData : Readonly<KeystrokeInfo>

    Key event data.

    Returns

    boolean

    Whether the keystroke was handled.

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

    See source

    Registers a handler for the specified keystroke.

    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 : EditingKeystrokeCallback

    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

    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 {}

    Returns

    void

  • inherited

    stopListening( [ emitter ] ) → void

    See source

    Stops listening to keydown events from the given emitter.

    Parameters

    [ emitter ] : Window | Emitter | HTMLElement

    Returns

    void