ChannelStateContext

The ChannelStateContext is a one of the context providers exposed in the Channel component and is consumable by all of the Channel children components. The context provides all the state properties and logic for a channel, and you can access these by calling the useChannelStateContext custom hook.

Basic Usage

Pull values from context with our custom hook:

const { channel, watchers } = useChannelStateContext();

Values

acceptedFiles

The value is forwarded to the context from the Channel component prop acceptedFiles.

channel

The currently active StreamChat channel instance to be loaded into the Channel component and referenced by its children.

channelCapabilities

The allowed channel permissions for the currently connected user.

channelConfig

The configurations object for the currently active channel.

channelUnreadUiState

The read state maintained for use by components representing channel unread state (for example UnreadMessagesSeparator, UnreadMessagesNotification).

dragAndDropWindow

The value is forwarded to the context from the Channel component prop dragAndDropWindow.

debounceURLEnrichmentMs

Number of milliseconds to debounce firing the URL enrichment queries when typing. The default value is 1500(ms). See the guide Link Previews in Message Input for more.

enrichURLForPreview

The value is forwarded to the context from the Channel component prop enrichURLForPreview.

error

Error object (if any) in loading the channel, otherwise null.

findURLFn

Custom function to identify URLs in a string for later generation of link previews. See the guide Link Previews in Message Input for more.

giphyVersion

The value is forwarded to the context from the Channel component prop giphyVersion.

imageAttachmentSizeHandler

The value is forwarded to the context from the Channel component prop imageAttachmentSizeHandler.

hasMore

If the channel has more, older, messages to paginate through.

hasMoreNewer

If the channel has more, newer, messages to paginate through.

highlightedMessageId

Value is used internally for jump-to-message logic. Once the user “jumped” to the message, the message with the given ID is highlighted by manipulating its styles attribute.

loading

Boolean for the channel loading state.

loadingMore

Boolean for the channel loading more messages.

loadingMoreNewer

Flag signalling whether newer messages are being loaded as the user scrolls down in the message list. Used internally by VirtualizedMessageList.

maxNumberOfFiles

The value is forwarded to the context from the Channel component prop maxNumberOfFiles.

members

Members of this channel (members are permanent, watchers are users who are online right now).

messages

Array of message objects.

multipleUploads

The value is forwarded to the context from the Channel component prop multipleUploads.

mutes

An array of muted users for a channel.

notifications

Temporary notifications added to the MessageList on specific user/message actions.

onLinkPreviewDismissed

Custom function to react to link preview dismissal. See the guide Link Previews in Message Input for more.

pinnedMessages

The messages that are pinned in the channel.

quotedMessage

An inline message reply to another message.

read

The read state for each channel member.

suppressAutoscroll

Flag signalling whether the scroll to the bottom is prevented. Used internally by MessageList and VirtualizedMessageList components.

shouldGenerateVideoThumbnail

The value is forwarded to the context from the Channel component prop shouldGenerateVideoThumbnail.

thread

The parent message for a thread, if there is one, otherwise null.

threadHasMore

Boolean showing if there are more messages available in current active thread, set to false when the end of pagination is reached.

threadLoadingMore

If the thread is currently loading more messages.

threadMessages

Array of messages within a thread.

threadSuppressAutoscroll

Flag signalling whether the scroll to the bottom is prevented in thread. Used internally by MessageList and VirtualizedMessageList components.

videoAttachmentSizeHandler

The value is forwarded to the context from the Channel component prop videoAttachmentSizeHandler.

watcherCount

The number of watchers on the channel.

watchers

An array of users who are currently watching the channel.

watcher_count

The number of watchers on the channel.