Skip to content

feat: allow to customize ChannelListHeader #3234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MartinCupela merged 1 commit into from
Jul 6, 2026
+4 −1
Merged

feat: allow to customize ChannelListHeader #3234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/components/ChannelList/ChannelList.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ import {
import { moveChannelUpwards } from './utils';
import type { TranslationContextValue } from '../../context/TranslationContext';
import type { PaginatorProps } from '../../types/types';
import { ChannelListHeader } from './ChannelListHeader';
import { ChannelListHeader as DefaultChannelListHeader } from './ChannelListHeader';
import { useStableId } from '../UtilityComponents/useStableId';

const DEFAULT_FILTERS = {};
Expand Down Expand Up @@ -194,6 +194,7 @@ const UnMemoizedChannelList = (props: ChannelListProps) => {
useImageFlagEmojisOnWindows,
} = useChatContext('ChannelList');
const {
ChannelListHeader = DefaultChannelListHeader,
ChannelListUI = DefaultChannelListUI,
NotificationList = DefaultNotificationList,
Search = DefaultSearch,
Expand Down
2 changes: 2 additions & 0 deletions src/context/ComponentContext.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@ export type ComponentContextValue = {
CalloutDialog?: React.ComponentType<CalloutDialogProps>;
/** Custom UI component shown instead of the image when it fails to load, defaults to and accepts same props as: [ImagePlaceholder](https://github.com/GetStream/stream-chat-react/blob/master/src/components/BaseImage/ImagePlaceholder.tsx) */
ImagePlaceholder?: React.ComponentType<ImagePlaceholderProps>;
/** Custom UI component to display the header of the `ChannelList`, defaults to and accepts same props as: [ChannelListHeader](https://github.com/GetStream/stream-chat-react/blob/master/src/components/ChannelList/ChannelListHeader.tsx) */
ChannelListHeader?: React.ComponentType;
/** Custom UI component to display the container for the queried channels, defaults to and accepts same props as: [ChannelListUI](https://github.com/GetStream/stream-chat-react/blob/master/src/components/ChannelList/ChannelListUI.tsx) */
ChannelListUI?: React.ComponentType<ChannelListUIProps>;
/** Custom UI component to display set of action buttons within `ChannelListItemUI` component, accepts same props as: [ChannelListItemActionButtons](https://github.com/GetStream/stream-chat-react/blob/master/src/components/ChannelList/ChannelListItemActionButtons.tsx) */
Expand Down