CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

CommentView (comments/comments/ui/view)

@ckeditor/ckeditor5-comments/src/comments/ui/view/commentview

class

The default view for comment.

Filtering

Properties

  • actionBar : ViewCollection<FocusableView>

    Collection for UI elements that manage the comment.

    Elements that may be found in the action bar (depending on the comment view properties):

    • the resolve comment thread button (only if the comment is the first comment),
    • a dropdown with actions (dropdown).

  • observable

    actionIndicator : null | string

    A property used by the template.

    It works as a visual indicator for the user that an action is about to be performed. The value of this property is used in setting the CSS class. The property is used when the user interacts with the view.

  • readonly inherited

    ariaDescriptionView : AriaDescriptionView

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

  • inherited

    ariaLabel : string

    An accessible label text used by assistive technologies describing the comment.

  • observable

    authoredAt : Date

    Comment creation date.

  • readonly inherited

    bindTemplate : BindChain<this>

    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' )
			}
		} );
	}
}

  • cancelConfirm : () => void

  • dropdown : default

    Dropdown containing comment action buttons defined in items.

  • editButton : ButtonView

    Edit button view. Edit button switches the comment to the editing mode.

  • inherited

    element : null | HTMLElement

    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' );

  • readonly inherited

    focusCycler : FocusCycler

    Helps cycling over focusable focusables in the comment.

  • readonly inherited

    focusTracker : FocusTracker

    Tracks information about DOM focus in the comment view.

  • readonly inherited

    focusables : ViewCollection<FocusableView>

    A collection of child views that can receive focus and contribute to the (shift) tab key navigation.

  • isConfirm : boolean

  • inherited observable

    isEditMode : boolean

    Informs whether the comment view is in the editing mode.

  • inherited

    isRendered : boolean

    Set true when the view has already been rendered.

  • inherited

    isSystemComment : boolean

    Flag indicating whether the comment view displays an actual comment (false) or is a system message (true). System message comment should not include any UI elements which allow for editing the comment as it is not an actual comment.

  • items : ViewCollection<ButtonView>

    View collection which holds all the comments dropdown elements.

    May include, depending on the view properties:

  • readonly inherited

    keystrokes : KeystrokeHandler

    Instance of the KeystrokeHandler.

  • locale : Locale

  • observable

    placeholder : string

    Comment editor placeholder value.

  • removeButton : ButtonView

    Remove button view. Remove button shows a confirmation box that fires the removeComment event when submitted.

  • observable

    resolvedAt : null | Date

    Comment resolved date.

  • showConfirm : ( string, unknown ) => Promise<void>

  • inherited

    t : undefined | LocaleTranslate

    Shorthand for t.

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

    Related:

  • inherited

    template : Template | undefined

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

  • userView : default

    User view for the comment. Presents the comment author.

  • inherited

    viewUid : string | undefined

  • readonly inherited

    visibleView : ViewCollection<View<HTMLElement>>

    Stores the currently displayed sub-view.

    This is a collection that always includes one view: comment content view or comment input view. Depending whether the comment is in editing mode or not, one of the views is in the collection. When the comment mode changes, the content of this collection also changes.

    By default, the comment is in the "content mode" and this view collection stores the comment content view.

  • protected inherited

    _unboundChildren : ViewCollection<View<HTMLElement>>

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

  • protected inherited

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

    Collections registered with createCollection.

Methods

  • constructor( locale, model, config )

    Parameters

    locale : Locale
    model : Comment
    config : CommentViewConfig

  • inherited

    bind( bindProperties ) → MultiBindChain

    Binds observable properties to other objects implementing the Observable interface.

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

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

    A simple property binding could be as follows:

    button.bind( 'isEnabled' ).to( command, 'isEnabled' );

    or even shorter:

    button.bind( 'isEnabled' ).to( command );

    which works in the following way:

    • button.isEnabled instantly equals command.isEnabled,
    • whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.

    Note: To release the binding, use unbind.

    You can also "rename" the property in the binding by specifying the new name in the to() chain:

    button.bind( 'isEnabled' ).to( command, 'isWorking' );

    It is possible to bind more than one property at a time to shorten the code:

    button.bind( 'isEnabled', 'value' ).to( command );

    which corresponds to:

    button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );

    The binding can include more than one observable, combining multiple data sources in a custom callback:

    button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );

    Using a custom callback allows processing the value before passing it to the target property:

    button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );

    It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:

    button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );

    Parameters

    bindProperties : Array<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'element' | 'template' | 'focus' | 'ariaLabel' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'focusCycler' | 'focusTracker' | 'placeholder' | 'isCollapsed' | 'items' | 'keystrokes' | 'focusables' | 'visibleView' | '_config' | '_model' | 'dropdown' | 'expand' | 'userView' | 'isEditMode' | 'isSystemComment' | 'ariaDescriptionView' | 'collapse' | 'switchToEditMode' | 'switchToDisplayMode' | 'getExternalCommentNote' | 'getUserViewNotificationText' | 'authoredAt' | 'resolvedAt' | 'isConfirm' | 'cancelConfirm' | 'showConfirm' | 'actionIndicator' | 'actionBar' | 'editButton' | 'removeButton' | 'getTemplate'>

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

    Returns

    MultiBindChain

    The bind chain with the to() and toMany() methods.

  • inherited

    bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, CommentView[ K1 ], K2, CommentView[ K2 ]>

    Binds observable properties to other objects implementing the Observable interface.

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

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

    A simple property binding could be as follows:

    button.bind( 'isEnabled' ).to( command, 'isEnabled' );

    or even shorter:

    button.bind( 'isEnabled' ).to( command );

    which works in the following way:

    • button.isEnabled instantly equals command.isEnabled,
    • whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.

    Note: To release the binding, use unbind.

    You can also "rename" the property in the binding by specifying the new name in the to() chain:

    button.bind( 'isEnabled' ).to( command, 'isWorking' );

    It is possible to bind more than one property at a time to shorten the code:

    button.bind( 'isEnabled', 'value' ).to( command );

    which corresponds to:

    button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );

    The binding can include more than one observable, combining multiple data sources in a custom callback:

    button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );

    Using a custom callback allows processing the value before passing it to the target property:

    button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );

    It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:

    button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );

    Type parameters

    K1
    K2

    Parameters

    bindProperty1 : K1

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

    bindProperty2 : K2

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

    Returns

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

    The bind chain with the to() and toMany() methods.

  • inherited

    bind( bindProperty ) → SingleBindChain<K, CommentView[ K ]>

    Binds observable properties to other objects implementing the Observable interface.

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

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

    A simple property binding could be as follows:

    button.bind( 'isEnabled' ).to( command, 'isEnabled' );

    or even shorter:

    button.bind( 'isEnabled' ).to( command );

    which works in the following way:

    • button.isEnabled instantly equals command.isEnabled,
    • whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.

    Note: To release the binding, use unbind.

    You can also "rename" the property in the binding by specifying the new name in the to() chain:

    button.bind( 'isEnabled' ).to( command, 'isWorking' );

    It is possible to bind more than one property at a time to shorten the code:

    button.bind( 'isEnabled', 'value' ).to( command );

    which corresponds to:

    button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );

    The binding can include more than one observable, combining multiple data sources in a custom callback:

    button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );

    Using a custom callback allows processing the value before passing it to the target property:

    button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );

    It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:

    button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );

    Type parameters

    K

    Parameters

    bindProperty : K

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

    Returns

    SingleBindChain<K, CommentView[ K ]>

    The bind chain with the to() and toMany() methods.

  • inherited

    collapse() → void

    Collapses the view.

    Returns

    void

  • inherited

    createCollection( [ views ] ) → ViewCollection<T>

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

    Type parameters

    T : extends [object Object] = default

    Parameters

    [ views ] : Iterable<T>

    Initial views of the collection.

    Returns

    ViewCollection<T>

    A new collection of view instances.

  • inherited

    decorate( methodName ) → void

    Turns the given methods of this object into event-based ones. This means that the new method will fire an event (named after the method) and the original action will be plugged as a listener to that event.

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

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

    For example, to cancel the method execution the event can be stopped:

    class Foo extends ObservableMixin() {
	constructor() {
		super();
		this.decorate( 'method' );
	}

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

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

foo.method(); // Nothing is logged.

    Note: The high priority listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).

    It is also possible to change the returned value:

    foo.on( 'method', ( evt ) => {
	evt.return = 'Foo!';
} );

foo.method(); // -> 'Foo'

    Finally, it is possible to access and modify the arguments the method is called with:

    method( a, b ) {
	console.log( `${ a }, ${ b }`  );
}

// ...

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

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

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

    Parameters

    methodName : 'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'element' | 'template' | 'focus' | 'ariaLabel' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'focusCycler' | 'focusTracker' | 'placeholder' | 'isCollapsed' | 'items' | 'keystrokes' | 'focusables' | 'visibleView' | '_config' | '_model' | 'dropdown' | 'expand' | 'userView' | 'isEditMode' | 'isSystemComment' | 'ariaDescriptionView' | 'collapse' | 'switchToEditMode' | 'switchToDisplayMode' | 'getExternalCommentNote' | 'getUserViewNotificationText' | 'authoredAt' | 'resolvedAt' | 'isConfirm' | 'cancelConfirm' | 'showConfirm' | 'actionIndicator' | 'actionBar' | 'editButton' | 'removeButton' | 'getTemplate'

    Name of the method to decorate.

    Returns

    void

  • inherited

    delegate( events ) → EmitterMixinDelegateChain

    Delegates selected events to another Emitter. For instance:

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

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

    emitterA.fire( 'eventX', data );

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

    emitterA.fire( 'eventY', data );

    Parameters

    events : Array<string>

    Event names that will be delegated to another emitter.

    Returns

    EmitterMixinDelegateChain

  • inherited

    deregisterChild( children ) → void

    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:

  • inherited

    destroy() → Promise<void>

    Returns

    Promise<void>

  • inherited

    expand() → void

    Expands the view.

    Returns

    void

  • inherited

    extendTemplate( definition ) → void

    Extends the template of the view with with given definition.

    A shorthand for:

    Template.extend( view.template, definition );

    Note: Is requires the template to be already set. See setTemplate.

    Parameters

    definition : Partial<TemplateDefinition>

    Definition which extends the template.

    Returns

    void

  • inherited

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

    Fires an event, executing all callbacks registered for it.

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

    Type parameters

    TEvent : extends BaseEvent

    The type describing the event. See BaseEvent.

    Parameters

    eventOrInfo : GetNameOrEventInfo<TEvent>

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

    args : TEvent[ 'args' ]

    Additional arguments to be passed to the callbacks.

    Returns

    GetEventInfo<TEvent>[ 'return' ]

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

  • inherited

    focus() → void

    Focuses the view.

    Returns

    void

  • inherited

    getExternalCommentNote() → string

    Gets the translated note which indicates that the comment comes from an external source.

    Returns

    string

  • getTemplate() → TemplateDefinition

    Returns a template definition that will be passed to setTemplate.

    Overwrite this method if you want to set a custom template for the comment view.

    The default template looks as follows:

    const bind = this.bindTemplate;

{
	tag: 'li',

	attributes: {
		class: [
			'ck-comment__wrapper',
			bind.if( 'isConfirm', 'ck-comment--remove-confirmation' )
		],
		tabindex: -1,
		'aria-label': bind.to( 'ariaLabel' ),
		'aria-describedby': this.ariaDescriptionView.id,
		role: 'listitem'
	},

	children: [
		{
			tag: 'div',

			attributes: {
				class: [
					'ck-comment',
					'ck-annotation',
					bind.if( 'isSystemComment', 'ck-comment--info' ),
					bind.if( 'isEditMode', 'ck-comment--edit' ),
					bind.to( 'actionIndicator', value => value ? `ck-comment--${ value }` : '' )
				],
				'data-author-id': this._model.author.id,
				'data-comment-id': this._model.id,
				role: 'group'
			},

			children: [
				this.userView,
				{
					tag: 'div',

					attributes: {
						class: [ 'ck-comment__main', 'ck-annotation__main' ]
					},

					children: [
						{
							tag: 'div',

							attributes: {
								class: [ 'ck-comment__info', 'ck-annotation__info' ]
							},

							children: [
								{
									tag: 'span',

									children: [
										{
											text: this.userView.name
										}
									],

									attributes: {
										class: [ 'ck-comment__info-name', 'ck-annotation__info-name' ]
									}
								},
								{
									tag: 'time',

									attributes: {
										datetime: bind.to( 'authoredAt' ),
										class: [ 'ck-comment__info-time', 'ck-annotation__info-time' ]
									},

									children: [
										{
											text: bind.to( 'authoredAt', value => this._config.formatDateTime( value ) )
										}
									]
								}
							]
						},
						{
							tag: 'div',

							attributes: {
								class: [
									'ck-comment__actions',
									'ck-annotation__actions',
									bind.if( 'isEditMode', 'ck-comment__actions--hidden' ),
									bind.if( 'isEditMode', 'ck-annotation__actions--hidden' )
								]
							},

							children: this.actionBar
						},
						{
							tag: 'div',

							attributes: {
								class: [ 'ck-annotation__content-wrapper' ]
							},

							children: this.visibleView
						},
						this.ariaDescriptionView,
						{
							tag: 'div',

							attributes: {
								class: [ 'ck-comment__external' ]
							},

							children: [ {
								text: this.getExternalCommentNote()
							} ]
						}
					]
				}

			]
		}
	]
}

    Returns

    TemplateDefinition

    Definition of comment thread view's template.

  • inherited

    getUserViewNotificationText() → null | string

    Gets the translated notification text which indicates that author name comes from an external source.

    Returns

    null | string

  • inherited

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

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

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

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

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

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

    Type parameters

    TEvent : extends BaseEvent

    The type describing the event. See BaseEvent.

    Parameters

    emitter : Emitter

    The object that fires the event.

    event : TEvent[ 'name' ]

    The name of the event.

    callback : GetCallback<TEvent>

    The function to be called on event.

    [ options ] : CallbackOptions

    Additional options.

    Returns

    void

  • inherited

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

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

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

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

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

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

    Type parameters

    TEvent : extends BaseEvent

    The type describing the event. See BaseEvent.

    Parameters

    emitter : Emitter

    The object that fires the event.

    event : TEvent[ 'name' ]

    The name of the event.

    callback : GetCallback<TEvent>

    The function to be called on event.

    [ options ] : GetCallbackOptions<TEvent>

    Additional options.

    Returns

    void

  • inherited

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

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

    Type parameters

    K : extends keyof DomEventMap

    Parameters

    emitter : Window | Node

    The object that fires the event.

    event : K

    The name of the event.

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

    The function to be called on event.

    [ options ] : object

    Additional options.

    Returns

    void

  • inherited

    off( event, callback ) → void

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

    Parameters

    event : string

    The name of the event.

    callback : Function

    The function to stop being called.

    Returns

    void

  • inherited

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

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

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

    Type parameters

    TEvent : extends BaseEvent

    The type descibing the event. See BaseEvent.

    Parameters

    event : TEvent[ 'name' ]

    The name of the event.

    callback : GetCallback<TEvent>

    The function to be called on event.

    [ options ] : GetCallbackOptions<TEvent>

    Additional options.

    Returns

    void

  • inherited

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

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

    Type parameters

    TEvent : extends BaseEvent

    The type descibing the event. See BaseEvent.

    Parameters

    event : TEvent[ 'name' ]

    The name of the event.

    callback : GetCallback<TEvent>

    The function to be called on event.

    [ options ] : GetCallbackOptions<TEvent>

    Additional options.

    Returns

    void

  • inherited

    registerChild( children ) → void

    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

    Returns

    void

  • inherited

    set( values ) → void

    Creates and sets the value of an observable properties of this object. Such a property becomes a part of the state and is observable.

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

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

    In TypeScript, those properties should be declared in class using declare keyword. In example:

    public declare myProp1: number;
public declare myProp2: string;

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

    Parameters

    values : object

    An object with name=>value pairs.

    Returns

    void

  • inherited

    set( name, value ) → void

    Creates and sets the value of an observable property of this object. Such a property becomes a part of the state and is observable.

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

    In TypeScript, those properties should be declared in class using declare keyword. In example:

    public declare myProp: number;

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

    Type parameters

    K

    Parameters

    name : K

    The property's name.

    value : CommentView[ K ]

    The property's value.

    Returns

    void

  • inherited

    setTemplate( definition ) → void

    Sets the template of the view with with given definition.

    A shorthand for:

    view.setTemplate( definition );

    Parameters

    definition : TemplateDefinition

    Definition of view's template.

    Returns

    void

  • inherited

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

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

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

    Parameters

    [ event ] : string

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

    [ emitter ] : Emitter

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

    Returns

    void

  • inherited

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

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

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

    Parameters

    [ emitter ] : Emitter

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

    [ event ] : string

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

    [ callback ] : Function

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

    Returns

    void

  • inherited

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

    Stops listening for events. It can be used at different levels: It is backwards compatible with listenTo.

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

    Parameters

    [ emitter ] : Window | Node | Emitter

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

    [ event ] : string

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

    [ callback ] : Function

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

    Returns

    void

  • inherited

    switchToDisplayMode() → void

    Switches the comment back from the editing mode to the content display mode.

    Returns

    void

  • inherited

    switchToEditMode() → void

    Switches the comment to the editing mode.

    Returns

    void

  • inherited

    unbind( unbindProperties ) → void

    Removes the binding created with bind.

    // Removes the binding for the 'a' property.
A.unbind( 'a' );

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

    Parameters

    unbindProperties : Array<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'element' | 'template' | 'focus' | 'ariaLabel' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'focusCycler' | 'focusTracker' | 'placeholder' | 'isCollapsed' | 'items' | 'keystrokes' | 'focusables' | 'visibleView' | '_config' | '_model' | 'dropdown' | 'expand' | 'userView' | 'isEditMode' | 'isSystemComment' | 'ariaDescriptionView' | 'collapse' | 'switchToEditMode' | 'switchToDisplayMode' | 'getExternalCommentNote' | 'getUserViewNotificationText' | 'authoredAt' | 'resolvedAt' | 'isConfirm' | 'cancelConfirm' | 'showConfirm' | 'actionIndicator' | 'actionBar' | 'editButton' | 'removeButton' | 'getTemplate'>

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

    Returns

    void

Events

  • inherited

    addComment( eventInfo, content )

    Fired when a user performed an action that should lead to creating a new comment in the comment thread.

    This event is fired by default when the comment input field of the comment thread is submitted.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    content : string

    The content of the new comment.

  • change:actionIndicator( eventInfo, name, value, oldValue )

    Fired when the actionIndicator property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (actionIndicator).

    value : null | string

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

    oldValue : null | string

    Old value of the actionIndicator property with given key or null, if property was not set before.

  • 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 : Date

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

    oldValue : Date

    Old value of the authoredAt property with given key or null, if property was not set before.

  • inherited

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

    Fired when the isCollapsed property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (isCollapsed).

    value : boolean

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

    oldValue : boolean

    Old value of the isCollapsed property with given key or null, if property was not set before.

  • inherited

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

    Fired when the isEditMode property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (isEditMode).

    value : boolean

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

    oldValue : boolean

    Old value of the isEditMode property with given key or null, if property was not set before.

  • change:placeholder( eventInfo, name, value, oldValue )

    Fired when the placeholder property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (placeholder).

    value : string

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

    oldValue : string

    Old value of the placeholder property with given key or null, if property was not set before.

  • change:resolvedAt( eventInfo, name, value, oldValue )

    Fired when the resolvedAt property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (resolvedAt).

    value : null | Date

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

    oldValue : null | Date

    Old value of the resolvedAt property with given key or null, if property was not set before.

  • inherited

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

    Fired when a property changed value.

    observable.set( 'prop', 1 );

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

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

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    The property name.

    value : TValue

    The new property value.

    oldValue : TValue

    The previous property value.

  • inherited

    removeComment( eventInfo, commentId )

    Fired when a user performed an action that should lead to removing a comment.

    This event is not fired by default by any component created by BaseCommentView. If you create a view class extending BaseCommentView you should provide a UI element that will fire this event.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    commentId : string

    The ID of the removed comment.

  • inherited

    render( eventInfo, <anonymous> )

    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:actionIndicator( eventInfo, name, value, oldValue )

    Fired when the actionIndicator 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 (actionIndicator).

    value : null | string

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

    oldValue : null | string

    Old value of the actionIndicator property with given key or null, if property was not set before.

  • 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 : Date

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

    oldValue : Date

    Old value of the authoredAt property with given key or null, if property was not set before.

  • inherited

    set:isCollapsed( eventInfo, name, value, oldValue )

    Fired when the isCollapsed 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 (isCollapsed).

    value : boolean

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

    oldValue : boolean

    Old value of the isCollapsed property with given key or null, if property was not set before.

  • inherited

    set:isEditMode( eventInfo, name, value, oldValue )

    Fired when the isEditMode 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 (isEditMode).

    value : boolean

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

    oldValue : boolean

    Old value of the isEditMode property with given key or null, if property was not set before.

  • set:placeholder( eventInfo, name, value, oldValue )

    Fired when the placeholder 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 (placeholder).

    value : string

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

    oldValue : string

    Old value of the placeholder property with given key or null, if property was not set before.

  • set:resolvedAt( eventInfo, name, value, oldValue )

    Fired when the resolvedAt 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 (resolvedAt).

    value : null | Date

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

    oldValue : null | Date

    Old value of the resolvedAt property with given key or null, if property was not set before.

  • inherited

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

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

    You can control the final value of the property by using the event's return property.

    observable.set( 'prop', 1 );

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

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

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

observable.prop = 2; // -> 'Value is going to be changed from 1 to 2'
                     // -> 'Current property value is 1'
                     // -> 'Value has changed from 1 to 3'

    Note: The event is fired even when the new value is the same as the old value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    The property name.

    value : TValue

    The new property value.

    oldValue : TValue

    The previous property value.

  • inherited

    submit( eventInfo )

    Fired by submitHandler helper.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

  • inherited

    updateComment( eventInfo, commentId, commentContent )

    Fired when a user performed an action that should lead to updating the comment content.

    This event is fired by default when the comment input field of a comment is submitted.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    commentId : string

    The ID of the updated comment.

    commentContent : string

    The updated comment content.