mongodb-chatbot-ui
Version:
UI React components for the MongoDB Chatbot Framework
34 lines (33 loc) • 1.37 kB
TypeScript
/// <reference types="react" />
import { useConversation, type UseConversationParams } from "./useConversation";
import { Reference } from "./references";
export type OpenCloseHandlers = {
onOpen?: () => void;
onClose?: () => void;
};
export type UseChatbotProps = OpenCloseHandlers & UseConversationParams & {
chatbotName?: string;
maxInputCharacters?: number;
maxCommentCharacters?: number;
onReferenceClick?: (reference: Reference) => void;
onSuggestedPromptClick?: (prompt: string) => void;
};
export type ChatbotData = {
awaitingReply: boolean;
canSubmit: (text: string) => boolean;
closeChat: () => boolean;
conversation: ReturnType<typeof useConversation>;
handleSubmit: (text: string) => void | Promise<void>;
inputBarRef: React.RefObject<HTMLFormElement>;
inputText: string;
inputTextError: string;
chatbotName?: string;
maxInputCharacters?: number;
maxCommentCharacters?: number;
open: boolean;
openChat: () => void;
setInputText: (text: string) => void;
onReferenceClick?: (reference: Reference) => void;
onSuggestedPromptClick?: (prompt: string) => void;
};
export declare function useChatbot({ onOpen, onClose, chatbotName, maxInputCharacters, maxCommentCharacters, onReferenceClick, onSuggestedPromptClick, ...useConversationArgs }: UseChatbotProps): ChatbotData;