Share via

SendBoxProps interface

  • Reference
Package:
@azure/communication-react

Props for SendBox.

Properties

autoFocus

enumerable to determine if the input box has focus on render or not. When undefined nothing has focus on render
disabled

Optional boolean to disable text box
onRenderIcon

Optional callback to render send button icon to the right of the SendBox.
onRenderSystemMessage

Optional callback to render system message below the SendBox.
onSendMessage

Optional callback called when message is sent
onTyping

Optional callback called when user is typing
strings

Optional strings to override in component
styles

Allows users to pass in an object contains custom CSS styles.
supportNewline

Optional boolean to support new line in SendBox.
systemMessage

Optional text for system message below text box

Property Details

autoFocus

enumerable to determine if the input box has focus on render or not. When undefined nothing has focus on render

autoFocus?: "sendBoxTextField"

Property Value

"sendBoxTextField"

disabled

Optional boolean to disable text box

disabled?: boolean

Property Value

boolean

onRenderIcon

Optional callback to render send button icon to the right of the SendBox.

onRenderIcon?: (isHover: boolean) => Element

Property Value

(isHover: boolean) => Element

onRenderSystemMessage

Optional callback to render system message below the SendBox.

onRenderSystemMessage?: (systemMessage: undefined | string) => ReactElement<any, string | JSXElementConstructor<any>>

Property Value

(systemMessage: undefined | string) => ReactElement<any, string | JSXElementConstructor<any>>

onSendMessage

Optional callback called when message is sent

onSendMessage?: (content: string) => Promise<void>

Property Value

(content: string) => Promise<void>

onTyping

Optional callback called when user is typing

onTyping?: () => Promise<void>

Property Value

() => Promise<void>

strings

Optional strings to override in component

strings?: Partial<SendBoxStrings>

Property Value

Partial<SendBoxStrings>

styles

Allows users to pass in an object contains custom CSS styles.

styles?: SendBoxStylesProps

Property Value

SendBoxStylesProps

supportNewline

Optional boolean to support new line in SendBox.

supportNewline?: boolean

Property Value

boolean

systemMessage

Optional text for system message below text box

systemMessage?: string

Property Value

string