Description of icon
Flex UI
API Reference

ParticipantCanvas

This component renders a single participant.


Component children#

KeyComponentConditionAlignDescription
avatarstyled(div)The participant avatar while on a call. Displays `worker.attributes.image_url` prop
avatar-hoverstyled(div)Included only if participant (from props) is on hold or connectingHover shown over participant avatar during an active call if participant is connecting or on hold
namestyled(div)Div containing participant name
statusstyled(div)Div containing participant status
actionsstyled(div)Visible only if hideActions prop is false and task was initiated by the current agentContainer for actions that can be taken on a participant

Static Properties#

NameDescriptionType
Content

Dynamic content store

DynamicContentStore.<ParticipantCanvas.ParticipantCanvasChildrenProps>
ListItem

Dynamic content properties for List item

Object.<{Content: DynamicContentStore.<ParticipantCanvas.ParticipantCanvasChildrenProps>}>
Actions

Dynamic content properties for action buttons container

Object.<{Content: DynamicContentStore.<ParticipantCanvas.ParticipantCanvasChildrenProps>}>

Component Properties

  • participant: ConferenceParticipant

    Represents a single participant of a conference.

  • participantWidth: number

    Represents width of the participant container.

  • hideActions?: boolean

    Identifies if the participant actions are hidden.

  • listMode?: boolean

    Identifies if the participant are rendered in list mode.

Need some help?