ParticipantItemProps interface

套件:

@azure/communication-react

ParticipantItem的 Props。

屬性

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	參與者的唯一用戶標識碼。 此 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

參與者的唯一用戶標識碼。 此 userId 可在 onRenderAvatar 回呼函式中使用

userId?: string

屬性值

string