Reactions

The SDK comes with built-in support for adding reactions to messages. The component library provides three default components to enable reaction selection and display:

• ReactionSelector - allows the connected user to select a reaction on a message
• ReactionsList (and ReactionsListModal) - displays the reactions added to a message
• SimpleReactionsList - displays a minimal list of the reactions added to a message

Sorting reactions

By default, reactions are sorted alphabetically by type. You can change this behavior by passing the sortReactions prop to the MessageList (or VirtualizedMessageList).

In this example, we sort the reactions in the descending order by the number of users:

function sortByReactionCount(a, b) {
  return b.reactionCount - a.reactionCount;
}

<Chat client={client}>
  <Channel
    channel={channel}
    ReactionSelector={CustomReactionSelector}
    ReactionsList={CustomReactionsList}
  >
    <MessageList sortReactions={sortByReactionCount} />
    <MessageInput />
  </Channel>
</Chat>;

Similarly, the sortReactionDetails prop can be passed to the MessageList (or VirtualizedMessageList) to sort the list of reacted users. The default implementation used by the reactions list modal dialog sorts users alphabetically by name.

For better performance, keep the sorting functions memoized with useCallback, or declare it in either global or module scope.

Customization

See Reactions Customization guide on how to change default reactions or how to replace default ReactionsList and ReactionSelector components.

ReactionSelector Props

Avatar

Custom UI component to display a user’s avatar.

detailedView

If true, shows the user’s avatar with the reaction.

handleReaction

Function that adds/removes a reaction on a message (overrides the function coming from MessageContext).

latest_reactions

An array of the reaction objects to display in the list (overrides message.latest_reactions from MessageContext).

own_reactions

An array of own reaction objects to display in the list (overrides message.own_reactions from MessageContext).

reaction_groups

An object that keeps track of the reactions on a message (overrides message.reaction_groups from MessageContext).

reactionOptions

A list of the currently supported reactions on a message.

reverse

If true, adds a CSS class that reverses the horizontal positioning of the selector.

ReactionsList Props

handleFetchReactions

Function that loads the message reactions (overrides the function coming from MessageContext).

The default implementation of handleFetchReactions, provided via the MessageContext, limits the number of loaded reactions to 1200. Use this prop to provide your own loading implementation:

const MyCustomReactionsList = (props) => {
  const { channel } = useChannelStateContext();
  const { message } = useMessageContext();

  function fetchReactions() {
    return channel.getReactions(message.id, { limit: 42 });
  }

  return <ReactionsList handleFetchReactions={fetchReactions} />;
};

onClick

Custom on click handler for an individual reaction in the list (overrides the function coming from MessageContext).

own_reactions

An array of the own reaction objects to distinguish own reactions visually (overrides message.own_reactions from MessageContext).

reaction_groups

An object that keeps track of the reactions on a message (overrides message.reaction_groups from MessageContext).

reactionOptions

A list of the currently supported reactions on a message.

reactions

An array of the reaction objects to display in the list (overrides message.latest_reactions from MessageContext).

reverse

If true, adds a CSS class that reverses the horizontal positioning of the selector.

sortReactionDetails

Comparator function to sort the list of reacted users. Should have the same signature as an array’s sort method. This prop overrides the function stored in MessageContext.

sortReactions

Comparator function to sort reactions. Should have the same signature as an array’s sort method. This prop overrides the function stored in MessageContext.

SimpleReactionsList Props

handleFetchReactions

Function that loads the message reactions (overrides the function coming from MessageContext).

handleReaction

Function that adds/removes a reaction on a message (overrides the function coming from MessageContext).

own_reactions

An array of the own reaction objects to distinguish own reactions visually (overrides message.own_reactions from MessageContext).

reaction_groups

An object that keeps track of the reactions on a message (overrides message.reaction_groups from MessageContext).

reactionOptions

A list of the currently supported reactions on a message.

reactions

An array of the reaction objects to display in the list (overrides message.latest_reactions from MessageContext).