Share via

ChatCompositeProps interface

  • Reference
Package:
@azure/communication-react

Props for ChatComposite.

Extends

BaseCompositeProps<ChatCompositeIcons>

Properties

adapter

An adapter provides logic and data to the composite. Composite can also be controlled using the adapter.
onRenderMessage

(messageProps: MessageProps, defaultOnRender?: MessageRenderer) => JSX.Element A callback for customizing the message renderer.
onRenderTypingIndicator

(typingUsers: CommunicationParticipant[]) => JSX.Element A callback for customizing the typing indicator renderer.
options

Flags to enable/disable visual elements of the ChatComposite.

Inherited Properties

fluentTheme

Fluent theme for the composite.
icons

Custom Icon override for the composite. A JSX element can be provided to override the default icon.
locale

Locale for the composite.
onFetchAvatarPersonaData

A callback function that can be used to provide custom data to Avatars rendered in Composite.

This will not affect the displayName shown in the composite. The displayName throughout the composite will be what is provided to the adapter when the adapter is created. will be what is provided to the adapter when the adapter is created.
onFetchParticipantMenuItems

A callback function that can be used to provide custom menu items for a participant in participant list.
rtl

Whether composite is displayed right-to-left.

Property Details

adapter

An adapter provides logic and data to the composite. Composite can also be controlled using the adapter.

adapter: ChatAdapter

Property Value

ChatAdapter

onRenderMessage

(messageProps: MessageProps, defaultOnRender?: MessageRenderer) => JSX.Element A callback for customizing the message renderer.

onRenderMessage?: (messageProps: MessageProps, defaultOnRender?: MessageRenderer) => Element

Property Value

(messageProps: MessageProps, defaultOnRender?: MessageRenderer) => Element

onRenderTypingIndicator

(typingUsers: CommunicationParticipant[]) => JSX.Element A callback for customizing the typing indicator renderer.

onRenderTypingIndicator?: (typingUsers: CommunicationParticipant[]) => Element

Property Value

(typingUsers: CommunicationParticipant[]) => Element

options

Flags to enable/disable visual elements of the ChatComposite.

options?: ChatCompositeOptions

Property Value

ChatCompositeOptions

Inherited Property Details

fluentTheme

Fluent theme for the composite.

fluentTheme?: PartialTheme | Theme

Property Value

PartialTheme | Theme

Inherited From BaseCompositeProps.fluentTheme

icons

Custom Icon override for the composite. A JSX element can be provided to override the default icon.

icons?: ChatCompositeIcons

Property Value

ChatCompositeIcons

Inherited From BaseCompositeProps.icons

locale

Locale for the composite.

locale?: CompositeLocale

Property Value

CompositeLocale

Inherited From BaseCompositeProps.locale

onFetchAvatarPersonaData

A callback function that can be used to provide custom data to Avatars rendered in Composite.

This will not affect the displayName shown in the composite. The displayName throughout the composite will be what is provided to the adapter when the adapter is created. will be what is provided to the adapter when the adapter is created.

onFetchAvatarPersonaData?: AvatarPersonaDataCallback

Property Value

AvatarPersonaDataCallback

Inherited From BaseCompositeProps.onFetchAvatarPersonaData

onFetchParticipantMenuItems

A callback function that can be used to provide custom menu items for a participant in participant list.

onFetchParticipantMenuItems?: ParticipantMenuItemsCallback

Property Value

ParticipantMenuItemsCallback

Inherited From BaseCompositeProps.onFetchParticipantMenuItems

rtl

Whether composite is displayed right-to-left.

rtl?: boolean

Property Value

boolean

Inherited From BaseCompositeProps.rtl