CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

EventInfo (utils)

@ckeditor/ckeditor5-utils/src/eventinfo

class
See source

The event object passed to event callbacks. It is used to provide information about the event as well as a tool to manipulate it.

Filtering

Properties

  • name : String

    readonly

    The event name.

    See source

  • path : Array.<Object>

    readonly

    Path this event has followed. See delegate.

    See source

  • return

    The value which will be returned by fire.

    See source

    It's undefined by default and can be changed by an event listener:

    dataController.fire( 'getSelectedContent', ( evt ) => {
    // This listener will make `dataController.fire( 'getSelectedContent' )`
    // always return an empty DocumentFragment.
    evt.return = new DocumentFragment();

    // Make sure no other listeners are executed.
    evt.stop();
} );

  • source : Object

    readonly

    The object that fired the event.

    See source

Methods

  • constructor( source, name )

    Parameters

    source : Object

    The emitter.

    name : String

    The event name.

  • off()

    Removes the current callback from future interactions of this event.

    See source

  • stop()

    Stops the event emitter to call further callbacks for this event interaction.

    See source