feat(chat): add greeting screen component #6965
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| /** @jsx createElement */ | ||
|
|
||
| import { cx } from '../../lib'; | ||
|
|
||
| import type { ComponentProps, Renderer } from '../../types'; | ||
| import type { ChatLayoutOwnProps, ChatStatus } from './types'; | ||
|
|
||
| export type ChatGreetingTranslations = { | ||
| /** | ||
| * Heading text for the greeting | ||
| */ | ||
| greetingHeading: string; | ||
| /** | ||
| * Subheading text for the greeting | ||
| */ | ||
| greetingSubheading: string; | ||
| }; | ||
|
|
||
| export type ChatGreetingClassNames = { | ||
| /** | ||
| * Class names to apply to the root element | ||
| */ | ||
| root?: string | string[]; | ||
| /** | ||
| * Class names to apply to the heading element | ||
| */ | ||
| heading?: string | string[]; | ||
| /** | ||
| * Class names to apply to the subheading element | ||
| */ | ||
| subheading?: string | string[]; | ||
| }; | ||
|
|
||
| export type ChatGreetingProps = ComponentProps<'div'> & { | ||
| /** | ||
| * Translations for greeting component texts | ||
| */ | ||
| translations?: Partial<ChatGreetingTranslations>; | ||
| /** | ||
| * Optional class names | ||
| */ | ||
| classNames?: Partial<ChatGreetingClassNames>; | ||
| /** | ||
| * Function to send a message to the chat | ||
| */ | ||
| sendMessage?: ChatLayoutOwnProps['sendMessage']; | ||
| /** | ||
| * Current chat status | ||
| */ | ||
| status?: ChatStatus; | ||
| /** | ||
| * Callback to close the chat | ||
| */ | ||
| onClose?: () => void; | ||
| /** | ||
| * Function to set the prompt input value | ||
| */ | ||
| setInput?: (input: string) => void; | ||
| }; | ||
|
|
||
| export function createChatGreetingComponent({ | ||
| createElement, | ||
| }: Pick<Renderer, 'createElement'>) { | ||
| return function ChatGreeting(userProps: ChatGreetingProps) { | ||
| const { | ||
| translations: userTranslations, | ||
| classNames = {}, | ||
| sendMessage: _sendMessage, | ||
| status: _status, | ||
| onClose: _onClose, | ||
| setInput: _setInput, | ||
| ...props | ||
| } = userProps; | ||
| const translations: Required<ChatGreetingTranslations> = { | ||
| greetingHeading: | ||
| userTranslations?.greetingHeading ?? | ||
| 'How can I help you today?', | ||
| greetingSubheading: | ||
| userTranslations?.greetingSubheading ?? | ||
| "Ask me anything about our products, and I'll do my best to assist you.", | ||
| }; | ||
|
|
||
| return ( | ||
| <div | ||
| className={cx('ais-ChatGreeting', classNames.root)} | ||
| {...props} | ||
| > | ||
| <h2 className={cx('ais-ChatGreeting-heading', classNames.heading)}> | ||
| {translations.greetingHeading} | ||
| </h2> | ||
| <p className={cx('ais-ChatGreeting-subheading', classNames.subheading)}> | ||
| {translations.greetingSubheading} | ||
| </p> | ||
| </div> | ||
| ); | ||
| }; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,6 +22,7 @@ import { | |
| } from './icons'; | ||
|
|
||
| import type { ComponentProps, MutableRef, Renderer, VNode } from '../../types'; | ||
| import type { ChatGreetingProps } from './ChatGreeting'; | ||
| import type { | ||
| ChatMessageProps, | ||
| ChatMessageActionProps, | ||
|
|
@@ -30,7 +31,7 @@ import type { | |
| } from './ChatMessage'; | ||
| import type { ChatMessageErrorProps } from './ChatMessageError'; | ||
| import type { ChatMessageLoaderProps } from './ChatMessageLoader'; | ||
| import type { ChatLayoutOwnProps, ChatMessageBase, ChatStatus, ClientSideTools } from './types'; | ||
|
|
||
| export type ChatMessagesTranslations = { | ||
| /** | ||
|
|
@@ -109,6 +110,10 @@ export type ChatMessagesProps< | |
| * Custom error component | ||
| */ | ||
| errorComponent?: (props: ChatMessageErrorProps) => JSX.Element; | ||
| /** | ||
| * Custom greeting component shown when there are no messages | ||
| */ | ||
| greetingComponent?: (props: ChatGreetingProps) => JSX.Element; | ||
| /** | ||
| * Custom actions component | ||
| */ | ||
|
|
@@ -141,6 +146,14 @@ export type ChatMessagesProps< | |
| * Function to close the chat | ||
| */ | ||
| onClose: () => void; | ||
| /** | ||
| * Function to send a message to the chat | ||
| */ | ||
| sendMessage?: ChatLayoutOwnProps['sendMessage']; | ||
| /** | ||
| * Function to set the prompt input value | ||
| */ | ||
| setInput?: (input: string) => void; | ||
| /** | ||
| * Optional class names | ||
| */ | ||
|
|
@@ -361,6 +374,7 @@ export function createChatMessagesComponent({ | |
| messageComponent: MessageComponent, | ||
| loaderComponent: LoaderComponent, | ||
| errorComponent: ErrorComponent, | ||
| greetingComponent: GreetingComponent, | ||
| actionsComponent: ActionsComponent, | ||
| tools, | ||
| indexUiState, | ||
|
|
@@ -369,6 +383,8 @@ export function createChatMessagesComponent({ | |
| hideScrollToBottom = false, | ||
| onReload, | ||
| onClose, | ||
| sendMessage, | ||
| setInput, | ||
| translations: userTranslations, | ||
| userMessageProps, | ||
| assistantMessageProps, | ||
|
|
@@ -421,6 +437,9 @@ export function createChatMessagesComponent({ | |
| isStreamingWithNoContent || | ||
| isStreamingNonTextContent; | ||
|
|
||
| const showGreeting = | ||
| messages.length === 0 && !showLoader && !isClearing; | ||
|
|
||
| const DefaultMessage = MessageComponent || DefaultMessageComponent; | ||
| const DefaultLoader = LoaderComponent || DefaultLoaderComponent; | ||
| const DefaultError = ErrorComponent || DefaultErrorComponent; | ||
|
|
@@ -449,6 +468,15 @@ export function createChatMessagesComponent({ | |
| } | ||
| }} | ||
| > | ||
| {showGreeting && GreetingComponent && ( | ||
| <GreetingComponent | ||
| sendMessage={sendMessage} | ||
| setInput={setInput} | ||
| status={status} | ||
| onClose={onClose} | ||
| /> | ||
| )} | ||
|
Comment on lines
440
to
+478
There was a problem hiding this comment.
|
||
|
|
||
| {messages.map((message, index) => ( | ||
| <DefaultMessage | ||
| key={message.id} | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| .ais-ChatGreeting { | ||
| --ais-chat-greeting-padding: 0.5rem; | ||
|
|
||
| display: flex; | ||
| flex-direction: column; | ||
| justify-content: center; | ||
| padding: var(--ais-chat-greeting-padding); | ||
| flex: 1; | ||
| gap: calc(var(--ais-spacing) * 0.5); | ||
| } | ||
|
|
||
| .ais-ChatGreeting-heading { | ||
| font-size: 1.25em; | ||
| font-weight: 700; | ||
| margin: 0; | ||
| } | ||
|
|
||
| .ais-ChatGreeting-subheading { | ||
| font-size: 0.875em; | ||
| opacity: 0.7; | ||
| margin: 0; | ||
| line-height: 1.5; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| /** @jsx h */ | ||
|
|
||
| import { createChatGreetingComponent } from 'instantsearch-ui-components'; | ||
| import { h } from 'preact'; | ||
|
|
||
| import type { ChatGreetingProps } from 'instantsearch-ui-components'; | ||
|
|
||
| const ChatGreetingComponent = createChatGreetingComponent({ | ||
| createElement: h, | ||
| }); | ||
|
|
||
| export function chatGreeting() { | ||
| return function ChatGreetingTemplate(props: ChatGreetingProps) { | ||
| return <ChatGreetingComponent {...props} />; | ||
| }; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import { createChatGreetingComponent } from 'instantsearch-ui-components'; | ||
| import { createElement } from 'react'; | ||
|
|
||
| import type { Pragma } from 'instantsearch-ui-components'; | ||
|
|
||
| export const ChatGreeting = createChatGreetingComponent({ | ||
| createElement: createElement as Pragma, | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The root
<div>spreads{...props}after settingclassName. If the caller passesclassName, it will override the computedais-ChatGreeting/classNames.rootclasses and break default styling. Consider mergingprops.classNameinto the computed class name and/or spreading props before settingclassName(while avoiding passing the rawclassNamethrough the spread).