MessagesContext

markdownRules

Object specifying rules defined within simple-markdown.

messageActions

An array of, or function that returns and array of, actions that can be performed on a message shown in the message overlay. Please refer to the guide on customizing message actions for details.

messageContentOrder

Order in which to render the content of a message.

myMessageTheme

Theme applied to messages of the current user.

onLongPressMessage

Function called when a user long presses a message. The default opens the message actions overlay.

onPressInMessage

Function called immediately when a touch is engaged on a message, before onPressMessage.

onPressMessage

Function called when a user presses a message.

The additionalInfo prop is handy for getting information from certain click events. A good example of this is getting the user details when a textMention (for example @Enigma-I-am) is clicked.

For example:

    <Channel
      onPressMessage={({ additionalInfo, defaultHandler, emitter }) => {

          if (emitter === 'textMention') {
            console.log(additionalInfo?.user);
            return;
          }

          if (emitter === 'card' || emitter === 'textLink') {
            console.log(additionalInfo?.url);
            return;
          }

          if (emitter === 'fileAttachment') {
            console.log(additionalInfo?.attachment);
            return;
          }

          defaultHandler?.();
      }}
    >

:::info

The additionalInfo prop will change over time as we explore more use-cases for different emitter's.

removeMessage

Function to remove message from local channel state. Please note that this function is only for updating the local state, it doesn’t call the API for deleting message (channel.deleteMessage).

Reply

Component to render preview of parent of message for quoted reply.

retrySendMessage

Function to re-attempt sending failed message.

selectReaction

Full override of the reaction function on a message. This function must return a function that takes as a parameter the reactionType as a string. Please refer to the guide on customizing message actions for details.

setEditingState

Enables editing state for given message.

setQuotedMessageState

Enables quoted-reply state on given message.

shouldShowUnreadUnderlay

Boolean to enable/disable the message underlay background when there are unread messages in the Message List.

supportedReactions

List of reactions which can be added on message. Please refer to the guide on customizing reactions for details.

targetedMessage

Has the message id of the message which is to be highlighted. By default the value is undefined. As soon as the highlight time is out this is set to undefined.

updateMessage

Upserts a given message in local channel state. Please note that this function doesn’t call channel.sendMessage. Channel component uses this function for optimistic updates to message.

openPollCreationDialog

Function called immediately when the poll creation button is clicked in the attachment picker. Can be used to override the default behaviour of the poll creation UI appearing as a Modal.

If overridden, a payload is passed containing the sendMessage callback from MessageInputContext is passed, so that CreatePoll

hasCreatePoll

A boolean value that is responsible for controlling whether the poll creation button is visible or not.

Attachment

Component for rendering attachments in MessageList.

Available props:

• attachment {object}

AttachmentActions

Component to render additional actions on attachment. for example send, shuffle, cancel in case of Giphy.

AudioAttachment

Component for rendering the Audio Attachment

Card

Component to render any custom type of attachment. Please check the guides for Custom Attachment

CardCover

Component to render main body for Card component which renders custom type of attachment. Please check the guides for Custom Attachment.

CardFooter

Component to render footer for Card component which renders custom type of attachment. Please check the guides for Custom Attachment.

CardHeader

Component to render header for Card component which renders custom type of attachment. Please check the guides for Custom Attachment.

DateHeader

Component to render sticky date header within enclosed MessageList component.

FileAttachment

Component to render ‘file’ type attachment in MessageList.

FileAttachmentGroup

Component to render group of file type attachments, when there are multiple file type attachments in message.

FileAttachmentIcon

Component to render file icon for file type attachment.

FlatList

FlatList component for underlying MessageList component.

Gallery

Component to render ‘image’ type attachments in the MessageList.

Giphy

Component to render Giphy type attachments in MessageList.

giphyVersion

The Giphy version to render - check the keys of the Image Object for possible values.

InlineDateSeparator

Component to render inline date separators between messages which were created at a difference of more than a day.

InlineUnreadIndicator

Component to render inline separator in MessageList, to indicate the position of last read message in list.

MessageAvatar

Component to render avatar of sender for message, within MessageList. This component is only rendered for messages from other users.

MessageBounce

Component to render bounce action handler on click or long press of a Bounced message, within MessageList.

MessageContent

Component to render content of message including status, attachments, reactions etc., within MessageList.

MessageDeleted

Component to render deleted message.

MessageEditedTimestamp

Component to render message edited label in message when the message is clicked, within MessageList. This component is only rendered for messages from other users.

MessageError

Component to customize the message error component.

MessageFooter

Component to render footer for message, within MessageList.

MessageHeader

Component to render header for message, within MessageList.

MessageReplies

Component to show number of thread replies and avatars of members who replied on message

MessageRepliesAvatars

Component to show avatars of members who thread replied on message.

MessageSimple

Component to render a message within MessageList.

Please check guides section for Customizing Message UI for details.

MessageStatus

Component to render status of message, which includes time and read-receipts.

MessageSystem

Component to render system type messages. Purpose of system messages is to inform user about changes to channel. System messages are part of message history, and have a property type set as system. You can add system messages within message history in following scenarios:

• A user gets added to or removed from channel
• A user accepts invite to join a channel
• Channel is updated

MessageText

Component to render text of message. By default, we use Simple Markdown package to render the text content of message. If you decide to use this prop, please be aware that you will need to handle the markdown rendering yourself.

OverlayReactionList

Reaction selector component displayed within the message overlay when user long presses a message.

ReactionList

Component to render list of reactions at top of message bubble.

ScrollToBottomButton

Component to render a button which when pressed, scrolls the message list to bottom.

TypingIndicator

Component to render typing indicator within enclosed MessageList component.

TypingIndicatorContainer

Component to render container in which typing indicator gets rendered within enclosed MessageList component.

UrlPreview

Component to render preview of URLs in MessageList.

VideoThumbnail

Component to render the video thumbnail for video attachments in MessageList.

PollContent

A Component prop used to render the content of the Poll component in MessageList.

The component has full access to the entire Poll reactive state through the usePollState hook.

Props

PollHeader

A Component prop used to render the header of the PollContent component.

PollButtons

A Component prop used to render the buttons of the PollContent component.