utils/dom/emittermixin
@ckeditor/ckeditor5-utils/src/dom/emittermixin
Filtering
Interfaces
-
DomEmitter
module:utils/dom/emittermixin~DomEmitter
-
DomEventMap
module:utils/dom/emittermixin~DomEventMap
Functions
-
DomEmitterMixin( base ) → Mixed<Base, DomEmitter>
module:utils/dom/emittermixin~DomEmitterMixin:EXTENDS
Mixin that injects the DOM events API into its host. It provides the API compatible with
Emitter
.This function creates a class that inherits from the provided
base
and implementsEmitter
interface.DOM emitter mixin is by default available in the
View
class, but it can also be mixed into any other class:import DomEmitterMixin from '../utils/dom/emittermixin.js'; class BaseClass { ... } class SomeView extends DomEmitterMixin( BaseClass ) {} const view = new SomeView(); view.listenTo( domElement, ( evt, domEvt ) => { console.log( evt, domEvt ); } );
Type parameters
Base : extends Constructor<Emitter>
Parameters
base : Base
Returns
Mixed<Base, DomEmitter>
-
DomEmitterMixin() → new () => DomEmitter
module:utils/dom/emittermixin~DomEmitterMixin:NO_ARGUMENTS
Mixin that injects the DOM events API into its host. It provides the API compatible with
Emitter
.This function creates a class that implements
Emitter
interface.DOM emitter mixin is by default available in the
View
class, but it can also be mixed into any other class:import DomEmitterMixin from '../utils/dom/emittermixin.js'; class SomeView extends DomEmitterMixin() {} const view = new SomeView(); view.listenTo( domElement, ( evt, domEvt ) => { console.log( evt, domEvt ); } );
Returns
new () => DomEmitter
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.