Skip to main content
Version: v4

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#

overrides the value from MessageInputContext
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

overrides the value from MessageInputContext
hasCommands#

Enable commands on the MessageInput component.

TypeDefault
booleantrue

overrides the value from MessageInputContext
hasFilePicker#

Enable the file picker on the MessageInput component.

TypeDefault
booleantrue

overrides the value from MessageInputContext
hasImagePicker#

Enable the image picker on the MessageInput component.

TypeDefault
booleantrue

overrides the value from MessageInputContext
openCommandsPicker#

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

Type
function

overrides the value from MessageInputContext
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

overrides the value from MessageInputContext
setShowMoreOptions#

Setter function for showMoreOptions.

Type
(showMoreOptions) => void

overrides the value from MessageInputContext
showMoreOptions#

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

Type
boolean

overrides the value from MessageInputContext
text#

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

Type
string

overrides the value from MessageInputContext
toggleAttachmentPicker#

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

Type
function

overrides the value from MessageInputContext
AttachButton#

Component to render the attach button next to input box.

TypeDefault
componentAttachButton

overrides the value from MessageInputContext
CommandsButton#

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

TypeDefault
componentCommandsButton

overrides the value from MessageInputContext
MoreOptionsButton#

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

TypeDefault
componentMoreOptionsButton

Did you find this page helpful?