| title | Message Composer |
|---|
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.
The following code snippet illustrates how you can directly incorporate the CometChatMessageComposer component into your app.
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.
The onSendButtonPress 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.
This action doesn't change the behavior of the component but rather listens for any errors that occur in the CometChatMessageComposer component.
Function triggered whenever the message input's text value changes, enabling dynamic text handling.
```tsx import { CometChatMessageComposer } from "@cometchat/chat-uikit-react-native"; //code const onTextChange = (text: string) => { //code }; return ( ); ```MessageComposer component does not have any available filters.
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 list of events emitted by the Messages component is as follows.
| Event | Description |
|---|---|
| ccMessageSent | Triggers whenever a loggedIn user sends any message, it will have two states such as: inprogress, success & error |
| ccMessageEdited | Triggers whenever a loggedIn user edits any message from the list of messages. It will have two states such as: inprogress, success & error |
| ccMessageLiveReaction | Triggers whenever a loggedIn clicks on live reaction |
Adding CometChatMessageEvents Listener's
CometChatUIEventHandler.addMessageListener("MESSAGE_LISTENER_ID", { ccMessageSent: (item) => { //code }, });
CometChatUIEventHandler.addMessageListener("MESSAGE_LISTENER_ID", { ccMessageEdited: (item) => { //code }, });
CometChatUIEventHandler.addMessageListener("MESSAGE_LISTENER_ID", { ccMessageLiveReaction: (item) => { //code }, });
</Tab>
</Tabs>
***
Removing `CometChatMessageEvents` Listener's
<Tabs>
<Tab title="JavaScript">
```js
import { CometChatUIEventHandler } from "@cometchat/chat-uikit-react-native";
CometChatUIEventHandler.removeMessageListener("MESSAGE_LISTENER_ID");
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.
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.
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
| Property | Description | Code |
|---|---|---|
| user | Used to pass user object of which header specific details will be show | user={chatUser} |
| group | Used to pass group object of which header specific details will be shown | group={chatGroup} |
| disableTypingEvents | Used to disable/enable typing events , default false | disableTypingEvents={true} |
| disableSoundForOutgoingMessages | Used to toggle sound for outgoing messages | disableSoundForOutgoingMessages={true} |
| initialComposertext | Used to set predefined text | initialComposertext="Your custom text" |
| customSoundForOutgoingMessage | Used to give custom sounds to outgoing messages | customSoundForOutgoingMessage="your custom sound for messages" |
| hideVoiceRecordingButton | used to hide the voice recording option. | hideVoiceRecording={true} |
| hideCameraOption | toggle visibility of camera option from the attachment options. | hideCameraOption={true} |
| hideImageAttachmentOption | toggle visibility of image attachment options. | hideImageAttachmentOption={true} |
| hideVideoAttachmentOption | toggle visibility of video attachment options. | hideVideoAttachmentOption={true} |
| hideAudioAttachmentOption | toggle visibility of audio attachment options. | hideAudioAttachmentOption={true} |
| hideFileAttachmentOption | toggle visibility of file attachment options. | hideFileAttachmentOption={true} |
| hidePollsAttachmentOption | toggle visibility of file polls attachment options. | hidePollsAttachmentOption={true} |
| hideCollaborativeDocumentOption | toggle visibility of file Collaborative Document Option. | hideCollaborativeDocumentOption={true} |
| hideCollaborativeWhiteboardOption | toggle visibility of file Collaborative Whiteboard Option. | hideCollaborativeWhiteboardOption={true} |
| hideAttachmentButton | toggle visibility of hide attachment option. | hideAttachmentButton={true} |
| hideStickersButton | toggle visibility of hide stickers option. | hideStickersButton={true} |
| hideSendButton | toggle visibility of send button option. | hideSendButton={true} |
| hideAuxiliaryButtons | toggle visibility of Auxiliary button option. | hideAuxiliaryButtons={true} |
| disableMentions | Sets whether mentions in text should be disabled. Processes the text formatters If there are text formatters available and the disableMentions flag is set to true, it removes any formatters that are instances of CometChatMentionsFormatter. | disableMentions={true} |
| disableMentionAll | Controls whether group mentions like @all appear in suggestions. | disableMentionAll={true} |
| mentionAllLabel | Allows setting a custom alias label for group mentions (@channel, @everyone, etc.). | mentionAllLabel="all" |
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.
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
```tsx import { CometChatMessageComposer, CometChatTextFormatter, CometChatMentionsFormatter, } from "@cometchat/chat-uikit-react-native"; import { CometChat } from "@cometchat/chat-sdk-react-native"; //code const getTextFomatters = () => { const textFormatters: CometChatTextFormatter[] = []; const mentionsFormatter = new CometChatMentionsFormatter(); mentionsFormatter.setMentionsStyle({ textStyle: { color: "#D6409F", }, selfTextStyle: { color: "#30A46C", }, }); textFormatters.push(mentionsFormatter); return textFormatters; }; return ( ); ```Example
By using attachmentOptions, you can set a list of custom MessageComposerActions for the MessageComposer Component. This will override the existing list of MessageComposerActions.
Example
You can insert a custom view into the MessageComposer component to add additional functionality using the following method.
```tsx import { CometChat } from "@cometchat/chat-sdk-react-native"; import { CometChatMessageComposer } from "@cometchat/chat-uikit-react-native"; //codeconst styles = StyleSheet.create({ button: { height: 25, width: 25, borderRadius: 0, backgroundColor: "transparent", }, image: { height: 23, width: 24, tintColor: "#7E57C2", }, });
const customAuxiliaryButtonView = ({
user,
group,
composerId,
}: {
user?: CometChat.User,
group?: CometChat.Group,
composerId: string | number,
}): JSX.Element => {
return (
<TouchableOpacity
style={styles.button}
onPress={() => {
/* code */
}}
>
);
};
return ( );
</Tab>
</Tabs>
Please note that the MessageComposer Component utilizes the AuxiliaryButton to provide sticker functionality. Overriding the AuxiliaryButton will subsequently replace the sticker functionality.
**Example**
<Frame>
<img src="/images/673c7c47-message_composer_auxiliary_button_view-d7be5a9bcabce2d9260e8338658c8fc7.png" />
</Frame>
***
#### SendButtonView
You can set a custom view in place of the already existing send button view. Using the following method.
<Tabs>
<Tab title="App.tsx">
```tsx
import { CometChat } from "@cometchat/chat-sdk-react-native";
import { CometChatMessageComposer } from "@cometchat/chat-uikit-react-native";
//code
const styles = StyleSheet.create({
button: {
height: 25,
width: 25,
borderRadius: 0,
backgroundColor: "transparent",
},
image: {
height: 23,
width: 24,
tintColor: "#7E57C2",
},
});
const customSendButtonView = ({
user,
group,
composerId,
}: {
user?: CometChat.User,
group?: CometChat.Group,
composerId: string | number,
}): JSX.Element => {
return (
<TouchableOpacity
style={styles.button}
onPress={() => {
/* code */
}}
>
<Image source={SendButtonIcon} style={styles.image} />
</TouchableOpacity>
);
};
return (
<CometChatMessageComposer
group={group}
SendButtonView={customSendButtonView}
/>
);
Example
You can set custom headerView to the MessageComposer component using the following method
```tsx import { CometChat } from "@cometchat/chat-sdk-react-native"; import { CometChatMessageComposer } from "@cometchat/chat-uikit-react-native"; //code const viewStyle: StyleProp = { flexDirection: "row", alignItems: "flex-start", justifyContent: "center", padding: 5, borderColor: "black", borderWidth: 1, backgroundColor: "white", borderRadius: 10, margin: 2, marginLeft: 7.4, height: 30, width: "95.5%", };const customHeaderView = ({ user, group, }: { user?: CometChat.User, group?: CometChat.Group, }) => { return ( <Text style={{ color: "#6851D6", fontWeight: "bold" }}>Chat Bot ); };
return ( );
</Tab>
</Tabs>
**Example**
<Frame>
<img src="/images/dbb04a8b-message_composer_header_view-11ddf1d50aa74a8868351007037451f9.png" />
</Frame>