Skip to content

chat-ui-react.md

Latest commit

 

History

History
289 lines (132 loc) · 5 KB

chat-ui-react.md

File metadata and controls

289 lines (132 loc) · 5 KB
Raw

Home > @yext/chat-ui-react

chat-ui-react package

Functions

Function

Description

AISignpostIcon({ className, })

Default icon for the AI signpost.

ChatHeader({ title, showRestartButton, restartButtonIcon, showCloseButton, closeButtonIcon, hideAISignpost, aiSignpostProps, onClose, customCssClasses, })

A component that renders the header of a chat bot panel, including the title and a button to reset the conversation.

ChatInput({ placeholder, stream, inputAutoFocus, handleError, sendButtonIcon, customCssClasses, onSend, onRetry, })

A component that allows user to input message and send to Chat API.

ChatPanel(props)

A component that renders a full panel for chat bot interactions. This includes the message bubbles for the conversation, input box with send button, and header (if provided).

ChatPopUp(props)

A component that renders a popup button that displays and hides a panel for chat bot interactions.

MessageBubble({ message, showFeedbackButtons, showTimestamp, customCssClasses, formatTimestamp, linkTarget, onLinkClick, renderMarkdown, })

A component that displays the provided message.

useComposedCssClasses(builtInClasses, customClasses)

useComposedCssClasses merges a component's built-in tailwind classes with custom tailwind classes.

useReportAnalyticsEvent()

Returns a function to send requests to Yext Analytics API.

Interfaces

Interface

Description

AISignpostProps

Props for the built-in AI signpost component.

ChatHeaderCssClasses

The CSS class interface for the ChatHeader() component.

ChatHeaderProps

The props for the ChatHeader() component.

ChatInputCssClasses

The CSS class interface for the ChatInput() component.

ChatInputProps

The props for the ChatInput() component.

ChatPanelCssClasses

The CSS class interface for the ChatPanel() component.

ChatPanelProps

The props for the ChatPanel() component.

ChatPopUpCssClasses

The CSS class interface for the ChatPopUp() component.

ChatPopUpProps

The props for the ChatPopUp() component.

FeedbackButtonsCssClasses

The CSS class interface for the FeedbackButtons component.

InitialMessagePopUpCssClasses

The CSS class interface for the InitialMessagePopUp component.

MessageBubbleCssClasses

The CSS class interface for the MessageBubble() component.

MessageBubbleProps

The props for the MessageBubble() component.

MessageSuggestionCssClasses

The CSS class interface for the MessageSuggestion component.

MessageSuggestionsProps

The props for the MessageSuggestions component.