stream-chat-react
Version:
React components to create chat conversations or livestream style chat
23 lines (22 loc) • 1.13 kB
TypeScript
import type { RenderedMessage } from '../../utils';
export type UseUnreadMessagesNotificationParams = {
showAlways: boolean;
unreadCount: number;
lastRead?: Date | null;
};
/**
* Controls the logic when an `UnreadMessagesNotification` component should be shown.
* In virtualized message list there is no notion of being scrolled below or above `UnreadMessagesSeparator`.
* Therefore, the `UnreadMessagesNotification` component is rendered based on timestamps.
* If the there are unread messages in the channel and the `VirtualizedMessageList` renders
* messages created later than the last read message in the channel, then the
* `UnreadMessagesNotification` component is rendered. This is an approximate equivalent to being
* scrolled below the `UnreadMessagesNotification` component.
* @param lastRead
* @param showAlways
* @param unreadCount
*/
export declare const useUnreadMessagesNotificationVirtualized: ({ lastRead, showAlways, unreadCount, }: UseUnreadMessagesNotificationParams) => {
show: boolean;
toggleShowUnreadMessagesNotification: (renderedMessages: RenderedMessage[]) => void;
};