# CommentThreadView class The default view for comment thread. ## Properties ### `actionIndicator: string | null` _(observable)_ 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. ### `ariaDescriptionView: AriaDescriptionView` _(readonly)_ A helper view that provides an ARIA description for the comment thread used by assistive technologies. ### `ariaLabel: string` _(inherited)_ An accessible thread label text exposed to assistive technologies. ### `bindTemplate: BindChain` _(readonly)_ Shorthand for [`bind`](module_ui_template-Template.md#static-function-bind), a binding [interface](module_ui_template-BindChain.md) pre–configured for the view instance. It provides [`to()`](module_ui_template-BindChain.md#function-to:ATTRIBUTE) and [`if()`](module_ui_template-BindChain.md#function-if) methods that initialize bindings with observable attributes and attach DOM listeners. ```typescript 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

in DOM. click: bind.to( 'clicked' ) } } ); } } ``` ### `cancelConfirm: () => void` ### `commentThreadChildren: ViewCollection>` _(readonly)_ View collection which holds all comment thread children elements. These views are: * [`commentThreadHeaderView`](#member-commentThreadHeaderView) (added at the beginning when the comment thread is resolved), * [`commentsListView`](#member-commentsListView), * [`commentThreadInputView`](#member-commentThreadInputView). ### `commentThreadHeaderView: CommentThreadHeaderView` _(readonly)_ The comment thread header. It should be used as a part of the view template. This header is used only for resolved comment threads. ### `commentThreadInputView: CommentThreadInputView` _(readonly)_ The comment input area view. It should be used as a part of the view template. ### `commentsListView: CommentsListView` _(readonly)_ The list of comment views. It should be used as a part of the view template. ### `containerElement: HTMLElement | null` _(readonly)_ `ConfirmView` uses this element as a container for confirmation dialog. The element is set after `view#render()` is called. ### `element: HTMLElement | null` _(inherited)_ ### `focusCycler: FocusCycler` _(readonly)_ Helps cycling over focusable views in the thread. ### `focusTracker: FocusTracker` _(readonly)_ Tracks information about DOM focus in the thread. ### `focusables: ViewCollection` _(readonly)_ The collection of focusable views in the comment thread. ### `isActive: boolean` _(inherited)_ Informs whether the comment thread view is in active state ("highlighted"). A comment thread view is in this state when it is focused or was activated by the user in any other way. ### `isConfirm: boolean` _(inherited)_ ### `isDirty: boolean` _(inherited)_ Informs whether the comment thread has any changes that have not been saved. ### `isRendered: boolean` _(readonly)_ Set `true` when the view has already been [rendered](module_ui_view-View.md#function-render). ### `isUnlinked: boolean` _(inherited)_ Informs whether the comment thread view is in unlinked state. A comment thread view is in this state when its corresponding target has been removed from the content. ### `keystrokes: KeystrokeHandler` _(readonly)_ Instance of the [`KeystrokeHandler`](module_utils_keystrokehandler-KeystrokeHandler.md). ### `length: number` _(readonly)_ The number of comments. ### `locale: Locale` _(readonly)_ The locale instance. ### `resolveButton: LateFocusButtonView` _(readonly)_ Resolve button view. Resolve button fires the 'resolveCommentThread' event when submitted. ### `showConfirm: ( key: string, element: unknown ) => Promise` ### `t: LocaleTranslate | undefined` _(inherited)_ Shorthand for [`t`](module_utils_locale-Locale.md#member-t). Note: If [`locale`](#member-locale) instance hasn't been passed to the view this method may not be available. #### Related: * [Locale#t](module_utils_locale-Locale.md#member-t) ### `template?: Template` _(inherited)_ Template of this view. It provides the [`element`](#member-element) representing the view in DOM, which is [rendered](#function-render). ### `viewUid?: string` _(inherited)_ ### `_unboundChildren: ViewCollection` _(protected)_ A collection of view instances, which have been added directly into the [`children`](module_ui_template-Template.md#member-children). ### `_viewCollections: Collection>>` _(protected)_ Collections registered with [`createCollection`](#function-createCollection). ## Methods ### `constructor( locale, model, localUser, config )` #### Parameters * `locale: Locale` * `model: CommentThread` * `localUser: User` * `config: CommentThreadConfig` ### `bind( bindProperties ) → ObservableMultiBindChain` _(inherited)_ Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface. Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) 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: ```typescript button.bind( 'isEnabled' ).to( command, 'isEnabled' ); ``` or even shorter: ```typescript 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`](module_utils_observablemixin-Observable.md#function-unbind). You can also "rename" the property in the binding by specifying the new name in the `to()` chain: ```typescript button.bind( 'isEnabled' ).to( command, 'isWorking' ); ``` It is possible to bind more than one property at a time to shorten the code: ```typescript button.bind( 'isEnabled', 'value' ).to( command ); ``` which corresponds to: ```typescript 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: ```typescript 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: ```typescript 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: ```typescript button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled', ( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled ); ``` #### Parameters * `bindProperties: Array<'length' | 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'element' | 'template' | 'focus' | 'ariaLabel' | 'destroy' | 'focusTracker' | 'containerElement' | 'render' | 'locale' | '_model' | 'isActive' | 'keystrokes' | 't' | 'isRendered' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'focusCycler' | 'focusables' | 'isDirty' | 'ariaDescriptionView' | 'cancelConfirm' | 'showConfirm' | 'actionIndicator' | 'getTemplate' | 'isConfirm' | '_localUser' | 'isUnlinked' | 'commentsListView' | 'commentThreadHeaderView' | 'commentThreadInputView' | 'commentThreadChildren' | 'resolveButton'>` 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` _(inherited)_ Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface. Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) 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: ```typescript button.bind( 'isEnabled' ).to( command, 'isEnabled' ); ``` or even shorter: ```typescript 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`](module_utils_observablemixin-Observable.md#function-unbind). You can also "rename" the property in the binding by specifying the new name in the `to()` chain: ```typescript button.bind( 'isEnabled' ).to( command, 'isWorking' ); ``` It is possible to bind more than one property at a time to shorten the code: ```typescript button.bind( 'isEnabled', 'value' ).to( command ); ``` which corresponds to: ```typescript 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: ```typescript 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: ```typescript 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: ```typescript 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 * `ObservableDualBindChain` The bind chain with the `to()` and `toMany()` methods. ### `bind( bindProperty ) → ObservableSingleBindChain` _(inherited)_ Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface. Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) 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: ```typescript button.bind( 'isEnabled' ).to( command, 'isEnabled' ); ``` or even shorter: ```typescript 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`](module_utils_observablemixin-Observable.md#function-unbind). You can also "rename" the property in the binding by specifying the new name in the `to()` chain: ```typescript button.bind( 'isEnabled' ).to( command, 'isWorking' ); ``` It is possible to bind more than one property at a time to shorten the code: ```typescript button.bind( 'isEnabled', 'value' ).to( command ); ``` which corresponds to: ```typescript 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: ```typescript 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: ```typescript 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: ```typescript 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 * `ObservableSingleBindChain` The bind chain with the `to()` and `toMany()` methods. ### `createCollection( views? ) → ViewCollection` _(inherited)_ Creates a new collection of views, which can be used as [`children`](module_ui_template-Template.md#member-children) of this view. ```typescript 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

to the . document.body.appendChild( view.element ); ``` #### Type parameters * `T: extends View` #### Parameters * `views?: Iterable` Initial views of the collection. #### Returns * `ViewCollection` A new collection of view instances. ### `decorate( methodName ) → void` _(inherited)_ 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](../framework/deep-dive/observables.md#decorating-object-methods) 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](module_utils_eventinfo-EventInfo.md#member-stop): ```typescript 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](module_utils_priorities-PriorityString.md) 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: ```typescript 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: ```typescript 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: 'length' | 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'element' | 'template' | 'focus' | 'ariaLabel' | 'destroy' | 'focusTracker' | 'containerElement' | 'render' | 'locale' | '_model' | 'isActive' | 'keystrokes' | 't' | 'isRendered' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'focusCycler' | 'focusables' | 'isDirty' | 'ariaDescriptionView' | 'cancelConfirm' | 'showConfirm' | 'actionIndicator' | 'getTemplate' | 'isConfirm' | '_localUser' | 'isUnlinked' | 'commentsListView' | 'commentThreadHeaderView' | 'commentThreadInputView' | 'commentThreadChildren' | 'resolveButton'` Name of the method to decorate. #### Returns * `void` ### `delegate( events ) → EmitterMixinDelegateChain` _(inherited)_ Delegates selected events to another [`Emitter`](module_utils_emittermixin-Emitter.md). For instance: ```typescript emitterA.delegate( 'eventX' ).to( emitterB ); emitterA.delegate( 'eventX', 'eventY' ).to( emitterC ); ``` then `eventX` is delegated (fired by) `emitterB` and `emitterC` along with `data`: ```typescript emitterA.fire( 'eventX', data ); ``` and `eventY` is delegated (fired by) `emitterC` along with `data`: ```typescript emitterA.fire( 'eventY', data ); ``` #### Parameters * `events: Array` Event names that will be delegated to another emitter. #### Returns * `EmitterMixinDelegateChain` ### `deregisterChild( children ) → void` _(inherited)_ The opposite of [`registerChild`](#function-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 | Iterable>` Child views to be removed. #### Returns * `void` #### Related: * [CommentThreadView#registerChild](#function-registerChild) ### `destroy() → Promise` _(inherited)_ #### Returns * `Promise` ### `extendTemplate( definition ) → void` _(inherited)_ [Extends](module_ui_template-Template.md#static-function-extend) the [`template`](#member-template) of the view with with given definition. A shorthand for: ```typescript Template.extend( view.template, definition ); ``` **Note**: Is requires the [`template`](#member-template) to be already set. See [`setTemplate`](#function-setTemplate). #### Parameters * `definition: Partial` Definition which extends the [`template`](#member-template). #### Returns * `void` ### `fire( eventOrInfo, args ) → GetEventInfo[ 'return' ]` _(inherited)_ Fires an event, executing all callbacks registered for it. The first parameter passed to callbacks is an [`EventInfo`](module_utils_eventinfo-EventInfo.md) object, followed by the optional `args` provided in the `fire()` method call. #### Type parameters * `TEvent: extends BaseEvent` The type describing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md). #### Parameters * `eventOrInfo: GetNameOrEventInfo` 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[ 'return' ]` By default the method returns `undefined`. However, the return value can be changed by listeners through modification of the [`evt.return`](module_utils_eventinfo-EventInfo.md#member-return)'s property (the event info is the first param of every callback). ### `focus() → void` _(inherited)_ Focuses the view. #### Returns * `void` ### `getTemplate() → TemplateDefinition` Returns a template definition that will be passed to [`setTemplate`](module_ui_view-View.md#function-setTemplate). Overwrite this method if you want to set a custom template for the comment thread view. The default template looks as follows: ```typescript const bind = this.bindTemplate; { tag: 'div', attributes: { class: [ 'ck', 'ck-thread', 'ck-reset_all-excluded', 'ck-rounded-corners', bind.if( 'isActive', 'ck-thread--active' ), bind.if( 'isUnlinked', 'ck-thread--unlinked' ), bind.to( 'actionIndicator', value => value ? `ck-thread--${ value }` : '' ) ], 'data-thread-id': this._model.id, // Needed for managing focus after adding new comment. tabindex: 0, role: 'listitem', 'aria-label': bind.to( 'ariaLabel' ), 'aria-describedby': this.ariaDescriptionView.id }, children: [ { tag: 'div', attributes: { class: 'ck-thread__container' }, children: this.commentThreadChildren } ] }; ``` See the [Annotation custom view guide](../features/collaboration/annotations/annotations-custom-view.md) to learn more about the possible annotation customizations. #### Returns * `TemplateDefinition` The definition of a comment thread view's template. ### `listenTo( emitter, event, callback, options? ) → void` _(inherited)_ 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. ```typescript // 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](module_utils_eventinfo-EventInfo.md#member-stop) and set the [return value](module_utils_eventinfo-EventInfo.md#member-return) of the [`fire`](#function-fire) method. #### Type parameters * `TEvent: extends BaseEvent` The type describing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md). #### Parameters * `emitter: Emitter` The object that fires the event. * `event: TEvent[ 'name' ]` The name of the event. * `callback: GetCallback` The function to be called on event. * `options?: CallbackOptions` 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) object. Events can be grouped in namespaces using `:`. When namespaced event is fired, it additionally fires all callbacks for that namespace. ```typescript // 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](module_utils_eventinfo-EventInfo.md#member-stop) and set the [return value](module_utils_eventinfo-EventInfo.md#member-return) of the [`fire`](#function-fire) method. #### Type parameters * `TEvent: extends BaseEvent` The type describing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md). #### Parameters * `emitter: Emitter` The object that fires the event. * `event: TEvent[ 'name' ]` The name of the event. * `callback: GetCallback` The function to be called on event. * `options?: GetCallbackOptions` 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`](module_utils_emittermixin-Emitter.md#function-listenTo:BASE_EMITTER). #### 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?: CallbackOptions & 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 )`](#function-stopListening:DOM_STOP). #### 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 )`](#function-listenTo:HTML_EMITTER) (it makes the emitter listen on itself). #### Type parameters * `TEvent: extends BaseEvent` The type descibing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md). #### Parameters * `event: TEvent[ 'name' ]` The name of the event. * `callback: GetCallback` The function to be called on event. * `options?: GetCallbackOptions` 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`](#function-on) followed by [`off`](#function-off) in the callback. #### Type parameters * `TEvent: extends BaseEvent` The type descibing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md). #### Parameters * `event: TEvent[ 'name' ]` The name of the event. * `callback: GetCallback` The function to be called on event. * `options?: GetCallbackOptions` Additional options. #### Returns * `void` ### `registerChild( children ) → void` _(inherited)_ Registers a new child view under the view instance. Once registered, a child view is managed by its parent, including [rendering](#function-render) and [destruction](#function-destroy). To revert this, use [`deregisterChild`](#function-deregisterChild). ```typescript 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

. document.body.appendChild( view.element ); ``` **Note**: There's no need to add child views if they're already referenced in the [`template`](#member-template): ```typescript 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 | Iterable>` Children views to be registered. #### Returns * `void` ### `render() → void` #### Returns * `void` ### `set( values ) → void` _(inherited)_ 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: ```typescript public declare myProp1: number; public declare myProp2: string; constructor() { this.set( { 'myProp1: 2, 'myProp2: 'foo' } ); } ``` #### Parameters * `values: object & object` An object with `name=>value` pairs. #### Returns * `void` ### `set( name, value ) → void` _(inherited)_ 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: ```typescript public declare myProp: number; constructor() { this.set( 'myProp', 2 ); } ``` #### Type parameters * `K` #### Parameters * `name: K` The property's name. * `value: CommentThreadView[ K ]` The property's value. #### Returns * `void` ### `setTemplate( definition ) → void` _(inherited)_ Sets the [`template`](#member-template) of the view with with given definition. A shorthand for: ```typescript view.setTemplate( definition ); ``` #### Parameters * `definition: TemplateDefinition` Definition of view's template. #### Returns * `void` ### `stopDelegating( event?, emitter? ) → void` _(inherited)_ 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)_ 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)_ Stops listening for events. It can be used at different levels: It is backwards compatible with [`listenTo`](module_utils_emittermixin-Emitter.md#function-listenTo:BASE_EMITTER). * 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)_ Removes the binding created with [`bind`](#function-bind:SINGLE_BIND). ```typescript // Removes the binding for the 'a' property. A.unbind( 'a' ); // Removes bindings for all properties. A.unbind(); ``` #### Parameters * `unbindProperties: Array<'length' | 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'element' | 'template' | 'focus' | 'ariaLabel' | 'destroy' | 'focusTracker' | 'containerElement' | 'render' | 'locale' | '_model' | 'isActive' | 'keystrokes' | 't' | 'isRendered' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'focusCycler' | 'focusables' | 'isDirty' | 'ariaDescriptionView' | 'cancelConfirm' | 'showConfirm' | 'actionIndicator' | 'getTemplate' | 'isConfirm' | '_localUser' | 'isUnlinked' | 'commentsListView' | 'commentThreadHeaderView' | 'commentThreadInputView' | 'commentThreadChildren' | 'resolveButton'>` Observable properties to be unbound. All the bindings will be released if no properties are provided. #### Returns * `void` ## Events ### `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: string | null` New value of the `actionIndicator` property with given key or `null`, if operation should remove property. * `oldValue: string | null` Old value of the `actionIndicator` property with given key or `null`, if property was not set before. ### `change:isActive( eventInfo, name, value, oldValue )` _(inherited)_ 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 )` _(inherited)_ 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:isUnlinked( eventInfo, name, value, oldValue )` _(inherited)_ Fired when the `isUnlinked` property changed value. #### Parameters * `eventInfo: EventInfo` An object containing information about the fired event. * `name: string` Name of the changed property (`isUnlinked`). * `value: boolean` New value of the `isUnlinked` property with given key or `null`, if operation should remove property. * `oldValue: boolean` Old value of the `isUnlinked` property with given key or `null`, if property was not set before. ### `change:length( eventInfo, name, value, oldValue )` _(inherited)_ 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)_ Fired when a property changed value. ```typescript observable.set( 'prop', 1 ); observable.on>( '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. ### `removeCommentThread( eventInfo )` _(inherited)_ Fired when a user performed an action that should lead to removing the comment thread. This event is not fired by default by any component created by `BaseCommentThreadView`. If you create a view class extending `BaseCommentThreadView`, you should provide a UI element that will fire this event. This event is fired by default when an empty comment thread view (with no comments) loses focus. #### Parameters * `eventInfo: EventInfo` An object containing information about the fired event. ### `render( eventInfo, )` _(inherited)_ Event fired by the [`render`](module_ui_view-View.md#function-render) method. Actual rendering is executed as a listener to this event with the default priority. See [`decorate`](module_utils_observablemixin-Observable.md#function-decorate) for more information and samples. #### Parameters * `eventInfo: EventInfo` An object containing information about the fired event. * `: Parameters` ### `resolveCommentThread( eventInfo, id )` _(inherited)_ Fired when a user performed an action that should lead to resolve the comment thread. #### Parameters * `eventInfo: EventInfo` An object containing information about the fired event. * `id: string` ### `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: string | null` New value of the `actionIndicator` property with given key or `null`, if operation should remove property. * `oldValue: string | null` Old value of the `actionIndicator` property with given key or `null`, if property was not set before. ### `set:isActive( eventInfo, name, value, oldValue )` _(inherited)_ 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 )` _(inherited)_ 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:isUnlinked( eventInfo, name, value, oldValue )` _(inherited)_ Fired when the `isUnlinked` 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 (`isUnlinked`). * `value: boolean` New value of the `isUnlinked` property with given key or `null`, if operation should remove property. * `oldValue: boolean` Old value of the `isUnlinked` property with given key or `null`, if property was not set before. ### `set:length( eventInfo, name, value, oldValue )` _(inherited)_ 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)_ 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](module_utils_eventinfo-EventInfo.md#member-return). ```typescript observable.set( 'prop', 1 ); observable.on>( '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>( '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. ### `submit( eventInfo )` _(inherited)_ Fired by [`submitHandler`](module_ui_bindings_submithandler.md#function-submitHandler) helper. #### Parameters * `eventInfo: EventInfo` An object containing information about the fired event. ### `submitCommentThread( eventInfo )` _(inherited)_ Fired when a user created a first comment in the comment thread. Then the comment thread is submitted and saved. #### Parameters * `eventInfo: EventInfo` An object containing information about the fired event. --- Full index of the CKEditor 5 API reference: [llms.txt](llms.txt)