Skip to main content
Version: v3

MessageOverlayContext

MessageOverlayContext is a context provided by OverlayProvider, to provide values for message overlay. Message overlay shows up when user long presses a message.

Value#

setData#

Setter function for data.

Type
function

data#

This is an object with following keys:

  • alignment

{' '}

Sets if the message should be aligned to right or left side of list.

TypeDefault
enum('right', 'left')'right'
  • clientId

Id of the current user connected to the chat.

Type
string
  • files

{' '}

Array of file type attachments to be shown in the grouped UI component.

const files = message.attachments.filter(a => a.type === 'file');
Type
array
  • groupStyles

{' '}

Position of message in the group. A message group is a group of consecutive messages from the same user. groupStyles can be used to style the message as per their position in message group.

e.g. user avatar (to which message belongs to) is only showed for last (bottom) message in group.

Type
array of enum('top', 'bottom', 'middle', 'single')
  • handleReaction

{' '}

Function called when a reaction is selected in the message overlay, this is called on both the add and remove action. This function does not override the default behavior of the reaction being selected. Please refer to the guide on customizing message actions for details.

Type
function
ParameterDescription
messagemessage the action is called on
reactionTypestring designating the type of reaction
  • images

{' '}

Array of image type attachments on message.

const images = message.attachments.filter(a => a.type === 'image');
Type
array
  • message

{' '}

Message object

Type
object
  • messageActions

{' '}

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

TypeDefault
array | functionmessageActions
ParameterDescription
actionInfoan object containing the original actions and relevant message data
  • messageReactionTitle

Title for MessageReactions component.

TypeDefault
string"Message Reactions"
  • messagesContext

Entire value object of MessagesContext

  • onlyEmojis

{' '}

True if the message text only contains emojis and nothing else.

Type
boolean
  • otherAttachments

{' '}

All the attachments on the message except for types file and image.

Type
array
  • OverlayReactionList

{' '}

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

TypeDefault
componentOverlayReactionList
  • supportedReactions

{' '}

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

TypeDefault
arrayreactionData
  • threadList

{' '}

True if current message is part of a message thread.

Type
boolean

forwarded from OverlayProvider props
OverlayReactionList#

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

TypeDefault
componentOverlayReactionList

forwarded from OverlayProvider props
OverlayReactions#

List of reactions component within the message overlay.

TypeDefault
componentOverlayReactions

Did you find this page helpful?