This is documentation for Stream Chat React Native SDK v5, which is nolonger actively maintained. For up-to-date documentation, see the latest version (v6).

InputButtons

Component to render the AttachButton and the CommandsButton on the left side of the input box within MessageInput.

This is the default component provided to the prop InputButtons on the Channel component.

Props

giphyActive

True if a user selects the giphy command from commands list (which is shown when you type a / in the input box). This value is set back to false when the user sends the message for searching Giphy.

Type
Boolean

hasCommands

Enable commands on the MessageInput component.

TypeDefault
booleantrue

hasFilePicker

Enable the file picker on the MessageInput component.

TypeDefault
Booleantrue

hasImagePicker

Enable the image picker on the MessageInput component.

TypeDefault
Booleantrue

openCommandsPicker

Opens the commands picker box. By default, this function is attached to onPress handler for CommandsButton.

Type
Function

selectedPicker

Value is images (string), when image attachment picker is open. Value will be undefined if file picker is active or file picker is open.

Type
’images’ | undefined

setShowMoreOptions

Setter function for showMoreOptions.

Type
(showMoreOptions) => void

showMoreOptions

Represents the expanded or collapsed state for attach and commands button, next to input box.

Type
Boolean

text

Text message entered by user in underlying TextInput within MessageInput component. This value is attached to TextInput’s value prop

Type
String

toggleAttachmentPicker

Function to toggle attachment picker. By default, this function is attached to onPress handler for AttachButton.

Type
Function

UI Component Props

AttachButton

Component to render the attach button next to input box.

TypeDefault
ComponentTypeAttachButton

CommandsButton

Component to render button next to input box, which when pressed opens commands list.

TypeDefault
ComponentTypeCommandsButton

MoreOptionsButton

Component to render a button within enclosed MessageInput, which when pressed shows more options such as AttachButton, CommandsButton.

TypeDefault
ComponentTypeMoreOptionsButton

© Getstream.io, Inc. All Rights Reserved.