CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

User (collaboration-core)

@ckeditor/ckeditor5-collaboration-core/src/users

class

The representation of a single user that is involved in document editing.

Filtering

Properties

  • avatar : String

  • color : Object

  • id : String

  • initials : String

    The first characters of the first 2 words from the user name.

  • isAnonymous : Boolean

    A property that is equal to true when the user name is undefined or can be trimmed to a zero-length string.

  • name : String

  • _isAnonymous : Boolean

    protected

Methods

  • constructor( data = { data.id, data.color, [data.name], [data.avatar] } )

    Parameters

    data : Object

    User data.

    Properties
    data.id : String

    The ID of the user.

    data.color : Object

    A helper object to generate CSS classes with the user color in the UI.

    [ data.name ] : String

    The name of the user.

    [ data.avatar ] : String

    The URL to the user avatar.