ParticipantItemProps interface

包:

@azure/communication-react

ParticipantItem的道具。

属性

ariaLabelledBy	可选的 aria 属性，该属性为 ParticipantItems aria 内容添加前缀：在 ParticipantItem 之前接收要读取的元素的唯一 id 值。
displayName	参与者的名称。
me	用于显示参与者的可选指示器是用户。
menuItems	上下文菜单的 IContextualMenuItem 的可选数组。
onClick	单击组件时可选的回调
onRenderAvatar	返回 JSX 元素以替代头像的可选回调。
onRenderIcon	可选回调，返回在 ParticipantItem 右侧呈现的 JSX 元素。 用于添加图标。
participantState	用于确定和显示参与者连接状态的可选值。 例如， Connecting， Ringing etc.显示的实际文本由与提供的参与者状态对应的本地化字符串确定。 例如， strings.participantStateConnecting 如果 participantState 为 ， Connecting则使用 。
presence	用于显示参与者状态的可选 PersonaPresence。 如果分配了属性头像，则不会产生效果。
showParticipantOverflowTooltip	可选值，用于确定是否应向参与者显示工具提示
strings	在组件中重写的可选字符串
styles	允许用户传入对象包含自定义 CSS 样式。
userId	参与者的唯一用户 ID。 此 userId 在 onRenderAvatar 回调函数中可用

属性详细信息

ariaLabelledBy

可选的 aria 属性，该属性为 ParticipantItems aria 内容添加前缀：在 ParticipantItem 之前接收要读取的元素的唯一 id 值。

ariaLabelledBy?: string

属性值

string

displayName

参与者的名称。

displayName?: string

属性值

string

me

用于显示参与者的可选指示器是用户。

me?: boolean

属性值

boolean

menuItems

上下文菜单的 IContextualMenuItem 的可选数组。

menuItems?: IContextualMenuItem[]

属性值

IContextualMenuItem[]

onClick

单击组件时可选的回调

onClick?: (props?: ParticipantItemProps) => void

属性值

(props?: ParticipantItemProps) => void

onRenderAvatar

返回 JSX 元素以替代头像的可选回调。

onRenderAvatar?: OnRenderAvatarCallback

属性值

OnRenderAvatarCallback

onRenderIcon

可选回调，返回在 ParticipantItem 右侧呈现的 JSX 元素。 用于添加图标。

onRenderIcon?: (props?: ParticipantItemProps) => null | Element

属性值

(props?: ParticipantItemProps) => null | Element

participantState

用于确定和显示参与者连接状态的可选值。 例如， Connecting， Ringing etc.显示的实际文本由与提供的参与者状态对应的本地化字符串确定。 例如， strings.participantStateConnecting 如果 participantState 为 ， Connecting则使用 。

participantState?: ParticipantState

属性值

ParticipantState

presence

用于显示参与者状态的可选 PersonaPresence。 如果分配了属性头像，则不会产生效果。

presence?: PersonaPresence

属性值

PersonaPresence

showParticipantOverflowTooltip

可选值，用于确定是否应向参与者显示工具提示

showParticipantOverflowTooltip?: boolean

属性值

boolean

strings

在组件中重写的可选字符串

strings?: Partial<ParticipantItemStrings>

属性值

Partial<ParticipantItemStrings>

styles

允许用户传入对象包含自定义 CSS 样式。

styles?: ParticipantItemStyles

属性值

ParticipantItemStyles

userId

参与者的唯一用户 ID。 此 userId 在 onRenderAvatar 回调函数中可用

userId?: string

属性值

string