Skip to main content

Overview

MessageComposer is a Component that enables users to write and send a variety of messages, including text, image, video, and custom messages. Features such as Live Reaction, Attachments, and Message Editing are also supported by it.
MessageComposer is comprised of the following Base Components:

Usage

Integration

The following code snippet illustrates how you can directly incorporate the MessageComposer component into your layout.xml file.
The MessageComposer is responsible for managing runtime permissions. To ensure the ActivityResultLauncher is properly initialized, its object should be created in the the onCreate state of an activity. To ensure that the composer is loaded within the fragment, it is important to make sure that the fragment is loaded in the onCreate state of the activity.

Actions

Actions dictate how a component functions. They are divided into two types: Predefined and User-defined. You can override either type, allowing you to tailor the behavior of the component to fit your specific needs.
1. OnSendButtonClick
The OnSendButtonClick event gets activated when the send message button is clicked. It has a predefined function of sending messages entered in the composer EditText. However, you can overide this action with the following code snippet.
2. onError
This action doesn’t change the behavior of the component but rather listens for any errors that occur in the MessageList component.
YourActivity.java

Filters

MessageComposer component does not have any available filters.

Events

Events are emitted by a Component. By using event you can extend existing functionality. Being global events, they can be applied in Multiple Locations and are capable of being Added or Removed. The MessageComposer Component does not emit any events of its own.

Customization

To fit your app’s design requirements, you can customize the appearance of the MessageComposer component. We provide exposed methods that allow you to modify the experience and behavior according to your specific needs.

Style

Using Style you can customize the look and feel of the component in your app, These parameters typically control elements such as the color, size, shape, and fonts used within the component.
1. MessageComposer Style
To modify the styling, you can apply the MessageComposerStyle to the MessageComposer Component using the setStyle method.
The following properties are exposed by MessageComposerStyle:
2. MessageInput Style
To customize the styles of the MessageInput component within the MessageComposer Component, use the .setMessageInputStyle() method. For more details, please refer to MessageInput styles.
3. MediaRecorder Style
To customize the styles of the MediaRecorder component within the MessageComposer Component, use the .setMediaRecorderStyle() method. For more details, please refer to MediaRecorder styles.

Functionality

These are a set of small functional customizations that allow you to fine-tune the overall experience of the component. With these, you can change text, set custom icons, and toggle the visibility of UI elements.
Below is a list of customizations along with corresponding code snippets

Advanced

For advanced-level customization, you can set custom views to the component. This lets you tailor each aspect of the component to fit your exact needs and application aesthetics. You can create and define your views, layouts, and UI elements and then incorporate those into the component.

setTextFormatters

Assigns the list of text formatters. If the provided list is not null, it sets the list. Otherwise, it assigns the default text formatters retrieved from the data source. To configure the existing Mentions look and feel check out CometChatMentionsFormatter Example

AttachmentOptions

By using setAttachmentOptions(), you can set a list of custom MessageComposerActions for the MessageComposer Component. This will override the existing list of MessageComposerActions.
Example
In this example, we are overriding the existing MessageComposerActions List with Capture Photo, Go Live & Payments actions.

AuxiliaryButtonView

You can insert a custom view into the MessageComposer component to add additional functionality using the following method.
Please note that the MessageComposer Component utilizes the AuxiliaryButton to provide sticker functionality. Overriding the AuxiliaryButton will subsequently replace the sticker functionality. Example
In this example, we’ll be adding a custom SOS button with click functionality. You’ll first need to create a layout file and then inflate it inside the .setAuxiliaryButtonView() function.
auxiliary_button_layout.xml

SecondaryButtonView

You can add a custom view into the SecondaryButton component for additional functionality using the below method.
Please note that the MessageComposer Component uses the SecondaryButton to open the ComposerActionsList. Overriding the SecondaryButton will replace the ComposerActionsList functionality. Example
In this example, we’ll be adding a custom SOS button with click functionality. You’ll first need to create a layout file and then inflate it inside the .setSecondaryButtonView() function.
secondary_button_layout.xml

Set SendButtonView

You can set a custom view in place of the already existing send button view. Using the following method.
Example
send_button_layout.xml

HeaderView

You can set custom headerView to the MessageComposer component using the following method
Example
In the following example, we’re going to apply a mock smart reply view to the MessageComposer Component using the .setHeaderView() method.
custom_header_view_layout

FooterView

You can set a custom footer view to the MessageComposer component using the following method:
Example
In the following example, we’re going to apply a mock smart reply view to the MessageComposer Component using the .setFooterView() method.
custom_footer_view_layout