FocusTracker (utils)

@ckeditor/ckeditor5-utils/src/focustracker

class

Allows observing a group of DOM Elements or view instances whether at least one of them (or their child) is focused.

Used by the Editor in order to track whether the focus is still within the application, or were used outside of its UI.

Note focus and blur listeners use event capturing, so it is only needed to register wrapper Element which contain other focusable elements. But note that this wrapper element has to be focusable too (have e.g. tabindex="-1").

Check out the "Deep dive into focus tracking" guide to learn more.

Filtering

Public
Inherited
Internal
Protected
Private
Deprecated

Properties

readonly
elements : Array<Element>

See source
List of registered DOM elements.

Note: The list does do not include elements from externalViews.
readonly
externalViews : Array<ViewWithFocusTracker>

See source
List of external focusable views that contribute to the state of this focus tracker. See add to learn more.
observable
focusedElement : null | Element

See source
The currently focused element.

While isFocused remains true, the focus can move between different UI elements. This property tracks those elements and tells which one is currently focused.

Note: The values of this property are restricted to elements or elements registered in externalViews.
observable
isFocused : boolean

See source
True when one of the registered elements or externalViews is focused.
internal
_elements : Set<Element>

See source
List of registered DOM elements.
internal
_externalViews : Set<ViewWithFocusTracker>

See source
List of views with external focus trackers that contribute to the state of this focus tracker.
private
_blurTimeout : null | Timeout

See source
Asynchronous blur event timeout.

Methods

constructor()

See source
add( elementOrView ) → void
See source
Starts tracking a specified DOM element or a View instance.
- If a DOM element is passed, the focus tracker listens to the focus and blur events on this element. Tracked elements are listed in elements.
- If a View instance is passed that has a FocusTracker instance (ViewWithFocusTracker), the external focus tracker's state (isFocused, focusedElement) starts contributing to the current tracker instance. This allows for increasing the "reach" of a focus tracker instance, by connecting two or more focus trackers together when DOM elements they track are located in different subtrees in DOM. External focus trackers are listed in externalViews.
- If a View instance is passed that has no FocusTracker (not a ViewWithFocusTracker), its element is used to track focus like any other DOM element.
Parameters

elementOrView : Element | View<HTMLElement>

Returns

void
inherited
bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, FocusTracker[ K1 ], K2, FocusTracker[ K2 ]>
See source
Binds observable properties to other objects implementing the Observable interface.

Read more in the dedicated guide covering the topic of property bindings with some additional examples.

Consider two objects: a button and an associated command (both Observable).

A simple property binding could be as follows:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
which works in the following way:
- button.isEnabled instantly equals command.isEnabled,
- whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.
Note: To release the binding, use unbind.

You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Type parameters

K1

K2

Parameters

bindProperty1 : K1

Observable property that will be bound to other observable(s).

bindProperty2 : K2

Observable property that will be bound to other observable(s).

Returns

DualBindChain<K1, FocusTracker[ K1 ], K2, FocusTracker[ K2 ]>

The bind chain with the to() and toMany() methods.
inherited
bind( bindProperties ) → MultiBindChain
See source
Binds observable properties to other objects implementing the Observable interface.

Read more in the dedicated guide covering the topic of property bindings with some additional examples.

Consider two objects: a button and an associated command (both Observable).

A simple property binding could be as follows:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
which works in the following way:
- button.isEnabled instantly equals command.isEnabled,
- whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.
Note: To release the binding, use unbind.

You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Parameters

bindProperties : Array<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'remove' | 'add' | 'destroy' | 'isFocused' | 'focusedElement' | '_elements' | '_externalViews' | 'elements' | 'externalViews'>

Observable properties that will be bound to other observable(s).

Returns

MultiBindChain

The bind chain with the to() and toMany() methods.
inherited
bind( bindProperty ) → SingleBindChain<K, FocusTracker[ K ]>
See source
Binds observable properties to other objects implementing the Observable interface.

Read more in the dedicated guide covering the topic of property bindings with some additional examples.

Consider two objects: a button and an associated command (both Observable).

A simple property binding could be as follows:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
which works in the following way:
- button.isEnabled instantly equals command.isEnabled,
- whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.
Note: To release the binding, use unbind.

You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Type parameters

K

Parameters

bindProperty : K

Observable property that will be bound to other observable(s).

Returns

SingleBindChain<K, FocusTracker[ K ]>

The bind chain with the to() and toMany() methods.
inherited
decorate( methodName ) → void
See source
Turns the given methods of this object into event-based ones. This means that the new method will fire an event (named after the method) and the original action will be plugged as a listener to that event.

Read more in the dedicated guide covering the topic of decorating methods with some additional examples.

Decorating the method does not change its behavior (it only adds an event), but it allows to modify it later on by listening to the method's event.

For example, to cancel the method execution the event can be stopped:
```
class Foo extends ObservableMixin() {
	constructor() {
		super();
		this.decorate( 'method' );
	}

	method() {
		console.log( 'called!' );
	}
}

const foo = new Foo();
foo.on( 'method', ( evt ) => {
	evt.stop();
}, { priority: 'high' } );

foo.method(); // Nothing is logged.
```
Note: The high priority listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).

It is also possible to change the returned value:
```
foo.on( 'method', ( evt ) => {
	evt.return = 'Foo!';
} );

foo.method(); // -> 'Foo'
```
Finally, it is possible to access and modify the arguments the method is called with:
```
method( a, b ) {
	console.log( `${ a }, ${ b }`  );
}

// ...

foo.on( 'method', ( evt, args ) => {
	args[ 0 ] = 3;

	console.log( args[ 1 ] ); // -> 2
}, { priority: 'high' } );

foo.method( 1, 2 ); // -> '3, 2'
```
Parameters

methodName : 'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'remove' | 'add' | 'destroy' | 'isFocused' | 'focusedElement' | '_elements' | '_externalViews' | 'elements' | 'externalViews'

Name of the method to decorate.

Returns

void
inherited
delegate( events ) → EmitterMixinDelegateChain
See source
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
destroy() → void
See source
Destroys the focus tracker by:
- Disabling all event listeners attached to tracked elements or external views.
- Removing all tracked elements and views that were previously added.
Returns

void
inherited
fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]

See source
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).
inherited
listenTo( emitter, event, callback, [ options ] ) → void
See source
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 ] : CallbackOptions

Additional options.

Returns

void
inherited
listenTo( emitter, event, callback, [ options ] ) → void
See source
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
inherited
listenTo( emitter, event, callback, [ options ] ) → void

See source
Registers a callback function to be executed when an event is fired in a specific Emitter or DOM Node. It is backwards compatible with listenTo.

Type parameters

K : extends keyof DomEventMap

Parameters

emitter : Window | Node

The object that fires the event.

event : K

The name of the event.

callback : ( FocusTracker, EventInfo<string, unknown>, DomEventMap[ K ] ) => void

The function to be called on event.

[ options ] : object

Additional options.

Returns

void
inherited
off( event, callback ) → void

See source
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
inherited
on( event, callback, [ options ] ) → void

See source
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
inherited
once( event, callback, [ options ] ) → void

See source
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
remove( elementOrView ) → void

See source
Stops tracking focus in the specified DOM element or a view instance. See add to learn more.

Parameters

elementOrView : Element | View<HTMLElement>

Returns

void
inherited
set( values ) → void
See source
Creates and sets the value of an observable properties of this object. Such a property becomes a part of the state and is observable.

It accepts a single object literal containing key/value pairs with properties to be set.

This method throws the observable-set-cannot-override error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.

In TypeScript, those properties should be declared in class using declare keyword. In example:
```
public declare myProp1: number;
public declare myProp2: string;

constructor() {
	this.set( {
		'myProp1: 2,
		'myProp2: 'foo'
	} );
}
```
Parameters

values : object

An object with name=>value pairs.

Returns

void
inherited
set( name, value ) → void
See source
Creates and sets the value of an observable property of this object. Such a property becomes a part of the state and is observable.

This method throws the observable-set-cannot-override error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.

In TypeScript, those properties should be declared in class using declare keyword. In example:
```
public declare myProp: number;

constructor() {
	this.set( 'myProp', 2 );
}
```
Type parameters

K

Parameters

name : K

The property's name.

value : FocusTracker[ K ]

The property's value.

Returns

void
inherited
stopDelegating( [ event ], [ emitter ] ) → void
See source
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
inherited
stopListening( [ emitter ], [ event ], [ callback ] ) → void
See source
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
inherited
stopListening( [ emitter ], [ event ], [ callback ] ) → void
See source
Stops listening for events. It can be used at different levels: It is backwards compatible with listenTo.
- 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 ] : Window | Node | 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
inherited
unbind( unbindProperties ) → void
See source
Removes the binding created with bind.
```
// Removes the binding for the 'a' property.
A.unbind( 'a' );

// Removes bindings for all properties.
A.unbind();
```
Parameters

unbindProperties : Array<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'remove' | 'add' | 'destroy' | 'isFocused' | 'focusedElement' | '_elements' | '_externalViews' | 'elements' | 'externalViews'>

Observable properties to be unbound. All the bindings will be released if no properties are provided.

Returns

void
private
_addElement( element ) → void

See source
Adds a DOM element to the focus tracker and starts listening to the focus and blur events on it.

Parameters

element : Element

Returns

void
private
_addView( view ) → void

See source
Adds an external view instance to this focus tracker and makes it contribute to this focus tracker's state either by its View#element or by its View#focusTracker instance.

Parameters

view : ViewWithFocusTracker

Returns

void
private
_blur() → void

See source
Clears currently focusedElement and sets isFocused false.

This method uses setTimeout() to change order of blur and focus events calls, ensuring that moving focus between two elements within a single focus tracker's scope, will not cause [ blurA, focusB ] sequence but just [ focusB ]. The former would cause a momentary change of #isFocused to false which is not desired because any logic listening to a focus tracker state would experience UI flashes and glitches as the user focus travels across the UI.

Returns

void
private
_clearBlurTimeout() → void

See source
Clears the asynchronous blur event timeout on demand. See _blur to learn more.

Returns

void
private
_focus( element ) → void

See source
Stores currently focused element as focusedElement and sets isFocused true.

Parameters

element : Element

Returns

void
private
_removeElement( element ) → void

See source
Removes a DOM element from the focus tracker.

Parameters

element : Element

Returns

void
private
_removeView( view ) → void

See source
Removes an external view instance from this focus tracker.

Parameters

view : ViewWithFocusTracker

Returns

void

Events

change:focusedElement( eventInfo, name, value, oldValue )

See source
Fired when the focusedElement property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (focusedElement).

value : null | Element

New value of the focusedElement property with given key or null, if operation should remove property.

oldValue : null | Element

Old value of the focusedElement property with given key or null, if property was not set before.
change:isFocused( eventInfo, name, value, oldValue )

See source
Fired when the isFocused property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isFocused).

value : boolean

New value of the isFocused property with given key or null, if operation should remove property.

oldValue : boolean

Old value of the isFocused property with given key or null, if property was not set before.
inherited
change:{property}( eventInfo, name, value, oldValue )
See source
Fired when a property changed value.
```
observable.set( 'prop', 1 );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `${ propertyName } has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'prop has changed from 1 to 2'
```
Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

The property name.

value : TValue

The new property value.

oldValue : TValue

The previous property value.
set:focusedElement( eventInfo, name, value, oldValue )

See source
Fired when the focusedElement property is going to be set but is not set yet (before the change event is fired).

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (focusedElement).

value : null | Element

New value of the focusedElement property with given key or null, if operation should remove property.

oldValue : null | Element

Old value of the focusedElement property with given key or null, if property was not set before.
set:isFocused( eventInfo, name, value, oldValue )

See source
Fired when the isFocused property is going to be set but is not set yet (before the change event is fired).

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isFocused).

value : boolean

New value of the isFocused property with given key or null, if operation should remove property.

oldValue : boolean

Old value of the isFocused property with given key or null, if property was not set before.
inherited
set:{property}( eventInfo, name, value, oldValue )
See source
Fired when a property value is going to be set but is not set yet (before the change event is fired).

You can control the final value of the property by using the event's return property.
```
observable.set( 'prop', 1 );

observable.on<ObservableSetEvent<number>>( 'set:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value is going to be changed from ${ oldValue } to ${ newValue }` );
	console.log( `Current property value is ${ observable[ propertyName ] }` );

	// Let's override the value.
	evt.return = 3;
} );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'Value is going to be changed from 1 to 2'
                     // -> 'Current property value is 1'
                     // -> 'Value has changed from 1 to 3'
```
Note: The event is fired even when the new value is the same as the old value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

The property name.

value : TValue

The new property value.

oldValue : TValue

The previous property value.

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.

With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.

FocusTracker (utils)

Filtering

Properties

readonly elements : Array<Element>module:utils/focustracker~FocusTracker#elements

readonly externalViews : Array<ViewWithFocusTracker>module:utils/focustracker~FocusTracker#externalViews

observable focusedElement : null | Elementmodule:utils/focustracker~FocusTracker#focusedElement

observable isFocused : booleanmodule:utils/focustracker~FocusTracker#isFocused

internal _elements : Set<Element>module:utils/focustracker~FocusTracker#_elements

internal _externalViews : Set<ViewWithFocusTracker>module:utils/focustracker~FocusTracker#_externalViews

private _blurTimeout : null | Timeoutmodule:utils/focustracker~FocusTracker#_blurTimeout

Methods

constructor()module:utils/focustracker~FocusTracker#constructor

add( elementOrView ) → voidmodule:utils/focustracker~FocusTracker#add

Parameters

Returns

inherited bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, FocusTracker[ K1 ], K2, FocusTracker[ K2 ]>module:utils/focustracker~FocusTracker#bind:DUAL_BIND

Type parameters

Parameters

Returns

inherited bind( bindProperties ) → MultiBindChainmodule:utils/focustracker~FocusTracker#bind:MANY_BIND

Parameters

Returns

inherited bind( bindProperty ) → SingleBindChain<K, FocusTracker[ K ]>module:utils/focustracker~FocusTracker#bind:SINGLE_BIND

Type parameters

Parameters

Returns

inherited decorate( methodName ) → voidmodule:utils/focustracker~FocusTracker#decorate

Parameters

Returns

inherited delegate( events ) → EmitterMixinDelegateChainmodule:utils/focustracker~FocusTracker#delegate

Parameters

Returns

destroy() → voidmodule:utils/focustracker~FocusTracker#destroy

Returns

inherited fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]module:utils/focustracker~FocusTracker#fire

Type parameters

Parameters

Returns

inherited listenTo( emitter, event, callback, [ options ] ) → voidmodule:utils/focustracker~FocusTracker#listenTo:DOM_EMITTER

Type parameters

Parameters

Returns

inherited listenTo( emitter, event, callback, [ options ] ) → voidmodule:utils/focustracker~FocusTracker#listenTo:BASE_EMITTER

Type parameters

Parameters

Returns

inherited listenTo( emitter, event, callback, [ options ] ) → voidmodule:utils/focustracker~FocusTracker#listenTo:HTML_EMITTER

Type parameters

Parameters

Returns

inherited off( event, callback ) → voidmodule:utils/focustracker~FocusTracker#off

Parameters

Returns

inherited on( event, callback, [ options ] ) → voidmodule:utils/focustracker~FocusTracker#on

Type parameters

Parameters

Returns

inherited once( event, callback, [ options ] ) → voidmodule:utils/focustracker~FocusTracker#once

Type parameters

Parameters

Returns

remove( elementOrView ) → voidmodule:utils/focustracker~FocusTracker#remove

Parameters

Returns

inherited set( values ) → voidmodule:utils/focustracker~FocusTracker#set:OBJECT

Parameters

Returns

inherited set( name, value ) → voidmodule:utils/focustracker~FocusTracker#set:KEY_VALUE

Type parameters

Parameters

Returns

inherited stopDelegating( [ event ], [ emitter ] ) → voidmodule:utils/focustracker~FocusTracker#stopDelegating

Parameters

Returns

inherited stopListening( [ emitter ], [ event ], [ callback ] ) → voidmodule:utils/focustracker~FocusTracker#stopListening:BASE_STOP

Parameters

Returns

inherited stopListening( [ emitter ], [ event ], [ callback ] ) → voidmodule:utils/focustracker~FocusTracker#stopListening:DOM_STOP

Parameters

Returns

readonly
`elements : Array<Element>`

readonly
`externalViews : Array<ViewWithFocusTracker>`

observable
`focusedElement : null | Element`

observable
`isFocused : boolean`

internal
`_elements : Set<Element>`

internal
`_externalViews : Set<ViewWithFocusTracker>`

private
`_blurTimeout : null | Timeout`

`constructor()`

`add( elementOrView ) → void`

inherited
`bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, FocusTracker[ K1 ], K2, FocusTracker[ K2 ]>`

inherited
`bind( bindProperties ) → MultiBindChain`

inherited
`bind( bindProperty ) → SingleBindChain<K, FocusTracker[ K ]>`

inherited
`decorate( methodName ) → void`

inherited
`delegate( events ) → EmitterMixinDelegateChain`

`destroy() → void`

inherited
`fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]`

inherited
`listenTo( emitter, event, callback, [ options ] ) → void`

inherited
`listenTo( emitter, event, callback, [ options ] ) → void`

inherited
`listenTo( emitter, event, callback, [ options ] ) → void`

inherited
`off( event, callback ) → void`

inherited
`on( event, callback, [ options ] ) → void`

inherited
`once( event, callback, [ options ] ) → void`

`remove( elementOrView ) → void`

inherited
`set( values ) → void`

inherited
`set( name, value ) → void`

inherited
`stopDelegating( [ event ], [ emitter ] ) → void`

inherited
`stopListening( [ emitter ], [ event ], [ callback ] ) → void`

inherited
`stopListening( [ emitter ], [ event ], [ callback ] ) → void`

inherited
`unbind( unbindProperties ) → void`

private
`_addElement( element ) → void`

private
`_addView( view ) → void`

private
`_blur() → void`

private
`_clearBlurTimeout() → void`

private
`_focus( element ) → void`

private
`_removeElement( element ) → void`

private
`_removeView( view ) → void`

`change:focusedElement( eventInfo, name, value, oldValue )`

`change:isFocused( eventInfo, name, value, oldValue )`

inherited
`change:{property}( eventInfo, name, value, oldValue )`

`set:focusedElement( eventInfo, name, value, oldValue )`

`set:isFocused( eventInfo, name, value, oldValue )`

inherited
`set:{property}( eventInfo, name, value, oldValue )`