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

ReactionList

ReactionList component is used to display the reactions added to a message right on top of it.

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

Basic Usage

Use case: Override the background color on the reaction list container.

import { Channel, ReactionList } from 'stream-chat-react-native';

const ReactionListWithCustomBackground = () => <ReactionList fill={'#00DDD'} stroke={'#fffff'} />

<Channel ReactionList={ReactionListWithCustomBackground} />

Props

messageContentWidth

Width of message content. This helps ReactionList align itself on the front-edge of the message content. This value gets computed in MessageContent once the content gets loaded.

Type
number

alignment

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

Type	Default
enum(‘right’, ‘left’)	‘right’

fill

Background color for reaction list container when alignment is left.

Type
string

onLongPress

Default long press handler for message UI.

Type
function

message

Message object

Type
object

`onPress`

Default press handler for message UI.

Type
function

reactions

List of reactions added to the message.

[
  {
    own: true,
    type: "love",
  },
  {
    own: false,
    type: "haha",
  },
];

Type
array

reactionSize

Dimensions for each reaction icon.

Type
number

showMessageOverlay

Function to open the message action overlay. This function gets called when user long presses a message.

Type
function

stroke

Background color for reaction list container when alignment is right.

Type
string

supportedReactions

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

Type	Default
array	reactionData

`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.

Type
string

OverlayReactions