@assistant-ui/react/dist/primitives/composer/ComposerInput.d.ts

Open-source TypeScript/React library for building production-grade AI chat experiences

import { type ReactElement } from "react";
import { type TextareaAutosizeProps } from "react-textarea-autosize";
export declare namespace ComposerPrimitiveInput {
    export type Element = HTMLTextAreaElement;
    type BaseProps = {
        /**
         * Whether to render as a child component using Slot.
         * When true, the component will merge its props with its child.
         */
        asChild?: boolean | undefined;
        /**
         * A React element to use as the input container, with props merged in.
         */
        render?: ReactElement | undefined;
        /**
         * Whether to cancel message composition when Escape is pressed.
         * After cancelling an edit, focus returns to the main thread composer when
         * available, unless a handler has moved focus elsewhere.
         * @default true
         */
        cancelOnEscape?: boolean | undefined;
        /**
         * Whether to focus the input when a new run starts if nothing is focused
         * or focus is already inside the same thread or composer. Keeps the current
         * selection when the input is already focused. Applies when `autoFocus` is
         * enabled.
         *
         * @deprecated Experimental since 2024-10-12. Not scheduled for removal; the API may change in any release.
         *
         * @default true
         */
        unstable_focusOnRunStart?: boolean | undefined;
        /**
         * Whether to automatically focus the input when scrolling to bottom.
         *
         * @deprecated Experimental since 2024-10-12. Not scheduled for removal; the API may change in any release.
         *
         * @default true
         */
        unstable_focusOnScrollToBottom?: boolean | undefined;
        /**
         * Whether to automatically focus the input when switching threads.
         *
         * @deprecated Experimental since 2024-10-12. Not scheduled for removal; the API may change in any release.
         *
         * @default true
         */
        unstable_focusOnThreadSwitched?: boolean | undefined;
        /**
         * Whether plain Enter on a touch-primary device should insert a newline
         * instead of submitting, detected via
         * `(pointer: coarse) and (not (any-pointer: fine))`. Only takes effect
         * when `submitMode` resolves to `"enter"`.
         *
         * @deprecated Experimental since 2026-05-24. Not scheduled for removal; the API may change in any release.
         *
         * @default false
         */
        unstable_insertNewlineOnTouchEnter?: boolean | undefined;
        /**
         * Whether to automatically add pasted files as attachments.
         * @default true
         */
        addAttachmentOnPaste?: boolean | undefined;
    };
    type SubmitModeProps = {
        /**
         * Controls how the Enter key submits messages.
         * - "enter": Plain Enter submits (Shift+Enter for newline)
         * - "ctrlEnter": Ctrl/Cmd+Enter submits (plain Enter for newline)
         * - "none": Keyboard submission disabled
         * @default "enter"
         */
        submitMode?: "enter" | "ctrlEnter" | "none" | undefined;
        /**
         * @deprecated Use `submitMode` instead
         * @ignore
         */
        submitOnEnter?: never;
    } | {
        submitMode?: never;
        /**
         * Whether to submit the message when Enter is pressed (without Shift).
         * @default true
         * @deprecated Use `submitMode` instead. Will be removed in a future version.
         */
        submitOnEnter?: boolean | undefined;
    };
    export type Props = TextareaAutosizeProps & BaseProps & SubmitModeProps;
    export {};
}
/**
 * A text input component for composing messages.
 *
 * This component provides a rich text input experience with automatic resizing,
 * keyboard shortcuts, file paste support, and intelligent focus management.
 * It integrates with the composer context to manage message state and submission.
 *
 * When rendered inside `TriggerPopoverRoot` and a popover is open, the
 * underlying `<textarea>` automatically receives `aria-controls`,
 * `aria-expanded`, `aria-haspopup`, and `aria-activedescendant` for the
 * combobox relationship. These computed attributes override user-provided
 * values for those four ARIA props while the popover is open.
 *
 * @example
 * ```tsx
 * // Ctrl/Cmd+Enter to submit (plain Enter inserts newline)
 * <ComposerPrimitive.Input
 *   placeholder="Type your message..."
 *   submitMode="ctrlEnter"
 * />
 *
 * // Insert a newline on Enter on touch-primary devices.
 * <ComposerPrimitive.Input
 *   placeholder="Type your message..."
 *   unstable_insertNewlineOnTouchEnter
 * />
 *
 * // Old API (deprecated, still supported)
 * <ComposerPrimitive.Input
 *   placeholder="Type your message..."
 *   submitOnEnter={true}
 * />
 * ```
 */
export declare const ComposerPrimitiveInput: import("react").ForwardRefExoticComponent<ComposerPrimitiveInput.Props & import("react").RefAttributes<HTMLTextAreaElement>>;
//# sourceMappingURL=ComposerInput.d.ts.map