List banned users in open channel

A banned user list in an open channel is a complete list of users that are banned from the channel. Only an operator of the channel can ban users. The banned user list is created through OpenChannelBannedUsersFragment.

To view the image in full screen, click on the

You can start building a banned user list screen by first creating a fragment. To do so, call the createOpenChannelBannedUsersFragment method. Once an open channel banned users 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 React from 'react';

import { useOpenChannel } from '@sendbird/uikit-chat-hooks';
import { createOpenChannelBannedUsersFragment, useSendbirdChat } from '@sendbird/uikit-react-native';

const OpenChannelBannedUsersFragment = createOpenChannelBannedUsersFragment();
const OpenChannelBannedUsersScreen = ({ route: { params } }: any) => {
    const { sdk } = useSendbirdChat();
    const { channel } = useOpenChannel(sdk, params.channelUrl);
    if (!channel) return null;
    
    const navigateToBack = () => {};
    
    return <OpenChannelBannedUsersFragment channel={channel} onPressHeaderLeft={navigateToBack} />;
};

The following table lists the properties of OpenChannelBannedUsersFragment.

To store and handle data that are used to build the banned user list screen, Sendbird Chat UIKit provides OpenChannelBannedUsersContexts, which includes the Fragment context object.

type OpenChannelBannedUsersContextsType = {
    Fragment: React.Context<{
        headerTitle: string;
        channel: Sendbird.OpenChannel;
    }>;
};

To retrieve data from the Chat SDK on the current user's banned user list screen, you need to call the useContext hook and pass OpenChannelBannedUsersContexts.Fragment as a parameter. The data is then used to render the open channel banned users module and its components.

const Component = () => {
    const {
        headerTitle,
        channel,
    } = useContext(OpenChannelBannedUsersContexts.Fragment);
};

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

The header component displays the title of the open channel, a button on the top left corner, and another 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 right button is selected, onPressHeaderRight is called and the open channel settings screen appears.

The following table lists the properties of OpenChannelBannedUsersModule.Header.

The list component shows a list of profile images and names of banned users of the channel.

The following table lists the properties of OpenChannelBannedUsersModule.List.

The StatusLoading component lets the user know if the list is loading.

The StatusEmpty component lets the user know if the list is empty.

The StatusError component lets the user know if the list fetching has failed.

In the list banned users in open channel key function, you can customize the default OpenChannelBannedUsersFragment to change various elements of the screen such as the module and its components. See the code below on how to replace the default header component with a custom header component in OpenChannelBannedUsersFragment as an example.

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

const OpenChannelBannedUsersFragment = createOpenChannelBannedUsersFragment({
    Header: () => <MyHeader />, // Use custom header
});
const OpenChannelBannedUsersScreen = ({ route: { params } }: any) => {
    const { sdk } = useSendbirdChat();
    const { channel } = useOpenChannel(sdk, params.channelUrl);
    if (!channel) return null;
    
    const navigateToBack = () => {};
    
    return <OpenChannelBannedUsersFragment channel={channel} onPressHeaderLeft={navigateToBack} />;
};