List channel participants

A participant list is a complete list of users that are participants of an open channel. The channel participant list is created through OpenChannelParticipantsFragment.

Usage

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

TypeScript

import React, { useState } from 'react';
import { useSendbirdChat, createOpenChannelParticipantsFragment } from '@sendbird/uikit-react-native';
import { useOpenChannel } from "@sendbird/uikit-chat-hooks";

const OpenChannelParticipantsFragment = createOpenChannelParticipantsFragment();
const OpenChannelParticipantsScreen = ({ route: { params } }: any) => {
    const { sdk } = useSendbirdChat();
    const { channel } = useOpenChannel(sdk, params.channelUrl);
    if (!channel) return null;

    const navigateToBack = () => {};

    return (
        <OpenChannelParticipantsFragment
            channel={channel}
            onPressHeaderLeft={navigateToBack}
        />
    );
};

List of properties

The following table lists the properties of OpenChannelParticipantsFragment.

Properties

Required	Type	Description
channel	object	Specifies the open channel that the current user is a participant of.
onPressHeaderLeft	function	Specifies the prop to execute a custom navigation operation when the button on the top left corner of the header component is selected. By default, the screen goes back to the previous screen.

Optional	Type	Description
renderUser	ReactElement	Renders a customized view of the user profile.
sortComparator	function	Specifies the function to sort a list of users in the participant list screen. You can customize the sorting order by passing parameters to compare in the `sortComparator` method.

Context

OpenChannelParticipantsFragment uses UserListModule to display a list of participants of a channel. To store and handle data that are used to build the participant list screen, Sendbird Chat UIKit provides UserListContexts, which is comprised of two context objects: UserListContexts.Fragment and UserListContexts.List.

TypeScript

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

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

Fragment

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.

TypeScript

import { useContext } from 'react';
import { UserListContexts } from "@sendbird/uikit-react-native";

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

List

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.

TypeScript

import { useContext } from 'react';
import { UserListContexts } from "@sendbird/uikit-react-native";

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

Module components

A participant list screen is composed of three module components: header, participant list, and empty status. These components make up the UserListModule and are used to create and display the UI of the screen.

Header

The header component displays the title of OpenChannelParticipantsFragment, a button on the top left corner. By default, the left button allows you to go back to the previous screen and when selected, the onPressHeaderLeft navigation prop is called.

List of properties

The following table lists the properties of UserListModule.Header.

Property name	Type	Description
onPressHeaderLeft	function	Specifies the prop to execute a custom navigation operation when the button on the top left corner of the header component is selected. By default, the screen goes back to the previous screen.
onPressHeaderRight	function	Specifies the prop to receive callback when the button on the top right corner of the header component is selected.
right	ReactElement	Renders a customized view of the right button component in the header.

List

The list component shows profile images and names of all participants of the channel.

List of properties

The following table lists the properties of UserListModule.List.

Property name	Type	Description
users	array of objects	Specifies a list of all users that appear on the participant list.
ListEmptyComponent	ReactElement	Renders a customized view of the empty participant list.
renderUser	function	Renders a customized view of the user profile.

StatusEmpty

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

Customization

In the participant list key function, you can customize the default OpenChannelParticipantsFragment to change various elements of the screen such as the module and its components. See the code below on how to render the participant list using a custom module component.

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

TypeScript

import React, { useState } from 'react';
import { useSendbirdChat, createOpenChannelParticipantsFragment, UserActionBar } from '@sendbird/uikit-react-native';
import { useBottomSheet } from '@sendbird/uikit-react-native-foundation';
import { useOpenChannel } from "@sendbird/uikit-chat-hooks";

const OpenChannelParticipantsFragment = createOpenChannelParticipantsFragment();
const OpenChannelParticipantsScreen = ({ route: { params } }: any) => {
    const { openSheet } = useBottomSheet();

    const { sdk } = useSendbirdChat();
    const { channel } = useOpenChannel(sdk, params.channelUrl);
    if (!channel) return null;

    const navigateToBack = () => {};

    return (
        <OpenChannelParticipantsFragment
            channel={channel}
            onPressHeaderLeft={navigateToBack}
            renderUser={(user) => {
                return (
                    <UserActionBar
                        disabled={false}
                        name={user.nickname}
                        uri={user.profileUrl}
                        muted={user.isMuted}
                        onPressActionMenu={() => {
                            openSheet({
                                sheetItems: [
                                    {
                                        title: 'Ban',
                                        titleColor: 'red',
                                        onPress: () => channel.banUser(user, 30, 'ban'),
                                    },
                                    { title: 'Mute', onPress: () => channel.muteUser(user) },
                                ],
                            });
                        }}
                    />
                );
            }}
        />
    );
};

On this page

Usage Context

Fragment List

Module components

Header List StatusEmpty

Customization

Sample app