Skip to content

Support greeting and fix suggested questions if there are no custom questions #3856

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zenoachtig merged 2 commits into from
Dec 11, 2025
Merged

Support greeting and fix suggested questions if there are no custom questions #3856

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
463b9f0
Support `greeting` and fix suggested questions if there are no custom…
zenoachtig Dec 9, 2025
d795c34
GPT review
zenoachtig Dec 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/social-moles-film.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"gitbook": patch
---

Support `greeting` and fix suggested questions if there are no custom ones defined
10 changes: 7 additions & 3 deletions packages/gitbook/src/components/AI/useAI.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ export type AIConfig = {
aiMode: CustomizationAIMode;
suggestions?: string[];
trademark: boolean;
greeting?: {
title: string;
subtitle: string;
};
};

export type Assistant = Omit<GitBookAssistant, 'icon'> & {
Expand Down Expand Up @@ -50,10 +54,10 @@ export type Assistant = Omit<GitBookAssistant, 'icon'> & {
const AIContext = React.createContext<AIConfig | null>(null);

export function AIContextProvider(props: React.PropsWithChildren<AIConfig>): React.ReactElement {
const { aiMode, trademark, suggestions, children } = props;
const { aiMode, trademark, suggestions, greeting, children } = props;
const value = React.useMemo(
() => ({ aiMode, trademark, suggestions }),
[aiMode, trademark, suggestions]
() => ({ aiMode, trademark, suggestions, greeting }),
[aiMode, trademark, suggestions, greeting]
);
return <AIContext.Provider value={value}>{children}</AIContext.Provider>;
}
Expand Down
17 changes: 11 additions & 6 deletions packages/gitbook/src/components/AIChat/AIChat.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,12 @@ export function AIChatBody(props: {
chat: AIChatState;
welcomeMessage?: string;
suggestions?: string[];
greeting?: {
title: string;
subtitle: string;
};
}) {
const { chatController, chat, suggestions } = props;
const { chatController, chat, suggestions, greeting } = props;
const { trademark } = useAI().config;

const [input, setInput] = React.useState('');
Expand Down Expand Up @@ -233,19 +237,20 @@ export function AIChatBody(props: {
className="size-8 text-primary [@container(min-height:400px)]:size-16"
/>
</div>
<div className="flex flex-col items-start [@container(min-height:400px)]:items-center">
<div className="flex flex-col items-start gap-1 [@container(min-height:400px)]:items-center">
<h5
className="animate-blur-in-slow font-bold text-lg text-tint-strong [@container(min-height:400px)]:text-center"
className="animate-blur-in-slow font-bold text-lg text-tint-strong leading-tight [@container(min-height:400px)]:text-center"
style={{ animationDelay: '.5s' }}
data-testid="ai-chat-time-greeting"
>
{timeGreeting}
{greeting?.title || timeGreeting}
</h5>
<p
className="animate-blur-in-slow text-tint [@container(min-height:400px)]:text-center"
className="animate-blur-in-slow text-tint leading-tight [@container(min-height:400px)]:text-center"
style={{ animationDelay: '.6s' }}
>
{t(language, 'ai_chat_assistant_description')}
{greeting?.subtitle ||
t(language, 'ai_chat_assistant_description')}
</p>
</div>
</div>
Expand Down
18 changes: 10 additions & 8 deletions packages/gitbook/src/components/AIChat/AIChatSuggestedQuestions.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,16 @@ export default function AIChatSuggestedQuestions(props: {
suggestions?: string[];
}) {
const language = useLanguage();
const {
chatController,
suggestions = [
tString(language, 'ai_chat_suggested_questions_about_this_page'),
tString(language, 'ai_chat_suggested_questions_read_next'),
tString(language, 'ai_chat_suggested_questions_example'),
],
} = props;
const { chatController, suggestions: _suggestions } = props;

const suggestions =
_suggestions && _suggestions.length > 0
? _suggestions
: [
tString(language, 'ai_chat_suggested_questions_about_this_page'),
tString(language, 'ai_chat_suggested_questions_read_next'),
tString(language, 'ai_chat_suggested_questions_example'),
];

return (
<div className="flex flex-col items-start gap-2 self-start">
Expand Down
1 change: 1 addition & 0 deletions packages/gitbook/src/components/Embeddable/EmbeddableAIChat.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ export function EmbeddableAIChat(props: EmbeddableAIChatProps) {
chatController={chatController}
chat={chat}
suggestions={configuration.suggestions}
greeting={configuration.greeting}
/>
</EmbeddableFrameBody>
</EmbeddableFrameMain>
Expand Down