ParticipantCanvas
This component renders a single participant.
Component children#
| Key | Component | Condition | Align | Description |
|---|---|---|---|---|
| avatar | styled(div) | The participant avatar while on a call. Displays worker.attributes.image_url prop | ||
| avatar-hover | styled(div) | Included only if participant (from props) is on hold or connecting | Hover shown over participant avatar during an active call if participant is connecting or on hold | |
| name | styled(div) | Div containing participant name | ||
| status | styled(div) | Div containing participant status | ||
| actions | styled(div) | Visible only if hideActions prop is false and task was initiated by the current agent | Container for actions that can be taken on a participant | |
| transcriptParticipantContainer | styled(div) | Container for displaying the participant of the active call | ||
| transcriptParticipantMetaContainer | styled(div) | Container for displaying the meta information of the participant in the active call | ||
| transcriptParticipantAvatar | Twilio paste component | Avatar to show the initials of the Agent name that has joined the active call | ||
| transcriptParticipantStatusContainer | styled(div) | Container for displaying the status of the participant in the active call |
Static Properties#
| Name | Type | Description |
|---|---|---|
| Content | DynamicContentStore<ParticipantCanvas.ParticipantCanvasChildrenProps, ParticipantCanvasChildrenKeys> | Dynamic content store |
| ListItem | Object | Dynamic content properties for List item |
| Actions | Object | Dynamic content properties for action buttons container |
Component Properties#
| Name | Type | Description | Optional | Default |
|---|---|---|---|---|
| participant | ConferenceParticipant | Represents a single participant of a conference. | No | |
| participantWidth | number | Represents width of the participant container. | No | |
| hideActions | boolean | Identifies if the participant actions are hidden. | Yes | |
| listMode | boolean | Identifies if the participant are rendered in list mode. | Yes | |
| isCCAICall | boolean | Identifies if the active call is a CCAI call. | Yes |
Component Children Properties#
| Name | Type | Description | Optional | Default |
|---|---|---|---|---|
| theme.ParticipantsCanvas.ParticipantCanvas | ParticipantCanvasThemeProps | Theme | Yes | |
| participant | ConferenceParticipant | Represents a single participant of a conference. | No | |
| participantWidth | number | Represents width of the participant container. | No | |
| hideActions | boolean | Identifies if the participant actions are hidden. | Yes | |
| listMode | boolean | Identifies if the participant are rendered in list mode. | Yes | |
| isCCAICall | boolean | Identifies if the active call is a CCAI call. | Yes |