Skip to main content

WhoIsOnline API Reference

The Who-is-Online component allows you to see participants who connected to a room.

How to use

To initialize the Who-is-Online component, you can follow our quickstart guide.

Properties

NameTypeDescription
positionstringOptional. Specifies the location of the component. Options are: top-right, top-left, bottom-right, bottom-left, or an ID of an HTML element.

Default value: top-right
stylesstringOptional custom CSS styles to be applied to the component. This allows for customization of the component's appearance.
disablePresenceControlsbooleanIf true it won't open any dropdown menu by interacting with the participant profile image.
Default value: false
disableGoToParticipantbooleanDisables the GoTo option when clicking on another participant's avatar.
Default value: false
disableFollowParticipantbooleanDisables the Follow option when clicking on another participant's avatar.
Default value: false
disablePrivateModebooleanDisables the Private Mode option when clicking on the current participant avatar.
Default value: false
disableGatherAllbooleanDisables the Gather All option.
Default value: false
disableFollowMebooleanDisables the Follow Me option.
Default value: false