BaseSuggestionThreadView

class

An abstract suggestion thread view class that should be used as a base for suggestion thread view implementations. It provides some behaviors, flags and building blocks to use when creating a custom suggestion thread view class.

All events fired by BaseCommentView are delegated to BaseSuggestionThreadView. This means that BaseSuggestionThreadView can also fire these events to communicate with CKEditor 5 collaboration features.

For the usage examples check the Annotations custom view guide.

Properties

ariaDescriptionView : AriaDescriptionView
readonly

A helper view that provides an ARIA description for the comment thread used by assistive technologies.
ariaLabel : string

An accessible thread label text exposed to assistive technologies.
authoredAt : null | Date
observable

Suggestion creation date.

`bindTemplate : BindChain<this>`
readonlyinherited

module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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' )
			}
		} );
	}
}

canAccept : boolean
observable

Flag that indicates whether suggestion acceptation is possible.
canDiscard : boolean
observable

Flag that indicates whether suggestion discarding is possible.
commentThreadInputView : null | CommentThreadInputView

The comment input area view. It should be used as a part of the view template when present.
commentsListView : null | CommentsListView

The list of comment views. It should be used as a part of the view template when present.
descriptionParts : Array<SuggestionDescription>
observable
module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#descriptionParts
Stores description entries generated for this suggestion that describe what is the suggested change. They are used to create the final description presented in the suggestion view to the user.
Note that one suggestion may include multiple changes.
Most cases are simple and include just one description item:
```
[
 	{ type: 'insertion', content: '*Insert:* "Foo"' }
]
 ```

This description item represents a suggestion for inserting the "Foo" text. The `type` property describes the performed action
while the `content` property contains additional information about the action and is optional.

A more complex example is presented below:

```ts
[
 	{ type: 'insertion', content: '*Insert:* 2 paragraphs' },
 	{ type: 'insertion', content: '*Insert:* image' },
 	{ type: 'replace', content: '*Replace:* "Foo" *with* "Bar"' }
]
```
Copy code
In this example, there are three description instances (or lines). Two new (empty) paragraphs were added, an image was added and then "Foo" text was replaced by "Bar". The above structure could be rendered as:
```
 Insert: 2 paragraphs
 Insert: image
 Replace: "Foo" with "Bar"
 ```
```
Copy code

`element : null | HTMLElement`
inherited

module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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:

view.element = document.querySelector( '#my-container' );

focusCycler : FocusCycler
readonly

Helps cycling over focusable views in the thread.
focusTracker : FocusTracker
readonly

Tracks information about DOM focus in the thread.
focusables : ViewCollection<FocusableView>
readonly

A collection of focusable child views.
isActive : boolean
observable

A boolean value that informs if the comment thread view is in the active state ("highlighted"). A comment thread view is in this state when it is focused or was activated by the user in any different way.
isDirty : boolean
observable

Informs whether the suggestion thread has any changes that have not been saved.
isEnabled : boolean
observable

Informs whether the suggestion can be accepted or discarded.
isRendered : boolean
readonlyinherited

Set true when the view has already been rendered.
keystrokes : KeystrokeHandler
readonly

Instance of the KeystrokeHandler.
length : number
readonlyobservable

The number of items in the view, where the suggestion itself counts as one.
In other words, it is equal to the number of comments in the suggestion thread view plus one.
locale : undefined | Locale
readonlyinherited

A set of tools to localize the user interface.
Also see locale.
t : undefined | LocaleTranslate
inherited
module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#t
Shorthand for t.
Note: If locale instance hasn't been passed to the view this method may not be available.
Related:
- Locale#t
template : Template | undefined
inherited

Template of this view. It provides the element representing the view in DOM, which is rendered.
viewUid : string | undefined
inherited
_unboundChildren : ViewCollection
protectedinherited

A collection of view instances, which have been added directly into the children.
_viewCollections : Collection<ViewCollection<View<HTMLElement>>>
protectedinherited

Collections registered with createCollection.

Methods

constructor( locale, model, localUser, config )

Parameters
locale : Locale
model : Suggestion
localUser : User
config : SuggestionThreadConfig
bind( bindProperties ) → ObservableMultiBindChain
inherited
module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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 );
```
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, 'isWorking' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
Copy code
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 );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
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' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Copy code
Parameters
bindProperties : Array<'length' | 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'element' | 'template' | 'focus' | 'ariaLabel' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'focusCycler' | 'focusTracker' | 'isEnabled' | 'keystrokes' | 'focusables' | 'isActive' | 'isDirty' | 'ariaDescriptionView' | 'authoredAt' | 'commentsListView' | 'commentThreadInputView' | 'canAccept' | 'canDiscard' | 'descriptionParts'>
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, BaseSuggestionThreadView[ K1 ], K2, BaseSuggestionThreadView[ K2 ]>
inherited
module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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 );
```
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, 'isWorking' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
Copy code
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 );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
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' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Copy code
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, BaseSuggestionThreadView[ K1 ], K2, BaseSuggestionThreadView[ K2 ]>
The bind chain with the to() and toMany() methods.
bind( bindProperty ) → ObservableSingleBindChain<K, BaseSuggestionThreadView[ K ]>
inherited
module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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 );
```
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, 'isWorking' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
Copy code
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 );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
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' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Copy code
Type parameters
K
Parameters
bindProperty : K
Observable property that will be bound to other observable(s).
Returns
ObservableSingleBindChain<K, BaseSuggestionThreadView[ K ]>
The bind chain with the to() and toMany() methods.
createCollection( [ views ] ) → ViewCollection<T>
inherited
module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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 <child#element> to the <body>.
document.body.appendChild( view.element );
```
Copy code
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:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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:
```
foo.on( 'method', ( evt ) => {
	evt.return = 'Foo!';
} );

foo.method(); // -> 'Foo'
```
Copy code
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'
```
Copy code
Parameters
methodName : 'length' | 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'element' | 'template' | 'focus' | 'ariaLabel' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'focusCycler' | 'focusTracker' | 'isEnabled' | 'keystrokes' | 'focusables' | 'isActive' | 'isDirty' | 'ariaDescriptionView' | 'authoredAt' | 'commentsListView' | 'commentThreadInputView' | 'canAccept' | 'canDiscard' | 'descriptionParts'
Name of the method to decorate.
Returns
void
delegate( events ) → EmitterMixinDelegateChain
inherited
module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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.fire( 'eventX', data );
```
Copy code
and eventY is delegated (fired by) emitterC along with data:
```
emitterA.fire( 'eventY', data );
```
Copy code
Parameters
events : Array<string>
Event names that will be delegated to another emitter.
Returns
EmitterMixinDelegateChain
deregisterChild( children ) → void
inherited
module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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.
Parameters
children : View<HTMLElement> | Iterable<View<HTMLElement>>
Child views to be removed.
Returns
void
Related:
- BaseSuggestionThreadView#registerChild
destroy() → void
module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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.
Returns
void
extendTemplate( definition ) → void
inherited
module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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.
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.
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

Focuses the view.
Returns
void
listenTo( emitter, event, callback, [ options ] ) → void
inherited
module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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.
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:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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.
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.
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 ).
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).
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.
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:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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',

 * 			// These children will be added automatically. There's no
 * 			// need to call registerChild for any of them.
			children: [ this.childA, this.childB ]
		} );
	}

	// ...
}

Parameters

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

Returns

void

render() → void
module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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
Returns
void
set( values ) → void
inherited
module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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
Parameters
values : object
An object with name=>value pairs.
Returns
void
set( name, value ) → void
inherited
module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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
Type parameters
K
Parameters
name : K
The property's name.
value : BaseSuggestionThreadView[ K ]
The property's value.
Returns
void
setTemplate( definition ) → void
inherited
module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#setTemplate
Sets the template of the view with with given definition.
A shorthand for:
```
view.setTemplate( definition );
```
Copy code
Parameters
definition : TemplateDefinition
Definition of view's template.
Returns
void
stopDelegating( [ event ], [ emitter ] ) → void
inherited
module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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.
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:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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.
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:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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.
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:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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
Parameters
unbindProperties : Array<'length' | 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'element' | 'template' | 'focus' | 'ariaLabel' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'focusCycler' | 'focusTracker' | 'isEnabled' | 'keystrokes' | 'focusables' | 'isActive' | 'isDirty' | 'ariaDescriptionView' | 'authoredAt' | 'commentsListView' | 'commentThreadInputView' | 'canAccept' | 'canDiscard' | 'descriptionParts'>
Observable properties to be unbound. All the bindings will be released if no properties are provided.
Returns
void

Events

acceptSuggestion( eventInfo, id )

Fired when a user performed an action that should lead to accepting the suggestion.
This event is not fired by default by any component created by BaseSuggestionThreadView. If you create a view class extending BaseSuggestionCommentView, you should provide a UI element that will fire this event.
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
id : string
change:authoredAt( eventInfo, name, value, oldValue )

Fired when the authoredAt property changed value.
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (authoredAt).
value : null | Date
New value of the authoredAt property with given key or null, if operation should remove property.
oldValue : null | Date
Old value of the authoredAt property with given key or null, if property was not set before.
change:canAccept( eventInfo, name, value, oldValue )

Fired when the canAccept property changed value.
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (canAccept).
value : boolean
New value of the canAccept property with given key or null, if operation should remove property.
oldValue : boolean
Old value of the canAccept property with given key or null, if property was not set before.
change:canDiscard( eventInfo, name, value, oldValue )

Fired when the canDiscard property changed value.
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (canDiscard).
value : boolean
New value of the canDiscard property with given key or null, if operation should remove property.
oldValue : boolean
Old value of the canDiscard property with given key or null, if property was not set before.
change:descriptionParts( eventInfo, name, value, oldValue )

Fired when the descriptionParts property changed value.
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (descriptionParts).
value : Array<SuggestionDescription>
New value of the descriptionParts property with given key or null, if operation should remove property.
oldValue : Array<SuggestionDescription>
Old value of the descriptionParts property with given key or null, if property was not set before.
change:isActive( eventInfo, name, value, oldValue )

Fired when the isActive property changed value.
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (isActive).
value : boolean
New value of the isActive property with given key or null, if operation should remove property.
oldValue : boolean
Old value of the isActive property with given key or null, if property was not set before.
change:isDirty( eventInfo, name, value, oldValue )

Fired when the isDirty property changed value.
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (isDirty).
value : boolean
New value of the isDirty property with given key or null, if operation should remove property.
oldValue : boolean
Old value of the isDirty property with given key or null, if property was not set before.
change:isEnabled( eventInfo, name, value, oldValue )

Fired when the isEnabled property changed value.
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (isEnabled).
value : boolean
New value of the isEnabled property with given key or null, if operation should remove property.
oldValue : boolean
Old value of the isEnabled property with given key or null, if property was not set before.
change:length( eventInfo, name, value, oldValue )

Fired when the length property changed value.
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (length).
value : number
New value of the length property with given key or null, if operation should remove property.
oldValue : number
Old value of the length property with given key or null, if property was not set before.
change:{property}( eventInfo, name, value, oldValue )
inherited
module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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
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.
discardSuggestion( eventInfo, id )

Fired when a user performed an action that should lead to discarding the suggestion.
This event is not fired by default by any component created by BaseSuggestionThreadView. If you create a view class extending BaseSuggestionCommentView, you should provide a UI element that will fire this event.
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
id : string
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.
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
<anonymous> : Parameters<TObservable[ TName ]>
set:authoredAt( eventInfo, name, value, oldValue )

Fired when the authoredAt 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 (authoredAt).
value : null | Date
New value of the authoredAt property with given key or null, if operation should remove property.
oldValue : null | Date
Old value of the authoredAt property with given key or null, if property was not set before.
set:canAccept( eventInfo, name, value, oldValue )

Fired when the canAccept 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 (canAccept).
value : boolean
New value of the canAccept property with given key or null, if operation should remove property.
oldValue : boolean
Old value of the canAccept property with given key or null, if property was not set before.
set:canDiscard( eventInfo, name, value, oldValue )

Fired when the canDiscard 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 (canDiscard).
value : boolean
New value of the canDiscard property with given key or null, if operation should remove property.
oldValue : boolean
Old value of the canDiscard property with given key or null, if property was not set before.
set:descriptionParts( eventInfo, name, value, oldValue )

Fired when the descriptionParts 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 (descriptionParts).
value : Array<SuggestionDescription>
New value of the descriptionParts property with given key or null, if operation should remove property.
oldValue : Array<SuggestionDescription>
Old value of the descriptionParts property with given key or null, if property was not set before.
set:isActive( eventInfo, name, value, oldValue )

Fired when the isActive 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 (isActive).
value : boolean
New value of the isActive property with given key or null, if operation should remove property.
oldValue : boolean
Old value of the isActive property with given key or null, if property was not set before.
set:isDirty( eventInfo, name, value, oldValue )

Fired when the isDirty 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 (isDirty).
value : boolean
New value of the isDirty property with given key or null, if operation should remove property.
oldValue : boolean
Old value of the isDirty property with given key or null, if property was not set before.
set:isEnabled( eventInfo, name, value, oldValue )

Fired when the isEnabled 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 (isEnabled).
value : boolean
New value of the isEnabled property with given key or null, if operation should remove property.
oldValue : boolean
Old value of the isEnabled property with given key or null, if property was not set before.
set:length( eventInfo, name, value, oldValue )

Fired when the length 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 (length).
value : number
New value of the length property with given key or null, if operation should remove property.
oldValue : number
Old value of the length property with given key or null, if property was not set before.
set:{property}( eventInfo, name, value, oldValue )
inherited
module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView#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.
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.
Parameters
eventInfo : EventInfo
An object containing information about the fired event.

BaseSuggestionThreadView

Properties

ariaDescriptionView : AriaDescriptionViewreadonly

ariaLabel : string

authoredAt : null | Date Eye iconobservable

bindTemplate : BindChain<this>readonlyinherited

canAccept : boolean Eye iconobservable

canDiscard : boolean Eye iconobservable

commentThreadInputView : null | CommentThreadInputView

commentsListView : null | CommentsListView

descriptionParts : Array<SuggestionDescription> Eye iconobservable

element : null | HTMLElementinherited

focusCycler : FocusCyclerreadonly

focusTracker : FocusTrackerreadonly

focusables : ViewCollection<FocusableView>readonly

isActive : boolean Eye iconobservable

isDirty : boolean Eye iconobservable

isEnabled : boolean Eye iconobservable

isRendered : booleanreadonlyinherited

keystrokes : KeystrokeHandlerreadonly

length : numberreadonly Eye iconobservable

locale : undefined | Localereadonlyinherited

t : undefined | LocaleTranslateinherited

Related:

template : Template | undefinedinherited

viewUid : string | undefinedinherited

_unboundChildren : ViewCollectionprotectedinherited

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

Methods

constructor( locale, model, localUser, config )

Parameters

bind( bindProperties ) → ObservableMultiBindChaininherited

Parameters

Returns

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

Type parameters

Parameters

Returns

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

Type parameters

Parameters

Returns

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

Type parameters

Parameters

Returns

decorate( methodName ) → voidinherited

Parameters

Returns

delegate( events ) → EmitterMixinDelegateChaininherited

Parameters

Returns

deregisterChild( children ) → voidinherited

Parameters

Returns

Related:

destroy() → void

Returns

extendTemplate( definition ) → voidinherited

Parameters

Returns

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

Type parameters

Parameters

Returns

focus() → void

Returns

listenTo( emitter, event, callback, [ options ] ) → voidinherited

Type parameters

Parameters

Returns

listenTo( emitter, event, callback, [ options ] ) → voidinherited

Type parameters

Parameters

Returns

listenTo( emitter, event, callback, [ options ] ) → voidinherited

Type parameters

Parameters

Returns

off( event, callback ) → voidinherited

`ariaDescriptionView : AriaDescriptionView`
readonly

`ariaLabel : string`

`authoredAt : null | Date`
observable

`bindTemplate : BindChain<this>`
readonlyinherited

`canAccept : boolean`
observable

`canDiscard : boolean`
observable

`commentThreadInputView : null | CommentThreadInputView`

`commentsListView : null | CommentsListView`

`descriptionParts : Array<SuggestionDescription>`
observable

`element : null | HTMLElement`
inherited

`focusCycler : FocusCycler`
readonly

`focusTracker : FocusTracker`
readonly

`focusables : ViewCollection<FocusableView>`
readonly

`isActive : boolean`
observable

`isDirty : boolean`
observable

`isEnabled : boolean`
observable

`isRendered : boolean`
readonlyinherited

`keystrokes : KeystrokeHandler`
readonly

`length : number`
readonlyobservable

`locale : undefined | Locale`
readonlyinherited

`t : undefined | LocaleTranslate`
inherited

`template : Template | undefined`
inherited

`viewUid : string | undefined`
inherited

`_unboundChildren : ViewCollection`
protectedinherited

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

`constructor( locale, model, localUser, config )`

`bind( bindProperties ) → ObservableMultiBindChain`
inherited

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

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

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

`decorate( methodName ) → void`
inherited

`delegate( events ) → EmitterMixinDelegateChain`
inherited

`deregisterChild( children ) → void`
inherited

`destroy() → void`

`extendTemplate( definition ) → void`
inherited

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

`focus() → void`

`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`

`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

`acceptSuggestion( eventInfo, id )`

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

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

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

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

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

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

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

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

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

`discardSuggestion( eventInfo, id )`

`render( eventInfo, <anonymous> )`
inherited

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

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

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

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