@assistant-ui/react/dist/context/react/AssistantContext.d.ts

TypeScript/React library for AI Chat

import type { AssistantToolUIsState } from "../stores/AssistantToolUIs";
import { ReadonlyStore } from "../ReadonlyStore";
import { UseBoundStore } from "zustand";
import { AssistantRuntime } from "../../api/AssistantRuntime";
export type AssistantContextValue = {
    useAssistantRuntime: UseBoundStore<ReadonlyStore<AssistantRuntime>>;
    useToolUIs: UseBoundStore<ReadonlyStore<AssistantToolUIsState>>;
};
export declare const AssistantContext: import("react").Context<AssistantContextValue | null>;
export declare const useAssistantContext: (options?: {
    optional?: boolean | undefined;
} | undefined) => AssistantContextValue | null;
/**
 * Hook to access the AssistantRuntime from the current context.
 *
 * The AssistantRuntime provides access to the top-level assistant state and actions,
 * including thread management, tool registration, and configuration.
 *
 * @param options Configuration options
 * @param options.optional Whether the hook should return null if no context is found
 * @returns The AssistantRuntime instance, or null if optional is true and no context exists
 *
 * @example
 * ```tsx
 * function MyComponent() {
 *   const runtime = useAssistantRuntime();
 *
 *   const handleNewThread = () => {
 *     runtime.switchToNewThread();
 *   };
 *
 *   return <button onClick={handleNewThread}>New Thread</button>;
 * }
 * ```
 */
export declare function useAssistantRuntime(options?: {
    optional?: false | undefined;
}): AssistantRuntime;
export declare function useAssistantRuntime(options?: {
    optional?: boolean | undefined;
}): AssistantRuntime | null;
export declare const useToolUIs: {
    (): AssistantToolUIsState;
    <TSelected>(selector: (state: AssistantToolUIsState) => TSelected): TSelected;
    (options: {
        optional: true;
    }): AssistantToolUIsState | null;
    <TSelected>(options: {
        optional: true;
        selector?: (state: AssistantToolUIsState) => TSelected;
    }): TSelected | null;
}, useToolUIsStore: {
    (): ReadonlyStore<AssistantToolUIsState>;
    (options: {
        optional: true;
    }): ReadonlyStore<AssistantToolUIsState> | null;
};
export declare const useThreadList: {
    (): import("../..").ThreadListState;
    <TSelected>(selector: (state: import("../..").ThreadListState) => TSelected): TSelected;
    <TSelected>(selector: ((state: import("../..").ThreadListState) => TSelected) | undefined): import("../..").ThreadListState | TSelected;
    (options: {
        optional?: false | undefined;
    }): import("../..").ThreadListState;
    (options: {
        optional?: boolean | undefined;
    }): import("../..").ThreadListState | null;
    <TSelected>(options: {
        optional?: false | undefined;
        selector: (state: import("../..").ThreadListState) => TSelected;
    }): TSelected;
    <TSelected>(options: {
        optional?: false | undefined;
        selector: ((state: import("../..").ThreadListState) => TSelected) | undefined;
    }): import("../..").ThreadListState | TSelected;
    <TSelected>(options: {
        optional?: boolean | undefined;
        selector: (state: import("../..").ThreadListState) => TSelected;
    }): TSelected | null;
    <TSelected>(options: {
        optional?: boolean | undefined;
        selector: ((state: import("../..").ThreadListState) => TSelected) | undefined;
    }): import("../..").ThreadListState | TSelected | null;
};
//# sourceMappingURL=AssistantContext.d.ts.map