Skip to content

Latest commit

 

History

History
409 lines (258 loc) · 20.2 KB

component-context.mdx

File metadata and controls

409 lines (258 loc) · 20.2 KB
id title
component_context
ComponentContext

import GHComponentLink from '../../_docusaurus-components/GHComponentLink';

The ComponentContext is a one of the context providers exposed by the Channel component and is consumable by all the children of Channel. This context provides UI component override options for maximum customization. All UI overrides that target children of the Channel component should be placed as Channel component props in order to be injected into the ComponentContext. The ComponentContext also exposes the hook useComponentContext.

Basic Usage

Pull values from context with our custom hook:

const { Attachment, Avatar, Message } = useComponentContext();

Values

Attachment

Custom UI component to display attachment in an individual message.

Type Default
component

AttachmentPreviewList

Custom UI component to display a attachment previews in MessageInput.

Type Default
component

AutocompleteSuggestionHeader

Custom UI component to override the default suggestion header component.

Type Default
component

AutocompleteSuggestionItem

Custom UI component to override the default suggestion Item component.

Type Default
component

AutocompleteSuggestionList

Custom UI component to override the default List component that displays suggestions.

Type Default
component

Avatar

Custom UI component to display a user's avatar.

Type Default
component

BaseImage

Custom UI component to display image resp. a fallback in case of load error, in <img/> element. The default resp. custom (from ComponentContext) BaseImage component is rendered by:

  • - single image attachment in message list
  • - group of image attachments in message list
  • - image uploads preview in message input (composer)

The BaseImage component accepts the same props as <img/> element.

The default BaseImage component tries to load and display an image and if the load fails, then an SVG image fallback is applied to the <img/> element as a CSS mask targeting attached str-chat__base-image--load-failed class.

Type Default
component

CooldownTimer

Custom UI component to display the slow mode cooldown timer.

Type Default
component

CustomMessageActionsList

Custom UI component to render set of buttons to be displayed in the .

Type Default
component

DateSeparator

Custom UI component for date separators.

Type Default
component

EditMessageInput

Custom UI component to override default edit message input.

Type Default
component

EmojiIcon

Custom UI component for emoji button in input.

Type Default
component

EmptyStateIndicator

Custom UI component to be displayed when the MessageList is empty.

Type Default
component

FileUploadIcon

Custom UI component for file upload icon.

Type Default
component

GiphyPreviewMessage

Custom UI component to render a Giphy preview in the VirtualizedMessageList.

Type Default
component

HeaderComponent

Custom UI component to render at the top of the MessageList.

Type Default
component none

Input

Custom UI component handling how the message input is rendered.

Type Default
component

LinkPreviewList

Custom component to render link previews in MessageInput.

Type Default
component

LoadingErrorIndicator

Custom UI component to be shown if the channel query fails.

Type Default
component

LoadingIndicator

Custom UI component to render while the MessageList is loading new messages.

Type Default
component

Message

Custom UI component to display a message in the standard MessageList.

Type Default
component

MessageDeleted

Custom UI component for a deleted message.

Type Default
component

MessageListNotifications

Custom UI component that displays message and connection status notifications in the MessageList.

Type Default
component

MessageNotification

Custom UI component to display a notification when scrolled up the list and new messages arrive.

Type Default
component

MessageOptions

Custom UI component for message options popup.

Type Default
component

MessageRepliesCountButton

Custom UI component to display message replies.

Type Default
component

MessageStatus

Custom UI component to display message delivery status.

Type Default
component

MessageSystem

Custom UI component to display system messages.

Type Default
component

MessageTimestamp

Custom UI component to display a timestamp on a message. This does not include a timestamp for edited messages.

Type Default
component

See also Timestamp.

MessageBouncePrompt

Custom UI component for the content of the modal dialog for messages that got bounced by the moderation rules.

Type Default
component

ModalGallery

Custom UI component for viewing message's image attachments.

Type Default
component

PinIndicator

Custom UI component to override default pinned message indicator.

Type Default
component

QuotedMessage

Custom UI component to override quoted message UI on a sent message.

Type Default
component

QuotedMessagePreview

Custom UI component to override the message input's quoted message preview.

Type Default
component

ReactionSelector

Custom UI component to display the reaction selector.

Type Default
component

ReactionsList

Custom UI component to display the list of reactions on a message.

Type Default
component

SendButton

Custom UI component for send button.

Type Default
component

ThreadHead

Custom UI component to be displayed at the beginning of a thread. By default, it is the thread parent message. It is composed of Message context provider component and ThreadStart component. The latter can be customized by passing custom component to Channel props. The ThreadHead component defaults to and accepts the same props as MessageSimple.

Type Default
component

ThreadHeader

Custom UI component to display the header of a Thread.

Type Default
component

ThreadInput

Custom UI component to replace the MessageInput of a Thread. For the applications using theme version 1, the default is MessageInputSmall. Applications using theme version 2 will use MessageInputFlat by default.

Type Default
component /

ThreadStart

Custom UI component to display the start of a threaded MessageList.

Type Default
component

Timestamp

Custom UI component to display a date used in timestamps. It's used internally by the default MessageTimestamp, and to display a timestamp for edited messages.

Type Default
component

TriggerProvider

Optional context provider that lets you override the default autocomplete triggers.

Type Default
component

TypingIndicator

Custom UI component for the typing indicator.

Type Default
component

UnreadMessagesNotification

Custom UI component that indicates a user is viewing unread messages. It disappears once the user scrolls to UnreadMessagesSeparator.

Type Default
component

UnreadMessagesSeparator

Custom UI component inserted before the first message marked unread.

Type Default
component

VirtualMessage

Custom UI component to display a message in the VirtualizedMessageList.

Type Default
component