Typing indicator
Typing indicator is a feature that allows users to know visually if another user in the channel is typing a message. The indicator UI appears in the ChannelHeader component of the Channel
module and in the ChannelPreview component of the ChannelList
module. The indicator remains visible until the user sends the message or deletes the text completely. If the user stops typing for more than 10 seconds, the indicator will also disappear.
In order to use the typing indicator feature, you must first create a channel and enable the chat service. Once chat is turned on, the typing indicator feature is turned on by default through the setUseTypingIndicator()
setter method of the ChannelFragment.Builder
class or ChannelHeaderComponent.Params
class. To learn how to allow users to chat in a channel, refer to the Channel module page.
How to use
While the typing indicator feature is turned on by default in the Channel
module, you need to set the feature's setter method to true
in the ChannelList
module. Implement the code below to turn on the typing indicator in a channel list view.
Customize the UI for typing indicator
The UI for typing indicator can be customized through the stringSet
, which is a set of strings used to compose the screen. Text strings for typing status can vary depending on the number of members typing in a channel.
- If one member is typing: “Member is typing...”
- If two members are simultaneously typing: “Member A and Member B are typing...”
- If more than two members are simultaneously typing: “Several people are typing...”
stringSet for ChannelHeader
The following table shows a customizable property of stringSet
that appears in the ChannelHeader
component.
Key | String | Description |
---|---|---|
TYPING_INDICATOR__IS_TYPING | is typing... | A text that indicates a channel member is typing a message in the message input field. |
TYPING_INDICATOR__AND | and | A text that separates two channel members when using |
TYPING_INDICATOR__ARE_TYPING | are typing... | A text that indicates two channel members are typing a message in the message input field. |
TYPING_INDICATOR__MULTIPLE_TYPING | Several people are typing... | A text that indicates more than two channel members are typing a message in the message input field. |