ShadowRootRegistry

The shadow roots hosting each registered node, as of the last time that node was looked at. Empty for a node that was detached or lived in the light DOM then. Re-derived for every node by each refresh, so a node that has since been attached, or moved to another tree, is picked up. The union of the values is getShadowRoots.

Parameters

args: [ ]

Delegates selected events to another Emitter. For instance:

emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );

then eventX is delegated (fired by) emitterB and emitterC along with data:

emitterA.fire( 'eventX', data );

and eventY is delegated (fired by) emitterC along with data:

emitterA.fire( 'eventY', data );

Parameters

events: Array<string>

Event names that will be delegated to another emitter.

Returns

EmitterMixinDelegateChain

Fires an event, executing all callbacks registered for it.

The first parameter passed to callbacks is an EventInfo object, followed by the optional args provided in the fire() method call.

Type parameters

TEvent: extends BaseEvent

The type describing the event. See BaseEvent.

Parameters

eventOrInfo: GetNameOrEventInfo<TEvent>

The name of the event or EventInfo object if event is delegated.

args: TEvent[ 'args' ]

Additional arguments to be passed to the callbacks.

Returns

GetEventInfo<TEvent>[ 'return' ]

By default the method returns undefined. However, the return value can be changed by listeners through modification of the evt.return's property (the event info is the first param of every callback).

Returns the shadow roots currently hosting at least one registered node.

Returns

Set<ShadowRoot>

Registers a callback function to be executed when an event is fired in a specific (emitter) object.

Events can be grouped in namespaces using :. When namespaced event is fired, it additionally fires all callbacks for that namespace.

// myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );

// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );

An event callback can stop the event and set the return value of the fire method.

Type parameters

TEvent: extends BaseEvent

The type describing the event. See BaseEvent.

Parameters

emitter: Emitter

The object that fires the event.

event: TEvent[ 'name' ]

The name of the event.

callback: GetCallback<TEvent>

The function to be called on event.

options?: GetCallbackOptions<TEvent>

Additional options.

Returns

void

Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).

Parameters

event: string

The name of the event.

callback: Function

The function to stop being called.

Returns

void

Registers a callback function to be executed when an event is fired.

Shorthand for this.listenTo( this, event, callback, options ) (it makes the emitter listen on itself).

Type parameters

TEvent: extends BaseEvent

The type descibing the event. See BaseEvent.

Parameters

event: TEvent[ 'name' ]

The name of the event.

callback: GetCallback<TEvent>

The function to be called on event.

options?: GetCallbackOptions<TEvent>

Additional options.

Returns

void

Registers a callback function to be executed on the next time the event is fired only. This is similar to calling on followed by off in the callback.

Type parameters

TEvent: extends BaseEvent

The type descibing the event. See BaseEvent.

Parameters

event: TEvent[ 'name' ]

The name of the event.

callback: GetCallback<TEvent>

The function to be called on event.

options?: GetCallbackOptions<TEvent>

Additional options.

Returns

void

Re-derives the shadow roots of every registered node, firing event-add for the roots that started hosting one and event-remove for those that stopped.

Call it whenever a registered node may have been attached, detached, or moved – for example on every editor UI update. Nodes are re-derived rather than resolved once, because the tree a node lives in is not fixed: an editable mounted by the integrator after the editor was created, or moved into a fullscreen container in another tree, ends up somewhere its roots were never derived from.

Returns

void

Registers a node, so the shadow roots hosting it become a part of getShadowRoots.

The node does not have to be attached to the DOM yet; while it is not, it simply contributes no shadow root. The next refresh picks it up once it is attached.

Parameters

node: Node

Returns

void

Stops delegating events. It can be used at different levels:

• To stop delegating all events.
• To stop delegating a specific event to all emitters.
• To stop delegating a specific event to a specific emitter.

Parameters

event?: string

The name of the event to stop delegating. If omitted, stops it all delegations.

emitter?: Emitter

(requires event) The object to stop delegating a particular event to. If omitted, stops delegation of event to all emitters.

Returns

void

Stops listening for events. It can be used at different levels:

• To stop listening to a specific callback.
• To stop listening to a specific event.
• To stop listening to all events fired by a specific object.
• To stop listening to all events fired by all objects.

Parameters

emitter?: Emitter

The object to stop listening to. If omitted, stops it for all objects.

event?: string

(Requires the emitter) The name of the event to stop listening to. If omitted, stops it for all events from emitter.

callback?: Function

(Requires the event) The function to be removed from the call list for the given event.

Returns

void

Unregisters a previously registered node. Shadow roots that no longer host any registered node stop being a part of getShadowRoots.

Parameters

node: Node

Returns

void

Unregisters every currently registered node at once, firing event-remove for every shadow root that consequently stops being tracked.

Returns

void

Fires event-add and event-remove for the difference between the given set of tracked shadow roots and the current one.

Parameters

previousRoots: Set<ShadowRoot>

Returns

void

Fired when a shadow root starts hosting a registered node.

Parameters

eventInfo: EventInfo

An object containing information about the fired event.

root: ShadowRoot

The shadow root that started being tracked.

Fired when a shadow root no longer hosts any registered node.

Parameters

eventInfo: EventInfo

An object containing information about the fired event.

root: ShadowRoot

The shadow root that stopped being tracked.