ParticipantsCanvas
This component renders a collection of participants.
Can be themed with Theme.ParticipantsCanvas in Theme.
Component children#
| Key | Component | Condition | Align | Description |
|---|---|---|---|---|
| onHold | styled(div) | Visible only if task is conference call and worker is on hold | Wrapper for on hold container. Displays CallCanvasWorkerOnHold template and button to unhold worker | |
| participantsContainer | styled(div) | Scrollable wrapper for ParticipantsContainer that renders the participants of the call |
Static Properties#
| Name | Type | Description |
|---|---|---|
| Content | DynamicContentStore<ParticipantsCanvas.ParticipantsCanvasChildrenProps> | Dynamic content store |
Component Properties#
| Name | Type | Description | Optional | Default |
|---|---|---|---|---|
| includeMyself | boolean | Identifies if current logged in worker is included. | Yes | |
| hideActions | boolean | Identifies if the participant actions are hidden | Yes |
Component Children Properties#
| Name | Type | Description | Optional | Default |
|---|---|---|---|---|
| theme.ParticipantsCanvas | ParticipantsCanvasThemeProps | Theme | Yes | |
| external | Array<CallCanvasParticipant> | external call canvas participants. | No | |
| participantsByCallSid | Record<string, Participant> | dictionary of participants with participantSid as the key. | No |
Rate this page