Join Protected Group
Overview
CometChatJoinGroup
is a Component used to set up a screen that shows the functionality to join a password protected group, featuring the functionality to join a password-protected group, where users can join a single password-protected group at a time.
The Groups component is composed of the following BaseComponents:
Components | Description |
---|---|
cometchat-button | This component represents a button with optional icon and text. |
cometchat-label | This component provides descriptive information about the associated UI element. |
cometchat-input | This component allows users to enter or provide data or information within a web form or interface. |
Usage
Integration
The following code snippet illustrates how you can directly incorporate the Join Group component into your Application.
- JoinProtectedGroupDemo.tsx
- App.tsx
import React from "react";
import { createComponent } from "@lit-labs/react";
import { CometChatJoinGroup } from "@cometchat/chat-uikit-react";
const JoinProtectedGroupDemo = () => {
const [chatGroup, setChatGroup] = React.useState<
CometChat.Group | undefined
>();
React.useEffect(() => {
CometChat.getGroup("uid").then((group) => {
setChatGroup(group);
});
}, []);
const JoinGroup = createComponent({
tagName: "cometchat-join-group",
elementClass: CometChatJoinGroup,
react: React,
});
return <JoinGroup group={chatGroup} />;
};
export default JoinProtectedGroupDemo;
import { JoinProtectedGroupDemo } from "./JoinProtectedGroupDemo";
export default function App() {
return (
<div className="App">
<JoinProtectedGroupDemo />
</div>
);
}
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. joinClick
The joinClick
action is activated when you click the join Group button. This returns the join groups.
You can override this action using the following code snippet.
- TypeScript
- JavaScript
import React from "react";
import { createComponent } from "@lit-labs/react";
import { CometChatJoinGroup } from "@cometchat/chat-uikit-react";
const JoinProtectedGroupDemo = () => {
const [chatGroup, setChatGroup] = React.useState<
CometChat.Group | undefined
>();
React.useEffect(() => {
CometChat.getGroup("uid").then((group) => {
setChatGroup(group);
});
}, []);
const JoinGroup = createComponent({
tagName: "cometchat-join-group",
elementClass: CometChatJoinGroup,
react: React,
});
function handleJoinClick(group: CometChat.Group, password: string): void {
console.log("Your Custom on join click actions");
}
return <JoinGroup group={chatGroup} joinClick={handleJoinClick} />;
};
export default JoinProtectedGroupDemo;
import React, { useEffect, useState } from "react";
import { createComponent } from "@lit-labs/react";
import { CometChatJoinGroup } from "@cometchat/chat-uikit-react";
const JoinProtectedGroupDemo = () => {
const [chatGroup, setChatGroup] = useState(null);
useEffect(() => {
CometChat.getGroup("uid").then((group) => {
setChatGroup(group);
});
}, []);
const JoinGroup = createComponent({
tagName: "cometchat-join-group",
elementClass: CometChatJoinGroup,
react: React,
});
function handleJoinClick(group, password) {
console.log("Your Custom on join click actions");
}
return <JoinGroup group={chatGroup} joinClick={handleJoinClick} />;
};
export default JoinProtectedGroupDemo;
2. errorCallback
This action doesn't change the behavior of the component but rather listens for any errors that occur in the Groups component.
- TypeScript
- JavaScript
import React from "react";
import { createComponent } from "@lit-labs/react";
import { CometChatJoinGroup } from "@cometchat/chat-uikit-react";
const JoinProtectedGroupDemo = () => {
const [chatGroup, setChatGroup] = React.useState<
CometChat.Group | undefined
>();
React.useEffect(() => {
CometChat.getGroup("uid").then((group) => {
setChatGroup(group);
});
}, []);
const JoinGroup = createComponent({
tagName: "cometchat-join-group",
elementClass: CometChatJoinGroup,
react: React,
});
const handleOnError = ()=>{
console.log("error");
}
return <JoinGroup group={chatGroup} errorCallback={handleOnError} />;
};
export default JoinProtectedGroupDemo;
import React, { useEffect, useState } from "react";
import { createComponent } from "@lit-labs/react";
import { CometChatJoinGroup } from "@cometchat/chat-uikit-react";
const JoinProtectedGroupDemo = () => {
const [chatGroup, setChatGroup] = useState(null);
useEffect(() => {
CometChat.getGroup("uid").then((group) => {
setChatGroup(group);
});
}, []);
const JoinGroup = createComponent({
tagName: "cometchat-join-group",
elementClass: CometChatJoinGroup,
react: React,
});
const handleOnError = ()=>{
console.log("error");
}
return <JoinGroup group={chatGroup} errorCallback={handleOnError} />;
};
export default JoinProtectedGroupDemo;
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 Join Group
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.
Events emitted by the Join Group component is as follows.
Event | Description |
---|---|
ccGroupMemberJoined | Triggers when the user joined a protected group successfully |
- Add Listener
const ccGroupMemberJoined = CometChatGroupEvents.ccGroupMemberJoined.subscribe(
(item: IGroupMemberJoined) => {
//Your Code
}
);
- Remove Listener
ccGroupMemberJoined?.unsubscribe();
Customization
To fit your app's design requirements, you can customize the appearance of the Join Groups 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. JoinGroup Style
You can set the JoinGroupStyle
to the Join Group
Component to customize the styling.
- TypeScript
- JavaScript
import React from "react";
import { createComponent } from "@lit-labs/react";
import {
CometChatJoinGroup,
JoinGroupStyle,
} from "@cometchat/chat-uikit-react";
const JoinProtectedGroupDemo = () => {
const [chatGroup, setChatGroup] = React.useState<
CometChat.Group | undefined
>();
React.useEffect(() => {
CometChat.getGroup("uid").then((group) => {
setChatGroup(group);
});
}, []);
const JoinGroup = createComponent({
tagName: "cometchat-join-group",
elementClass: CometChatJoinGroup,
react: React,
});
const joinGroupStyle = new JoinGroupStyle({
background: "#d1b2ed",
joinButtonBackground: "#8625db",
joinButtonTextColor: "#000000",
passwordInputTextColor: "#000000",
titleTextColor: "#000000",
passwordInputPlaceholderTextColor: "#000000",
});
return <JoinGroup group={chatGroup} joinGroupStyle={joinGroupStyle} />;
};
export default JoinProtectedGroupDemo;
import React, { useEffect, useState } from "react";
import { createComponent } from "@lit-labs/react";
import {
CometChatJoinGroup,
JoinGroupStyle,
} from "@cometchat/chat-uikit-react";
const JoinProtectedGroupDemo = () => {
const [chatGroup, setChatGroup] = useState(null);
useEffect(() => {
CometChat.getGroup("uid").then((group) => {
setChatGroup(group);
});
}, []);
const JoinGroup = createComponent({
tagName: "cometchat-join-group",
elementClass: CometChatJoinGroup,
react: React,
});
const joinGroupStyle = new JoinGroupStyle({
background: "#d1b2ed",
joinButtonBackground: "#8625db",
joinButtonTextColor: "#000000",
passwordInputTextColor: "#000000",
titleTextColor: "#000000",
passwordInputPlaceholderTextColor: "#000000",
});
return <JoinGroup group={chatGroup} joinGroupStyle={joinGroupStyle} />;
};
export default JoinProtectedGroupDemo;
List of properties exposed by JoinGroupsStyle
Property | Description | Code |
---|---|---|
border | Used to set border | border?: string, |
borderRadius | Used to set border radius | borderRadius?: string; |
background | Used to set background colour | background?: string; |
height | Used to set height | height?: string; |
width | Used to set width | width?: string; |
boxShadow | Sets shadow effects around the element | boxShadow?: string; |
titleTextFont | Sets the font style for the title text | titleTextFont?: string; |
titleTextColor | Sets the color for the title text | titleTextColor?: string; |
errorTextFont | Sets the font style for error messages | errorTextFont?: string; |
errorTextColor | Sets the color for error messages | errorTextColor?: string; |
passwordInputTextFont | Sets the font style for password input | passwordInputTextFont?: string; |
passwordInputTextColor | Sets the color for password input text | passwordInputTextColor?: string; |
passwordInputPlaceholderTextFont | Sets the font style for password input placeholder text | passwordInputPlaceholderTextFont?: string; |
passwordInputPlaceholderTextColor | Sets the color for password input placeholder text | passwordInputPlaceholderTextColor?: string; |
passwordInputBackground | Sets the background color for password input field | passwordInputBackground?: string; |
passwordInputBorder | Sets the border style for password input field | passwordInputBorder?: string; |
passwordInputBorderRadius | Sets the border radius for password input field | passwordInputBorderRadius?: string; |
passwordInputBoxShadow | Sets shadow effects around the password input field | passwordInputBoxShadow?: string; |
joinButtonTextFont | Sets the font style for the join button | joinButtonTextFont?: string; |
joinButtonTextColor | Sets the color for the join button text | joinButtonTextColor?: string; |
joinButtonBackground | Sets the background color for the join button | joinButtonBackground?: string; |
joinButtonBorderRadius | Sets the border radius for the join button | joinButtonBorderRadius?: string; |
joinButtonBorder | Sets the border style for the join button | joinButtonBorder?: 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.
- TypeScript
- JavaScript
import React from "react";
import { createComponent } from "@lit-labs/react";
import { CometChatJoinGroup } from "@cometchat/chat-uikit-react";
const JoinProtectedGroupDemo = () => {
const [chatGroup, setChatGroup] = React.useState<
CometChat.Group | undefined
>();
React.useEffect(() => {
CometChat.getGroup("uid").then((group) => {
setChatGroup(group);
});
}, []);
const JoinGroup = createComponent({
tagName: "cometchat-join-group",
elementClass: CometChatJoinGroup,
react: React,
});
return (
<JoinGroup
group={chatGroup}
title="Your custom Title"
passwordInputPlaceholderText="Your Custom Placeholder Text"
joinButtonText="Your Custom Join Button Text"
/>
);
};
export default JoinProtectedGroupDemo;
import React, { useEffect, useState } from "react";
import { createComponent } from "@lit-labs/react";
import { CometChatJoinGroup } from "@cometchat/chat-uikit-react";
const JoinProtectedGroupDemo = () => {
const [chatGroup, setChatGroup] = useState(null);
useEffect(() => {
CometChat.getGroup("uid").then((group) => {
setChatGroup(group);
});
}, []);
const JoinGroup = createComponent({
tagName: "cometchat-join-group",
elementClass: CometChatJoinGroup,
react: React,
});
return (
<JoinGroup
group={chatGroup}
title="Your custom Title"
passwordInputPlaceholderText="Your Custom Placeholder Text"
joinButtonText="Your Custom Join Button Text"
/>
);
};
export default JoinProtectedGroupDemo;
Default:
Custom:
Property | Description | Code |
---|---|---|
title | Custom title for the component | title='Your Custom Title' |
joinButtonText | Custom text for the join group button | joinButtonText='Your Custom Join Group Button Text' |
passwordInputPlaceholderText | Custom placeholder text for password input field | passwordInputPlaceholderText='Your Custom Password Input Placeholder Text' |
errorText | Custom error state text | errorText='Your Custom Error Text' |
group | used to set the group | group={chatGroup} |
Advance
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 Join Group
component does not offer any advanced functionalities beyond this level of customization.