RtcPresenceListConfig

interface

The configuration of the real-time collaboration features.

ClassicEditor
	.create( {
		presenceList: ... // Collaboration presence list configuration.
	} )
	.then( ... )
	.catch( ... );

Properties

collapseAt?: number

Indicates a number of displayed users at which the presence list will switch to a dropdown view. If the number is 8, then 7 users will still be displayed inline, while 8+ users will be displayed in the dropdown.
The number must be greater than 0.
Defaults to 6
container?: HTMLElement

DOM element that will hold the feature’s UI.
displayMe?: boolean

Determines if the local user avatar should be displayed in the presence list (true) or not (false).
Defaults to true
onClick?: ( user: User, element: HTMLElement ) => void

Callback function that will be invoked after a click on a presence list member.
overlayContainer?: ShadowRoot | HTMLElement

DOM element or shadow root into which the floating presence list dropdown is mounted.
When the presence list runs inside a shadow root, provide this container as a separate shadow root attached to a host element placed at the end of document.body, rather than to an element nested in the presence list's own tree. As a direct child of document.body, that host has no scrollable or overflow: hidden ancestor to clip the dropdown (the container typically clips its own overflow).
When it is not set, the shared ui.overlayContainer from the context configuration is used instead, if present. Otherwise the dropdown is mounted into the shadow root that the container lives in, so it inherits the same styles; the document.body default is meant just for a presence list in the light DOM.