CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

Comment (comments/comments)

@ckeditor/ckeditor5-comments/src/comments/commentsrepository

class

Single comment representation. A part of a commentThread.

Filtering

Properties

  • attributes : Object

    readonly observable

    Custom comment attributes. See also setAttribute and removeAttribute.

  • author : User

    readonly

    The comment author.

  • content : String

    readonly observable

    The comment content.

  • createdAt : Date

    readonly observable

    The comment creation date.

  • id : String

    readonly

    The comment ID.

  • isEditable : Boolean

    observable

    When is set to true, editing the comment is blocked.

  • isReadOnly : Boolean

    readonly observable

    The read-only state inherited from the parent CommentThread. When is set to true, then removing and editing the comment thread is blocked.

    In contrast to isEditable and isRemovable, this state can be used to hide some UI parts instead of temporarily disabling them.

  • isRemovable : Boolean

    observable

    When is set to false, removing the comment is blocked.

  • threadId : String

    readonly

    The ID of the comment thread that contains this comment.

  • weight : Number

    readonly

    The comment weight.

    It is equal to the length of the comment content, however it is never smaller than 200. This limit is set to avoid a long list of very short not collapsed comments.

Methods

  • constructor( commentsRepository, data = { data.id, data.threadId, data.content, data.author, [data.createdAt], [data.attributes] } )

    Parameters

    commentsRepository : CommentsRepository
    data : Object

    Configuration object.

    Properties
    data.id : String

    Comment id.

    data.threadId : String

    Comment thread id.

    data.content : String

    Comment content.

    data.author : User

    Comment author.

    [ data.createdAt ] : Date

    Comment creation date.

    [ data.attributes ] : Object

    Custom comment attributes. See also setAttribute and removeAttribute.

  • bind( bindProperties ) → Object

    mixed

    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 : String

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

    Returns

    Object

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

  • decorate( methodName )

    mixed

    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 {
	constructor() {
		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 : String

    Name of the method to decorate.

  • delegate( events ) → EmitterMixinDelegateChain

    mixed

    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 : String

    Event names that will be delegated to another emitter.

    Returns

    EmitterMixinDelegateChain

  • destroy()

    Destroys the comment instance.

  • fire( eventOrInfo, [ args ] ) → *

    mixed

    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.

    Parameters

    eventOrInfo : String | EventInfo

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

    [ args ] : *

    Additional arguments to be passed to the callbacks.

    Returns

    *

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

  • listenTo( emitter, event, callback, [ options ] = { [options.priority] } )

    mixed

    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.

    Parameters

    emitter : Emitter

    The object that fires the event.

    event : String

    The name of the event.

    callback : function

    The function to be called on event.

    [ options ] : Object

    Additional options.

    Properties
    [ options.priority ] : PriorityString | Number

    The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

    Defaults to 'normal'

    Defaults to {}

  • off( event, callback )

    mixed

    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.

  • on( event, callback, [ options ] = { [options.priority] } )

    mixed

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

    Parameters

    event : String

    The name of the event.

    callback : function

    The function to be called on event.

    [ options ] : Object

    Additional options.

    Properties
    [ options.priority ] : PriorityString | Number

    The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

    Defaults to 'normal'

    Defaults to {}

  • once( event, callback, [ options ] = { [options.priority] } )

    mixed

    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.

    Parameters

    event : String

    The name of the event.

    callback : function

    The function to be called on event.

    [ options ] : Object

    Additional options.

    Properties
    [ options.priority ] : PriorityString | Number

    The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

    Defaults to 'normal'

    Defaults to {}

  • remove( data = { [data.content], [data.createdAt], [data.isFromAdapter] } )

    Removes the comment.

    Note: This method fires the event-updateComment event and the default behavior is added as a normal priority listener. It makes it possible to cancel the method or call some custom code before or after the default behavior is executed.

    Parameters

    data : Object

    The data object.

    Properties
    [ data.content ] : String

    The comment content.

    [ data.createdAt ] : Date

    The comment creation date.

    [ data.isFromAdapter ] : Boolean

    A flag describing whether the comment was updated from an adapter (true) or from the UI (false). If set to true, the adapter will not be called.

    Defaults to false

    Fires

  • removeAttribute( name )

    Removes a comment attribute.

    See also setAttribute.

    Parameters

    name : String

    The attribute name.

    Fires

  • set( name, [ value ] )

    mixed

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

    It accepts also 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.

    Parameters

    name : String | Object

    The property's name or object with name=>value pairs.

    [ value ] : *

    The property's value (if name was passed in the first parameter).

  • setAttribute( name, value )

    Adds attribute to the comment.

    Comment attributes are custom data that can be set and used by features built around comments. Use it to store your feature data with other comment data.

    comment.setAttribute( 'isImportant', true );

    You can group multiple values in an object, using dot notation:

    comment.setAttribute( 'customData.type', 'image' );
comment.setAttribute( 'customData.src', 'foo.jpg' );

    Attributes set on the comment can be accessed through the attribute property:

    const isImportant = comment.attributes.isImportant;
const type = comment.attributes.customData.type;

    You can also observe the attributes property or bind other properties to it:

    myObj.bind( 'customData' ).to( comment, 'attributes', attributes => attributes.customData );

    Whenever setAttribute() or removeAttribute() is called, the attributes property is re-set and observables are refreshed.

    Parameters

    name : String

    Attribute name.

    value : *

    Attribute value.

    Fires

  • stopDelegating( [ event ], [ emitter ] )

    mixed

    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.

  • stopListening( [ emitter ], [ event ], [ callback ] )

    mixed

    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.

  • toJSON() → Object

    Returns

    Object

  • unbind( [ unbindProperties ] )

    mixed

    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 ] : String

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

  • update( data = { [data.content], [data.createdAt], [data.attributes], [data.isFromAdapter] } )

    Updates the comment with provided data.

    Note: This method fires the event-updateComment event and the default behavior is added as a normal priority listener. It makes it possible to cancel the method or call some custom code before or after the default behavior is executed.

    Parameters

    data : Object

    Data object.

    Properties
    [ data.content ] : String

    Comment content.

    [ data.createdAt ] : Date

    Creation date.

    [ data.attributes ] : Object

    Custom comment attributes. See also setAttribute and removeAttribute.

    [ data.isFromAdapter ] : Boolean

    Defaults to false

    Fires

  • _addEventListener( event, callback, [ options ] = { [options.priority] } )

    protected mixed

    Adds callback to emitter for given event.

    Parameters

    event : String

    The name of the event.

    callback : function

    The function to be called on event.

    [ options ] : Object

    Additional options.

    Properties
    [ options.priority ] : PriorityString | Number

    The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

    Defaults to 'normal'

    Defaults to {}

  • _removeEventListener( event, callback )

    protected mixed

    Removes callback from emitter for given event.

    Parameters

    event : String

    The name of the event.

    callback : function

    The function to stop being called.

Events

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

    Fired when the attributes property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : String

    Name of the changed property (attributes).

    value : Object

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

    oldValue : Object

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

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

    Fired when the content property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : String

    Name of the changed property (content).

    value : String

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

    oldValue : String

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

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

    Fired when the createdAt property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : String

    Name of the changed property (createdAt).

    value : Date

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

    oldValue : Date

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

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

    Fired when the isEditable property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : String

    Name of the changed property (isEditable).

    value : Boolean

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

    oldValue : Boolean

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

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

    Fired when the isReadOnly property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : String

    Name of the changed property (isReadOnly).

    value : Boolean

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

    oldValue : Boolean

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

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

    Fired when the isRemovable property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : String

    Name of the changed property (isRemovable).

    value : Boolean

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

    oldValue : Boolean

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

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

    mixed

    Fired when a property changed value.

    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 : *

    The new property value.

    oldValue : *

    The previous property value.

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

    mixed

    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( '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 : *

    The new property value.

    oldValue : *

    The previous property value.