Invite users

Users can invite new users to a channel through GroupChannelInviteFragment. All users are listed through pagination and members who already belong to the channel can't be selected. The user list can be customized to only include specific users.

To view the image in full screen, click on the

You can start building an invite user screen by first creating a fragment. To do so, call the createGroupChannelInviteFragment method. Once an invite user fragment is built, you need to set up the navigation props and register the screen to a navigation library. Refer to the code below.

import { useState } from 'react';
import { useSendbirdChat, createGroupChannelInviteFragment } from '@sendbird/uikit-react-native';
import type { SendbirdUser } from "@sendbird/uikit-utils";
import { useGroupChannel } from '@sendbird/uikit-chat-hooks';

const GroupChannelInviteFragment = createGroupChannelInviteFragment<SendbirdUser>();
const GroupChannelInviteScreen = ({ route: { params } }: any) => {
    const { sdk } = useSendbirdChat();
    const { channel } = useGroupChannel(sdk, params.channelUrl);
    if (!channel) return null;

    const navigateToBack = () => {};
    const navigateToGroupChannel = () => {};

    return (
        <GroupChannelInviteFragment
            channel={channel}
            onPressHeaderLeft={navigateToBack}
            onInviteMembers={navigateToGroupChannel}
        />
    );
};

The following table lists the properties of GroupChannelInviteFragment.

GroupChannelInviteFragment uses UserListModule to display a list of users that the current user can select and invite to a group channel. To store and handle data that are used to build the invite user screen, Sendbird UIKit provides UserListContexts, which is comprised of two context objects: UserListContexts.Fragment and UserListContexts.List.

type UserListContextsType<User> = {
    Fragment: React.Context<{
        headerTitle: string;
        headerRight: string;
    }>;

    List: React.Context<{
        selectedUsers: User[];
        setSelectedUsers: React.Dispatch<React.SetStateAction<User[]>>;
    }>;
};

To retrieve user list data from the Chat SDK, you need to call the useContext hook and pass UserListContexts.Fragment as a parameter. The data is then used to render the user list module.

const { headerTitle, headerRight } = useContext(UserListContexts.Fragment);

You can call the useContext hook and pass UserListContexts.List as a parameter to retrieve user list data from the Chat SDK. The data is then used to render the list component of UserListModule.

const { selectedUsers, setSelectedUsers } = useContext(UserListContexts.List);

An invite user screen is composed of five module components: header, list, loading status, empty status, and error status. These components make up the UserListModule and are used to create and display the UI of the screen.

The header component displays the title of GroupChannelInviteFragment, a button on the top left corner, and a button on the top right corner. By default, the left button allows you to go back to the previous screen and when selected, the onPressHeaderLeft navigation prop is called. When the invite button on the right is selected, the selected users are invited to the channel. The onInviteMembers function is called and the group channel screen appears.

The following table lists the properties of UserListModule.Header.

The list component shows a list of users' profile images, names, and selectable checkboxes. By default, all users registered to the Sendbird application are retrieved in reverse chronological order of creation. However, members that already belong to the channel are not shown on the list.

The following table lists the properties of UserListModule.List.

The StatusLoading component exists in the UserListModule and lets the user know if the list is loading.

The StatusEmpty component exists in the UserListModule and lets the user know if the list is empty.

The StatusError component exists in the UserListModule and lets the user know if the list fetching failed.

In the invite user key function, you can customize the default GroupChannelInviteFragment to change various elements of the screen such as the module and its components. See the code below on how to replace the default user list query with a custom user list query as an example. The returned User instance from a custom user list query is different from the default Sendbird.User instance. This means you would need to implement your own renderUser props when calling queryCreator with the custom user list query.

Note: To learn more about how to customize a fragment, go to the fragment page.

import { UserStruct } from '@sendbird/uikit-utils';
import { useGroupChannel, CustomQuery } from '@sendbird/uikit-chat-hooks';
import { useSendbirdChat, createGroupChannelInviteFragment } from '@sendbird/uikit-react-native';

interface MyAppUser extends UserStruct {
    userId: string;
    name: string;
    profile: string;
}

const myAppUserQueryCreator = () => {
    const query = createMyAppUserQuery();
    return new CustomQuery<MyAppUser>({
        hasNext(): boolean {
            return query.hasNext;
        },
        isLoading(): boolean {
            return query.isLoading;
        },
        next() {
            return query.next();
        },
    });
};

const GroupChannelInviteFragment = createGroupChannelInviteFragment<MyAppUser>();
const GroupChannelInviteScreen = ({ route: { params } }: any) => {
    const { sdk } = useSendbirdChat();
    const { channel } = useGroupChannel(sdk, params.channelUrl);
    if (!channel) return null;

    const navigateToBack = () => {};
    const navigateToGroupChannel = () => {};

    return (
        <GroupChannelInviteFragment
            channel={channel}
            onPressHeaderLeft={navigateToBack}
            onInviteMembers={navigateToGroupChannel}
            queryCreator={myAppUserQueryCreator}
            renderUser={(user, selectedUsers, setSelectedUsers) => {
                const selected = selectedUsers.findIndex((u) => u.userId === user.userId) > -1;
                return <MyAppUserBar selected={selected} user={user} onToggle={setSelectedUsers} />;
            }}
        />
    );
};