CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

BubblingEventInfo (engine/view/observer)

@ckeditor/ckeditor5-engine/src/view/observer/bubblingeventinfo

class
See source

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

Filtering

Properties

  • currentTarget : Document | Node | null

    readonly

    The current bubbling target.

    See source

  • eventPhase : 'none' | 'capturing' | 'atTarget' | 'bubbling'

    readonly

    The current event phase.

    See source

  • name : String

    readonly inherited

    The event name.

    See source

  • path : Array.<Object>

    readonly inherited

    Path this event has followed. See delegate.

    See source

  • return

    inherited

    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 inherited

    The object that fired the event.

    See source

  • startRange : Range

    readonly

    The view range that the bubbling should start from.

    See source

  • _currentTarget : Document | Node | null

    protected

    The current bubbling target.

    See source

  • _eventPhase : 'none' | 'capturing' | 'atTarget' | 'bubbling'

    protected

    The current event phase.

    See source

Methods

  • constructor( source, name, startRange )

    Parameters

    source : Object

    The emitter.

    name : String

    The event name.

    startRange : Range

    The view range that the bubbling should start from.

  • off()

    inherited

    Removes the current callback from future interactions of this event.

    See source

  • stop()

    inherited

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

    See source