Skip to main content
Version: v4

Call Buttons

Overview

The Call Button is a Component provides users with the ability to make calls, access call-related functionalities, and control call settings. Clicking this button typically triggers the call to be placed to the desired recipient.

Image

Usage

Integration

import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatCallButtons } from "@cometchat/chat-uikit-react";
import React from "react";

const CallButtonDemo = () => {
const [chatUser, setChatUser] = React.useState<CometChat.User>();
React.useEffect(() => {
CometChat.getUser("richard-uid").then((user) => {
setChatUser(user);
});
}, []);
return <CometChatCallButtons user={chatUser} />;
};

export default CallButtonDemo;

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

onVoiceCallClick is triggered when you click the voice call button of the Call Buttons component. You can override this action using the following code snippet.

OutgoingCallDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatCallButtons } from "@cometchat/chat-uikit-react";
import React from "react";

const CallButtonDemo = () => {
const [chatUser, setChatUser] = React.useState<CometChat.User>();
React.useEffect(() => {
CometChat.getUser("uid").then((user) => {
setChatUser(user);
});
}, []);

const handleOnVoiceCallClick = () => {
console.log("Your Custom on voice call click actions");
};
return (
<CometChatCallButtons
user={chatUser}
onVoiceCallClick={handleOnVoiceCallClick}
/>
);
};

export default CallButtonDemo;
2. onVideoCallClick

onVideoCallClick is triggered when you click the video call button of the Call Buttons component. You can override this action using the following code snippet.

OutgoingCallDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatCallButtons } from "@cometchat/chat-uikit-react";
import React from "react";

const CallButtonDemo = () => {
const [chatUser, setChatUser] = React.useState<CometChat.User>();
React.useEffect(() => {
CometChat.getUser("uid").then((user) => {
setChatUser(user);
});
}, []);

const handleOnVideoCallClick = () => {
console.log("Your Custom on video call click actions");
};
return (
<CometChatCallButtons
user={chatUser}
onVideoCallClick={handleOnVideoCallClick}
/>
);
};

export default CallButtonDemo;
3. onError

This action doesn't change the behavior of the component but rather listens for any errors that occur in the Call Button component.

OutgoingCallDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatCallButtons } from "@cometchat/chat-uikit-react";
import React from "react";

const CallButtonDemo = () => {
const [chatUser, setChatUser] = React.useState<CometChat.User>();
React.useEffect(() => {
CometChat.getUser("uid").then((user) => {
setChatUser(user);
});
}, []);

const handleOnError = () => {
console.log("Your Custom on error actions");
};
return <CometChatCallButtons user={chatUser} onError={handleOnError} />;
};

export default CallButtonDemo;

Filters

Filters allow you to customize the data displayed in a list within a Component. You can filter the list based on your specific criteria, allowing for a more customized. Filters can be applied using RequestBuilders of ChatSDK.

The Call Buttons component does not have any exposed 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 list of events emitted by the Call Buttons component is as follows.

EventDescription
ccCallRejectedThis event is triggered when the initiated call is rejected by the receiver.
ccCallEndedThis event is triggered when the initiated call successfully ends.
ccOutgoingCallThis event is triggered when the user initiates a voice/video call.
ccMessageSentThis event is triggered when the sent message is in transit and also when it is received by the receiver.

const ccCallRejected = CometChatCallEvents.ccCallRejected.subscribe(
(call: CometChat.Call) => {
//Your Code
}
);

const ccCallEnded = CometChatCallEvents.ccCallEnded.subscribe(
(call: CometChat.Call) => {
//Your Code
}
);

const ccOutgoingCall = CometChatCallEvents.ccOutgoingCall.subscribe(
(call: CometChat.Call) => {
//Your Code
}
);

const ccMessageSent = CometChatMessageEvents.ccMessageSent.subscribe(() => {
//Your Code
});

ccCallRejected?.unsubscribe();

ccCallEnded?.unsubscribe();

ccOutgoingCall?.unsubscribe();

ccMessageSent?.unsubscribe();

Customization

To fit your app's design requirements, you can customize the appearance of the Call Buttons 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. CallButtons Style

To customize the appearance, you can assign a CallButtonsStyle object to the Call Buttons component.

Image

Example

In this example, we are employing the callButtonsStyle.

OutgoingCallDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
CometChatCallButtons,
CallButtonsStyle,
} from "@cometchat/chat-uikit-react";
import React from "react";

const CallButtonDemo = () => {
const [chatUser, setChatUser] = React.useState<CometChat.User>();
React.useEffect(() => {
CometChat.getUser("uid").then((user) => {
setChatUser(user);
});
}, []);

const callButtonsStyle = new CallButtonsStyle({
background: "#e5c9f5",
height: "50px",
width: "400px",
border: "1px solid #f8f5fa",
buttonBackground: "#7735d4",
buttonBorderRadius: "10px",
videoCallIconTextColor: "#ffffff",
voiceCallIconTextColor: "#ffffff",
buttonPadding: "20px",
});
return (
<CometChatCallButtons user={chatUser} callButtonsStyle={callButtonsStyle} />
);
};

export default CallButtonDemo;

The following properties are exposed by CallButtonsStyle:

PropertyDescriptionCode
borderUsed to set borderborder?: string,
borderRadiusUsed to set border radiusborderRadius?: string;
backgroundUsed to set background colourbackground?: string;
heightUsed to set heightheight?: string;
widthUsed to set widthwidth?: string;
voiceCallIconTintUsed to set voice call icon tintvoiceCallIconTint?: string,
videoCallIconTintUsed to set video call icon tintvideoCallIconTint?: string;
voiceCallIconTextFontUsed to set voice call icon text fontvoiceCallIconTextFont?: string;
videoCallIconTextFontUsed to set video call icon text fontvideoCallIconTextFont?: string;
voiceCallIconTextColorUsed to set voice call icon text colorvoiceCallIconTextColor?: string;
videoCallIconTextColorUsed to set video call icon text colorvideoCallIconTextColor?: string;
buttonBackgroundUsed to set button background colorbuttonBackground?: string;
buttonBorderUsed to set button borderbuttonBorder?: string;
buttonBorderRadiusUsed to set button border radiusbuttonBorderRadius?: string;
buttonPaddingUsed to set button paddingbuttonPadding?: string;

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.

Here is a code snippet demonstrating how you can customize the functionality of the Call Buttons component.

OutgoingCallDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatCallButtons } from "@cometchat/chat-uikit-react";
import React from "react";

const CallButtonDemo = () => {
const [chatUser, setChatUser] = React.useState<CometChat.User>();
React.useEffect(() => {
CometChat.getUser("uid").then((user) => {
setChatUser(user);
});
}, []);

return (
<CometChatCallButtons
user={chatUser}
videoCallIconHoverText="Your Custom Video Call Icon Hover Text"
videoCallIconText="Your Custom Video Call Icon Text"
/>
);
};

export default CallButtonDemo;

Default:

Image

Custom:

Image

Below is a list of customizations along with corresponding code snippets

PropertyDescriptionCode
videoCallIconHoverTextUsed to set the custom text or tooltip displayed on the video call button on mouse over.videoCallIconHoverText='Your Custom Video Call Icon Hover Text'
voiceCallIconHoverTextUsed to set the custom text or tooltip displayed on the voice call button on mouse over.voiceCallIconHoverText='Your Custom Voice Call Icon Hover text'
videoCallIconTextUsed to set custom video call icon textvideoCallIconText='Your Custom Video Call Icon Text'
voiceCallIconTextUsed to set custom voice call icon textvoiceCallIconText='Your Custom Voice Call Icon Text'
videoCallIconURLUsed to set custom Icon for Video Call ButtonvideoCallIconURL='Custom Video Call Icon URL'
voiceCallIconURLUsed to set custom Icon for Voice Call ButtonvideoCallIconURL='Custom Voice Call Icon URL'
groupUsed to set the group object for Call Buttonsgroup={chatGroup}
userSets the user object for Call Buttonsuser={chatUser}

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.

the Call Buttons component does not offer any advanced functionalities beyond this level of customization.