ParticipantItemProps interface

パッケージ:

@azure/communication-react

ParticipantItemの Props。

プロパティ

ariaLabelledBy	ParticipantItems aria content をプレフィックスとするオプションの aria プロパティ ParticipantItem の前に読み取ろうとする要素の一意の id 値を取ります。
displayName	参加者の名前。
me	参加者を表示するオプションのインジケーターは、ユーザーです。
menuItems	コンテキスト メニューの IContextualMenuItem の省略可能な配列。
onClick	コンポーネントがクリックされたときの省略可能なコールバック
onRenderAvatar	アバターをオーバーライドする JSX 要素を返す省略可能なコールバック。
onRenderIcon	ParticipantItem の右側にレンダリングされた JSX 要素を返す省略可能なコールバック。 アイコンの追加を目的としています。
participantState	参加者の接続ステータスを判断して表示するためのオプションの値。 たとえば、 Connecting、 Ringing などです。表示される実際のテキストは、指定された参加者の状態に対応するローカライズされた文字列によって決まります。 たとえば、strings.participantStateConnecting が participantState の場合は Connecting が使用されます。
presence	参加者のプレゼンスを表示する省略可能な PersonaPresence。 プロパティアバターが割り当てられている場合、これは効果がありません。
showParticipantOverflowTooltip	参加者にツールチップを表示するかどうかを決定するオプションの値
strings	コンポーネントでオーバーライドする省略可能な文字列
styles	ユーザーがカスタム CSS スタイルを含むオブジェクトを渡すことができます。
userId	参加者の一意のユーザー ID。 この userId は、onRenderAvatar コールバック関数で使用できます

プロパティの詳細

ariaLabelledBy

ParticipantItems aria content をプレフィックスとするオプションの 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 などです。表示される実際のテキストは、指定された参加者の状態に対応するローカライズされた文字列によって決まります。 たとえば、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