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

Type parameters

Properties

  • readonly

    name : TName

    See source

    The event name.

  • readonly

    off : () => void

    See source

    Removes the current callback from future interactions of this event.

  • path : Array<object>

    See source

    Path this event has followed. See delegate.

  • return : undefined | TReturn

    See source

    The value which will be returned by fire.

    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();
} );

  • readonly

    source : object

    See source

    The object that fired the event.

  • readonly

    stop : () => void

    See source

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

Methods

  • constructor( source, name )

    See source

    Type parameters

    TName : extends string = string
    TReturn : unknown

    Parameters

    source : object

    The emitter.

    name : TName

    The event name.