@victoriabot/chat
Version:
VictorIA is a web chat powered by AI that allows users to ask questions about your webpage.
71 lines (66 loc) • 2.25 kB
TypeScript
import { JSX as JSX_2 } from 'react/jsx-runtime';
/**
* Initializes the VictoriaBot app. It is mainly used for non-react contexts.
*/
export declare const initChatbot: (props: VictoriaBotProps) => void;
/**
* It is the main entry point to the react VictoriaBot app.
*/
export declare const VictorIABot: (props: VictoriaBotProps) => JSX_2.Element;
/**
* This interface defines the props that can be passed to the VictoriaBot component.
*/
export declare type VictoriaBotProps = {
/**
* The API key used to authenticate requests to the backend server.
* All requests to the server must include this key.
*/
apiKey: string;
/**
* The language code to use for the chatbot. If unset, the chatbot will try to autodetect the language.
*/
language?: string | 'autodetect';
/**
* The title of the chatbot. It is displayed at the top of the chat window.
*/
chatbotTitle?: string;
/**
* This is the subtitle of the chatbot. It is displayed under the title.
*/
chatbotSubtitle?: string;
/**
* This is the message that is displayed at the start of the chat conversation.
*/
welcomeMessage?: string;
/**
* Callback function that triggers when the chatbot button is clicked.
*/
onOpenChange?: (open: boolean) => void;
/**
* This object contains style information for the chatbot.
* The style can be customized to match the design of the app.
*/
style?: {
/**
* This is the background color of the chatbot window.
*/
backgroundColor?: string;
/**
* This is the icon that is displayed in the chatbot window.
*/
assistantIcon?: string;
/**
* This is the icon of the button that is displayed in the chatbot window.
*/
buttonIcon?: string;
/**
* This is the color of the button that is displayed in the chatbot window.
*/
buttonColor?: string;
/**
* This is the hover color of the button that is displayed in the chatbot window.
*/
buttonColorHover?: string;
};
};
export { }