claudius-chat-widget
    Preparing search index...

    Interface ChatWidgetProps

    Props for the ChatWidget component.

    interface ChatWidgetProps {
        accentColor?: string;
        apiUrl: string;
        locale?: LocaleCode;
        persistMessages?: boolean;
        placeholder?: string;
        position?: WidgetPosition;
        requestTimeoutMs?: number;
        storageKeyPrefix?: string;
        subtitle?: string;
        theme?: ClaudiusThemeInput;
        title?: string;
        translations?: Partial<ClaudiusTranslations>;
        triggers?: Trigger[];
        welcomeMessage?: string;
    }
    Index

    Properties

    accentColor? apiUrl locale? persistMessages? placeholder? position? requestTimeoutMs? storageKeyPrefix? subtitle? theme? title? translations? triggers? welcomeMessage?

    Properties

    accentColor?: string

    Accent color override; wins over the theme's accent in both light and dark.

    apiUrl: string

    Absolute URL of the Worker chat endpoint (e.g. https://api.example.com).

    locale?: LocaleCode

    BCP-47 locale used to select built-in translations.

    persistMessages?: boolean

    Persist the conversation to storage so it survives reloads.

    false

    placeholder?: string

    Placeholder text for the message input.

    position?: WidgetPosition

    Corner of the viewport the widget docks to.

    "bottom-right"

    requestTimeoutMs?: number

    Abort a chat request after this many milliseconds.

    storageKeyPrefix?: string

    Prefix for the storage key used when ChatWidgetProps.persistMessages is enabled.

    subtitle?: string

    Header subtitle shown beneath the title.

    theme?: ClaudiusThemeInput

    Color-scheme mode ("light" | "dark" | "auto"), a built-in theme name ("default" | "minimal" | "playful" | "corporate"), an inline ClaudiusTheme object, or a URL to a theme JSON file.

    "light"

    title?: string

    Header title. Falls back to the active locale's default title.

    translations?: Partial<ClaudiusTranslations>

    Partial overrides merged over the resolved locale translations.

    triggers?: Trigger[]

    Proactive open/greeting rules evaluated against the current page.

    welcomeMessage?: string

    First assistant message shown when the chat opens.

    Settings

    Member Visibility

    On This Page

    Properties