MentionsView

class

The mention ui view.

See source

Properties

ariaLabel : undefined | string
inheritedobservable

Label used by assistive technologies to describe this list element.

See source (with github icon)
ariaLabelledBy : string | undefined
inheritedobservable

(Optional) The ARIA property reflected by the aria-ariaLabelledBy DOM attribute used by assistive technologies.

See source (with github icon)

`bindTemplate : BindChain<this>`
readonlyinherited

module:mention/ui/mentionsview~MentionsView#bindTemplate

Shorthand for bind, a binding interface pre–configured for the view instance.

It provides to() and if() methods that initialize bindings with observable attributes and attach DOM listeners.

class SampleView extends View {
	constructor( locale ) {
		super( locale );

		const bind = this.bindTemplate;

		// These observable attributes will control
		// the state of the view in DOM.
		this.set( {
			elementClass: 'foo',
		 	isEnabled: true
		 } );

		this.setTemplate( {
			tag: 'p',

			attributes: {
				// The class HTML attribute will follow elementClass
				// and isEnabled view attributes.
				class: [
					bind.to( 'elementClass' )
					bind.if( 'isEnabled', 'present-when-enabled' )
				]
			},

			on: {
				// The view will fire the "clicked" event upon clicking <p> in DOM.
				click: bind.to( 'clicked' )
			}
		} );
	}
}

See source

`element : null | HTMLUListElement`
inherited

module:mention/ui/mentionsview~MentionsView#element

An HTML element of the view. null until rendered from the template.

class SampleView extends View {
	constructor() {
		super();

		// A template instance the #element will be created from.
		this.setTemplate( {
			tag: 'p'

			// ...
		} );
	}
}

const view = new SampleView();

// Renders the #template.
view.render();

// Append the HTML element of the view to <body>.
document.body.appendChild( view.element );

Note: The element of the view can also be assigned directly:

class SampleView extends View {
	constructor() {
		super();

		// A template instance the #element will be created from.
		this.setTemplate( {
			tag: 'p'

			// ...
		} );
	}
}

const view = new SampleView();

// Renders the #template.
view.render();

// Append the HTML element of the view to <body>.
document.body.appendChild( view.element );

See source

focusTracker : FocusTracker
readonlyinherited

Tracks information about DOM focus in the list.

See source (with github icon)
focusables : ViewCollection<FocusableView>
readonlyinherited

The collection of focusable views in the list. It is used to determine accessible navigation between the list items and list groups.

See source (with github icon)
isRendered : boolean
readonlyinherited

Set true when the view has already been rendered.

See source (with github icon)
items : ViewCollection<ListItemView | ListSeparatorView | ListItemGroupView>
readonlyinherited

Collection of the child list views.

See source (with github icon)
keystrokes : KeystrokeHandler
readonlyinherited

Instance of the KeystrokeHandler.

See source (with github icon)
locale : undefined | Locale
readonlyinherited

A set of tools to localize the user interface.

Also see locale.

See source (with github icon)
position : undefined | string

See source (with github icon)
role : undefined | string
inheritedobservable

The property reflected by the role DOM attribute to be used by assistive technologies.

See source (with github icon)
selected : undefined | MentionListItemView

See source (with github icon)
t : undefined | LocaleTranslate
inherited

module:mention/ui/mentionsview~MentionsView#t
Shorthand for t.

Note: If locale instance hasn't been passed to the view this method may not be available.

See source (with github icon)

Related:
- Locale#t
template : Template | undefined
inherited

Template of this view. It provides the element representing the view in DOM, which is rendered.

See source (with github icon)
viewUid : string | undefined
inherited

See source (with github icon)
_unboundChildren : ViewCollection
protectedinherited

A collection of view instances, which have been added directly into the children.

See source (with github icon)
_viewCollections : Collection<ViewCollection<View<HTMLElement>>>
protectedinherited

Collections registered with createCollection.

See source (with github icon)

Methods

constructor( locale )

See source (with github icon)

Parameters

locale : Locale
bind( bindProperties ) → ObservableMultiBindChain
inherited

module:mention/ui/mentionsview~MentionsView#bind:MANY_BIND
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' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
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, 'isEnabled' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
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' ).to( command, 'isEnabled' );
```
Copy code
See source (with github icon)

Parameters

bindProperties : Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'element' | 'select' | 'template' | 'focus' | 'ariaLabel' | 'role' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'position' | 'items' | 'focusFirst' | 'focusLast' | 'focusTracker' | 'ariaLabelledBy' | 'keystrokes' | 'focusables' | 'selected' | 'selectFirst' | 'selectNext' | 'selectPrevious' | 'executeSelected'>

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

Returns

ObservableMultiBindChain

The bind chain with the to() and toMany() methods.
bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, MentionsView[ K1 ], K2, MentionsView[ K2 ]>
inherited

module:mention/ui/mentionsview~MentionsView#bind:DUAL_BIND
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' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
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, 'isEnabled' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
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' ).to( command, 'isEnabled' );
```
Copy code
See source (with github icon)

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

ObservableDualBindChain<K1, MentionsView[ K1 ], K2, MentionsView[ K2 ]>

The bind chain with the to() and toMany() methods.
bind( bindProperty ) → ObservableSingleBindChain<K, MentionsView[ K ]>
inherited

module:mention/ui/mentionsview~MentionsView#bind:SINGLE_BIND
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' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
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, 'isEnabled' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
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' ).to( command, 'isEnabled' );
```
Copy code
See source (with github icon)

Type parameters

K

Parameters

bindProperty : K

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

Returns

ObservableSingleBindChain<K, MentionsView[ K ]>

The bind chain with the to() and toMany() methods.
createCollection( [ views ] ) → ViewCollection<T>
inherited

module:mention/ui/mentionsview~MentionsView#createCollection
Creates a new collection of views, which can be used as children of this view.
```
class SampleView extends View {
	constructor( locale ) {
		super( locale );

		const child = new ChildView( locale );
		this.items = this.createCollection( [ child ] );
 *
		this.setTemplate( {
			tag: 'p',

			// `items` collection will render here.
			children: this.items
		} );
	}
}

const view = new SampleView( locale );
view.render();

// It will append <p><child#element></p> to the <body>.
document.body.appendChild( view.element );
```
Copy code
See source (with github icon)

Type parameters

T : extends [object Object] = View

Parameters

[ views ] : Iterable<T>

Initial views of the collection.

Returns

ViewCollection<T>

A new collection of view instances.
decorate( methodName ) → void
inherited

module:mention/ui/mentionsview~MentionsView#decorate
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.
```
Copy code
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:
```
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.
```
Copy code
Finally, it is possible to access and modify the arguments the method is called with:
```
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.
```
Copy code
See source (with github icon)

Parameters

methodName : 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'element' | 'select' | 'template' | 'focus' | 'ariaLabel' | 'role' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'position' | 'items' | 'focusFirst' | 'focusLast' | 'focusTracker' | 'ariaLabelledBy' | 'keystrokes' | 'focusables' | 'selected' | 'selectFirst' | 'selectNext' | 'selectPrevious' | 'executeSelected'

Name of the method to decorate.

Returns

void
delegate( events ) → EmitterMixinDelegateChain
inherited

module:mention/ui/mentionsview~MentionsView#delegate
Delegates selected events to another Emitter. For instance:
```
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```
Copy code
then eventX is delegated (fired by) emitterB and emitterC along with data:
```
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```
Copy code
and eventY is delegated (fired by) emitterC along with data:
```
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```
Copy code
See source (with github icon)

Parameters

events : Array<string>

Event names that will be delegated to another emitter.

Returns

EmitterMixinDelegateChain
deregisterChild( children ) → void
inherited

module:mention/ui/mentionsview~MentionsView#deregisterChild
The opposite of registerChild. Removes a child view from this view instance. Once removed, the child is no longer managed by its parent, e.g. it can safely become a child of another parent view.

See source (with github icon)

Parameters

children : View<HTMLElement> | Iterable<View<HTMLElement>>

Child views to be removed.

Returns

void

Related:
- MentionsView#registerChild
destroy() → void
inherited

module:mention/ui/mentionsview~MentionsView#destroy
Recursively destroys the view instance and child views added by registerChild and residing in collections created by the createCollection.

Destruction disables all event listeners:
- created on the view, e.g. view.on( 'event', () => {} ),
- defined in the template for DOM events.
See source (with github icon)

Returns

void
executeSelected() → void

Triggers the execute event on the selected item.

See source (with github icon)

Returns

void
extendTemplate( definition ) → void
inherited

module:mention/ui/mentionsview~MentionsView#extendTemplate
Extends the template of the view with with given definition.

A shorthand for:
```
Template.extend( view.template, definition );
```
Copy code
Note: Is requires the template to be already set. See setTemplate.

See source (with github icon)

Parameters

definition : Partial<TemplateDefinition>

Definition which extends the template.

Returns

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

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.

See source (with github icon)

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).
focus() → void
inherited

Focuses the first focusable in items.

See source (with github icon)

Returns

void
focusFirst() → void
inherited

Focuses the first focusable in items.

See source (with github icon)

Returns

void
focusLast() → void
inherited

Focuses the last focusable in items.

See source (with github icon)

Returns

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

module:mention/ui/mentionsview~MentionsView#listenTo:DOM_EMITTER
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' );
```
Copy code
An event callback can stop the event and set the return value of the fire method.

See source (with github icon)

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

module:mention/ui/mentionsview~MentionsView#listenTo:BASE_EMITTER
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' );
```
Copy code
An event callback can stop the event and set the return value of the fire method.

See source (with github icon)

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

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.

See source (with github icon)

Type parameters

K : extends keyof DomEventMap

Parameters

emitter : Window | EventTarget | Node

The object that fires the event.

event : K

The name of the event.

callback : ( this: this, ev: EventInfo, event: DomEventMap[ K ] ) => void

The function to be called on event.

[ options ] : object

Additional options.

Returns

void
off( event, callback ) → void
inherited

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

See source (with github icon)

Parameters

event : string

The name of the event.

callback : Function

The function to stop being called.

Returns

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

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).

See source (with github icon)

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

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.

See source (with github icon)

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

`registerChild( children ) → void`
inherited

module:mention/ui/mentionsview~MentionsView#registerChild

Registers a new child view under the view instance. Once registered, a child view is managed by its parent, including rendering and destruction.

To revert this, use deregisterChild.

class SampleView extends View {
	constructor( locale ) {
		super( locale );

		this.childA = new SomeChildView( locale );
		this.childB = new SomeChildView( locale );

		this.setTemplate( { tag: 'p' } );

		// Register the children.
		this.registerChild( [ this.childA, this.childB ] );
	}

	render() {
		super.render();

		this.element.appendChild( this.childA.element );
		this.element.appendChild( this.childB.element );
	}
}

const view = new SampleView( locale );

view.render();

// Will append <p><childA#element><b></b><childB#element></p>.
document.body.appendChild( view.element );

Note: There's no need to add child views if they're already referenced in the template:

class SampleView extends View {
	constructor( locale ) {
		super( locale );

		this.childA = new SomeChildView( locale );
		this.childB = new SomeChildView( locale );

		this.setTemplate( { tag: 'p' } );

		// Register the children.
		this.registerChild( [ this.childA, this.childB ] );
	}

	render() {
		super.render();

		this.element.appendChild( this.childA.element );
		this.element.appendChild( this.childB.element );
	}
}

const view = new SampleView( locale );

view.render();

// Will append <p><childA#element><b></b><childB#element></p>.
document.body.appendChild( view.element );

See source

Parameters

children : View<HTMLElement> | Iterable<View<HTMLElement>>: Children views to be registered.

Returns

void

render() → void
inherited

module:mention/ui/mentionsview~MentionsView#render
Recursively renders the view.

Once the view is rendered:
- the element becomes an HTML element out of template,
- the isRendered flag is set true.
Note: The children of the view:
- defined directly in the template
- residing in collections created by the createCollection method,
- and added by registerChild are also rendered in the process.
In general, render() method is the right place to keep the code which refers to the element and should be executed at the very beginning of the view's life cycle.

It is possible to extend the template before the view is rendered. To allow an early customization of the view (e.g. by its parent), such references should be done in render().
```
class SampleView extends View {
	constructor() {
		this.setTemplate( {
			// ...
		} );
	},

	render() {
		// View#element becomes available.
		super.render();

		// The "scroll" listener depends on #element.
		this.listenTo( window, 'scroll', () => {
			// A reference to #element would render the #template and make it non-extendable.
			if ( window.scrollY > 0 ) {
				this.element.scrollLeft = 100;
			} else {
				this.element.scrollLeft = 0;
			}
		} );
	}
}

const view = new SampleView();

// Let's customize the view before it gets rendered.
view.extendTemplate( {
	attributes: {
		class: [
			'additional-class'
		]
	}
} );

// Late rendering allows customization of the view.
view.render();
```
Copy code
See source (with github icon)

Returns

void
select( index ) → void

module:mention/ui/mentionsview~MentionsView#select
Marks item at a given index as selected.

Handles selection cycling when passed index is out of bounds:
- if the index is lower than 0, it will select the last item,
- if the index is higher than the last item index, it will select the first item.
See source (with github icon)

Parameters

index : number

Index of an item to be marked as selected.

Returns

void
selectFirst() → void

Selects the first item.

See source (with github icon)

Returns

void
selectNext() → void

Selects next item to the currently selected.

If the last item is already selected, it will select the first item.

See source (with github icon)

Returns

void
selectPrevious() → void

Selects previous item to the currently selected.

If the first item is already selected, it will select the last item.

See source (with github icon)

Returns

void
set( values ) → void
inherited

module:mention/ui/mentionsview~MentionsView#set:OBJECT
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'
	} );
}
```
Copy code
See source (with github icon)

Parameters

values : object

An object with name=>value pairs.

Returns

void
set( name, value ) → void
inherited

module:mention/ui/mentionsview~MentionsView#set:KEY_VALUE
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 );
}
```
Copy code
See source (with github icon)

Type parameters

K

Parameters

name : K

The property's name.

value : MentionsView[ K ]

The property's value.

Returns

void
setTemplate( definition ) → void
inherited

module:mention/ui/mentionsview~MentionsView#setTemplate
Sets the template of the view with with given definition.

A shorthand for:
```
view.setTemplate( definition );
```
Copy code
See source (with github icon)

Parameters

definition : TemplateDefinition

Definition of view's template.

Returns

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

module:mention/ui/mentionsview~MentionsView#stopDelegating
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.
See source (with github icon)

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
stopListening( [ emitter ], [ event ], [ callback ] ) → void
inherited

module:mention/ui/mentionsview~MentionsView#stopListening:BASE_STOP
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.
See source (with github icon)

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
stopListening( [ emitter ], [ event ], [ callback ] ) → void
inherited

module:mention/ui/mentionsview~MentionsView#stopListening:DOM_STOP
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.
See source (with github icon)

Parameters

[ emitter ] : Window | EventTarget | 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
unbind( unbindProperties ) → void
inherited

module:mention/ui/mentionsview~MentionsView#unbind
Removes the binding created with bind.
```
// Removes the binding for the 'a' property.
A.unbind( 'a' );

// Removes bindings for all properties.
A.unbind();
```
Copy code
See source (with github icon)

Parameters

unbindProperties : Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'element' | 'select' | 'template' | 'focus' | 'ariaLabel' | 'role' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'position' | 'items' | 'focusFirst' | 'focusLast' | 'focusTracker' | 'ariaLabelledBy' | 'keystrokes' | 'focusables' | 'selected' | 'selectFirst' | 'selectNext' | 'selectPrevious' | 'executeSelected'>

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

Returns

void
_isItemVisibleInScrolledArea( item ) → boolean
private

module:mention/ui/mentionsview~MentionsView#_isItemVisibleInScrolledArea
Checks if an item is visible in the scrollable area.

The item is considered visible when:
- its top boundary is inside the scrollable rect
- its bottom boundary is inside the scrollable rect (the whole item must be visible)
See source (with github icon)

Parameters

item : MentionListItemView

Returns

boolean

Events

change:ariaLabel( eventInfo, name, value, oldValue )
inherited

Fired when the ariaLabel property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (ariaLabel).

value : undefined | string

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

oldValue : undefined | string

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

Fired when the ariaLabelledBy property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (ariaLabelledBy).

value : string

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

oldValue : string

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

Fired when the role property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (role).

value : undefined | string

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

oldValue : undefined | string

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

module:mention/ui/mentionsview~MentionsView#event:change:{property}
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'
```
Copy code
See source (with github icon)

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.
render( eventInfo, <anonymous> )
inherited

Event fired by the render method. Actual rendering is executed as a listener to this event with the default priority.

See decorate for more information and samples.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

<anonymous> : Parameters<TObservable[ TName ]>
set:ariaLabel( eventInfo, name, value, oldValue )
inherited

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (ariaLabel).

value : undefined | string

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

oldValue : undefined | string

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

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (ariaLabelledBy).

value : string

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

oldValue : string

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

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (role).

value : undefined | string

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

oldValue : undefined | string

Old value of the role property with given key or null, if property was not set before.
set:{property}( eventInfo, name, value, oldValue )
inherited

module:mention/ui/mentionsview~MentionsView#event:set:{property}
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'
```
Copy code
Note: The event is fired even when the new value is the same as the old value.

See source (with github icon)

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.
submit( eventInfo )
inherited

Fired by submitHandler helper.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

MentionsView

Properties

ariaLabel : undefined | string inherited Eye icon observable

ariaLabelledBy : string | undefined inherited Eye icon observable

bindTemplate : BindChain<this> readonlyinherited

element : null | HTMLUListElement inherited

focusTracker : FocusTracker readonlyinherited

focusables : ViewCollection<FocusableView> readonlyinherited

isRendered : boolean readonlyinherited

items : ViewCollection<ListItemView | ListSeparatorView | ListItemGroupView> readonlyinherited

keystrokes : KeystrokeHandler readonlyinherited

locale : undefined | Locale readonlyinherited

position : undefined | string

role : undefined | string inherited Eye icon observable

selected : undefined | MentionListItemView

t : undefined | LocaleTranslate inherited

Related:

template : Template | undefined inherited

viewUid : string | undefined inherited

_unboundChildren : ViewCollection protectedinherited

_viewCollections : Collection<ViewCollection<View<HTMLElement>>> protectedinherited

Methods

constructor( locale )

Parameters

bind( bindProperties ) → ObservableMultiBindChain inherited

Parameters

Returns

bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, MentionsView[ K1 ], K2, MentionsView[ K2 ]> inherited

Type parameters

Parameters

Returns

bind( bindProperty ) → ObservableSingleBindChain<K, MentionsView[ K ]> inherited

Type parameters

Parameters

Returns

createCollection( [ views ] ) → ViewCollection<T> inherited

Type parameters

Parameters

Returns

decorate( methodName ) → void inherited

Parameters

Returns

delegate( events ) → EmitterMixinDelegateChain inherited

Parameters

Returns

deregisterChild( children ) → void inherited

Parameters

Returns

Related:

destroy() → void inherited

Returns

executeSelected() → void

Returns

extendTemplate( definition ) → void inherited

Parameters

Returns

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

Type parameters

Parameters

Returns

focus() → void inherited

Returns

focusFirst() → void inherited

Returns

focusLast() → void inherited

Returns

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

Type parameters

Parameters

Returns

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

Type parameters

Parameters

Returns

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

Type parameters

Parameters

Returns

off( event, callback ) → void inherited

Parameters

`ariaLabel : undefined | string`
inheritedobservable

`ariaLabelledBy : string | undefined`
inheritedobservable

`bindTemplate : BindChain<this>`
readonlyinherited

`element : null | HTMLUListElement`
inherited

`focusTracker : FocusTracker`
readonlyinherited

`focusables : ViewCollection<FocusableView>`
readonlyinherited

`isRendered : boolean`
readonlyinherited

`items : ViewCollection<ListItemView | ListSeparatorView | ListItemGroupView>`
readonlyinherited

`keystrokes : KeystrokeHandler`
readonlyinherited

`locale : undefined | Locale`
readonlyinherited

`position : undefined | string`

`role : undefined | string`
inheritedobservable

`selected : undefined | MentionListItemView`

`t : undefined | LocaleTranslate`
inherited

`template : Template | undefined`
inherited

`viewUid : string | undefined`
inherited

`_unboundChildren : ViewCollection`
protectedinherited

`_viewCollections : Collection<ViewCollection<View<HTMLElement>>>`
protectedinherited

`constructor( locale )`

`bind( bindProperties ) → ObservableMultiBindChain`
inherited

`bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, MentionsView[ K1 ], K2, MentionsView[ K2 ]>`
inherited

`bind( bindProperty ) → ObservableSingleBindChain<K, MentionsView[ K ]>`
inherited

`createCollection( [ views ] ) → ViewCollection<T>`
inherited

`decorate( methodName ) → void`
inherited

`delegate( events ) → EmitterMixinDelegateChain`
inherited

`deregisterChild( children ) → void`
inherited

`destroy() → void`
inherited

`executeSelected() → void`

`extendTemplate( definition ) → void`
inherited

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

`focus() → void`
inherited

`focusFirst() → void`
inherited

`focusLast() → void`
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`
inherited

`registerChild( children ) → void`
inherited

`render() → void`
inherited

`select( index ) → void`

`selectFirst() → void`

`selectNext() → void`

`selectPrevious() → void`

`set( values ) → void`
inherited

`set( name, value ) → void`
inherited

`setTemplate( definition ) → void`
inherited

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

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

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

`unbind( unbindProperties ) → void`
inherited

`_isItemVisibleInScrolledArea( item ) → boolean`
private

`change:ariaLabel( eventInfo, name, value, oldValue )`
inherited

`change:ariaLabelledBy( eventInfo, name, value, oldValue )`
inherited

`change:role( eventInfo, name, value, oldValue )`
inherited

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

`render( eventInfo, <anonymous> )`
inherited

`set:ariaLabel( eventInfo, name, value, oldValue )`
inherited

`set:ariaLabelledBy( eventInfo, name, value, oldValue )`
inherited

`set:role( eventInfo, name, value, oldValue )`
inherited

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

`submit( eventInfo )`
inherited