22 KiB
Prompt Input
URL: /components/prompt-input
title: Prompt Input description: Allows a user to send a message with file attachments to a large language model. It includes a textarea, file upload capabilities, a submit button, and a dropdown for selecting the model. path: elements/components/prompt-input
The PromptInput component allows a user to send a message with file attachments to a large language model. It includes a textarea, file upload capabilities, a submit button, and a dropdown for selecting the model.
Installation
Usage
import {
PromptInput,
PromptInputActionAddAttachments,
PromptInputActionMenu,
PromptInputActionMenuContent,
PromptInputActionMenuItem,
PromptInputActionMenuTrigger,
PromptInputAttachment,
PromptInputAttachments,
PromptInputBody,
PromptInputButton,
PromptInputProvider,
PromptInputSpeechButton,
PromptInputSubmit,
PromptInputTextarea,
PromptInputFooter,
PromptInputTools,
usePromptInputAttachments,
} from "@/components/ai-elements/prompt-input";
import { GlobeIcon } from "lucide-react";
<PromptInput onSubmit={() => {}} className="mt-4 relative">
<PromptInputHeader>
<PromptInputAttachments>{(attachment) => <PromptInputAttachment data={attachment} />}</PromptInputAttachments>
</PromptInputHeader>
<PromptInputBody>
<PromptInputTextarea onChange={(e) => {}} value={""} />
</PromptInputBody>
<PromptInputFooter>
<PromptInputTools>
<PromptInputActionMenu>
<PromptInputActionMenuTrigger />
<PromptInputActionMenuContent>
<PromptInputActionAddAttachments />
</PromptInputActionMenuContent>
</PromptInputActionMenu>
<PromptInputSpeechButton />
<PromptInputButton>
<GlobeIcon size={16} />
<span>Search</span>
</PromptInputButton>
<PromptInputModelSelect onValueChange={(value) => {}} value="gpt-4o">
<PromptInputModelSelectTrigger>
<PromptInputModelSelectValue />
</PromptInputModelSelectTrigger>
<PromptInputModelSelectContent>
<PromptInputModelSelectItem value="gpt-4o">GPT-4o</PromptInputModelSelectItem>
<PromptInputModelSelectItem value="claude-opus-4-20250514">Claude 4 Opus</PromptInputModelSelectItem>
</PromptInputModelSelectContent>
</PromptInputModelSelect>
</PromptInputTools>
<PromptInputSubmit disabled={false} status={"ready"} />
</PromptInputFooter>
</PromptInput>;
Usage with AI SDK
Build a fully functional chat app using PromptInput, Conversation with a model picker:
Add the following component to your frontend:
"use client";
import {
PromptInput,
PromptInputActionAddAttachments,
PromptInputActionMenu,
PromptInputActionMenuContent,
PromptInputActionMenuTrigger,
PromptInputAttachment,
PromptInputAttachments,
PromptInputBody,
PromptInputButton,
type PromptInputMessage,
PromptInputModelSelect,
PromptInputModelSelectContent,
PromptInputModelSelectItem,
PromptInputModelSelectTrigger,
PromptInputModelSelectValue,
PromptInputSpeechButton,
PromptInputSubmit,
PromptInputTextarea,
PromptInputFooter,
PromptInputTools,
} from "@/components/ai-elements/prompt-input";
import { GlobeIcon } from "lucide-react";
import { useRef, useState } from "react";
import { useChat } from "@ai-sdk/react";
import { Conversation, ConversationContent, ConversationScrollButton } from "@/components/ai-elements/conversation";
import { Message, MessageContent } from "@/components/ai-elements/message";
import { Response } from "@/components/ai-elements/response";
const models = [
{ id: "gpt-4o", name: "GPT-4o" },
{ id: "claude-opus-4-20250514", name: "Claude 4 Opus" },
];
const InputDemo = () => {
const [text, setText] = useState<string>("");
const [model, setModel] = useState<string>(models[0].id);
const [useWebSearch, setUseWebSearch] = useState<boolean>(false);
const textareaRef = useRef<HTMLTextAreaElement>(null);
const { messages, status, sendMessage } = useChat();
const handleSubmit = (message: PromptInputMessage) => {
const hasText = Boolean(message.text);
const hasAttachments = Boolean(message.files?.length);
if (!(hasText || hasAttachments)) {
return;
}
sendMessage(
{
text: message.text || "Sent with attachments",
files: message.files,
},
{
body: {
model: model,
webSearch: useWebSearch,
},
}
);
setText("");
};
return (
<div className="max-w-4xl mx-auto p-6 relative size-full rounded-lg border h-[600px]">
<div className="flex flex-col h-full">
<Conversation>
<ConversationContent>
{messages.map((message) => (
<Message from={message.role} key={message.id}>
<MessageContent>
{message.parts.map((part, i) => {
switch (part.type) {
case "text":
return <Response key={`${message.id}-${i}`}>{part.text}</Response>;
default:
return null;
}
})}
</MessageContent>
</Message>
))}
</ConversationContent>
<ConversationScrollButton />
</Conversation>
<PromptInput onSubmit={handleSubmit} className="mt-4" globalDrop multiple>
<PromptInputHeader>
<PromptInputAttachments>{(attachment) => <PromptInputAttachment data={attachment} />}</PromptInputAttachments>
</PromptInputHeader>
<PromptInputBody>
<PromptInputTextarea onChange={(e) => setText(e.target.value)} ref={textareaRef} value={text} />
</PromptInputBody>
<PromptInputFooter>
<PromptInputTools>
<PromptInputActionMenu>
<PromptInputActionMenuTrigger />
<PromptInputActionMenuContent>
<PromptInputActionAddAttachments />
</PromptInputActionMenuContent>
</PromptInputActionMenu>
<PromptInputSpeechButton onTranscriptionChange={setText} textareaRef={textareaRef} />
<PromptInputButton onClick={() => setUseWebSearch(!useWebSearch)} variant={useWebSearch ? "default" : "ghost"}>
<GlobeIcon size={16} />
<span>Search</span>
</PromptInputButton>
<PromptInputModelSelect
onValueChange={(value) => {
setModel(value);
}}
value={model}
>
<PromptInputModelSelectTrigger>
<PromptInputModelSelectValue />
</PromptInputModelSelectTrigger>
<PromptInputModelSelectContent>
{models.map((model) => (
<PromptInputModelSelectItem key={model.id} value={model.id}>
{model.name}
</PromptInputModelSelectItem>
))}
</PromptInputModelSelectContent>
</PromptInputModelSelect>
</PromptInputTools>
<PromptInputSubmit disabled={!text && !status} status={status} />
</PromptInputFooter>
</PromptInput>
</div>
</div>
);
};
export default InputDemo;
Add the following route to your backend:
import { streamText, UIMessage, convertToModelMessages } from "ai";
// Allow streaming responses up to 30 seconds
export const maxDuration = 30;
export async function POST(req: Request) {
const {
model,
messages,
webSearch,
}: {
messages: UIMessage[];
model: string;
webSearch?: boolean;
} = await req.json();
const result = streamText({
model: webSearch ? "perplexity/sonar" : model,
messages: convertToModelMessages(messages),
});
return result.toUIMessageStreamResponse();
}
Features
- Auto-resizing textarea that adjusts height based on content
- File attachment support with drag-and-drop
- Image preview for image attachments
- Configurable file constraints (max files, max size, accepted types)
- Automatic submit button icons based on status
- Support for keyboard shortcuts (Enter to submit, Shift+Enter for new line)
- Customizable min/max height for the textarea
- Flexible toolbar with support for custom actions and tools
- Built-in model selection dropdown
- Built-in native speech recognition button (Web Speech API)
- Optional provider for lifted state management
- Form automatically resets on submit
- Responsive design with mobile-friendly controls
- Clean, modern styling with customizable themes
- Form-based submission handling
- Hidden file input sync for native form posts
- Global document drop support (opt-in)
Examples
Cursor style
Props
<PromptInput />
<TypeTable type={{ onSubmit: { description: 'Handler called when the form is submitted with message text and files.', type: '(message: PromptInputMessage, event: FormEvent) => void', }, accept: { description: 'File types to accept (e.g., "image/*"). Leave undefined for any.', type: 'string', }, multiple: { description: 'Whether to allow multiple file selection.', type: 'boolean', }, globalDrop: { description: 'When true, accepts file drops anywhere on the document.', type: 'boolean', }, syncHiddenInput: { description: 'Render a hidden input with given name for native form posts.', type: 'boolean', }, maxFiles: { description: 'Maximum number of files allowed.', type: 'number', }, maxFileSize: { description: 'Maximum file size in bytes.', type: 'number', }, onError: { description: 'Handler for file validation errors.', type: '(err: { code: "max_files" | "max_file_size" | "accept", message: string }) => void', }, '...props': { description: 'Any other props are spread to the root form element.', type: 'React.HTMLAttributes', }, }} />
<PromptInputTextarea />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the underlying Textarea component.', type: 'React.ComponentProps', }, }} />
<PromptInputFooter />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the toolbar div.', type: 'React.HTMLAttributes', }, }} />
<PromptInputTools />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the tools div.', type: 'React.HTMLAttributes', }, }} />
<PromptInputButton />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the underlying shadcn/ui Button component.', type: 'React.ComponentProps', }, }} />
<PromptInputSubmit />
<TypeTable type={{ status: { description: 'Current chat status to determine button icon (submitted, streaming, error).', type: 'ChatStatus', }, '...props': { description: 'Any other props are spread to the underlying shadcn/ui Button component.', type: 'React.ComponentProps', }, }} />
<PromptInputModelSelect />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the underlying Select component.', type: 'React.ComponentProps', }, }} />
<PromptInputModelSelectTrigger />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the underlying SelectTrigger component.', type: 'React.ComponentProps', }, }} />
<PromptInputModelSelectContent />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the underlying SelectContent component.', type: 'React.ComponentProps', }, }} />
<PromptInputModelSelectItem />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the underlying SelectItem component.', type: 'React.ComponentProps', }, }} />
<PromptInputModelSelectValue />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the underlying SelectValue component.', type: 'React.ComponentProps', }, }} />
<PromptInputBody />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the body div.', type: 'React.HTMLAttributes', }, }} />
<PromptInputAttachments />
<TypeTable type={{ children: { description: 'Render function for each attachment.', type: '(attachment: FileUIPart & { id: string }) => React.ReactNode', }, '...props': { description: 'Any other props are spread to the attachments container.', type: 'React.HTMLAttributes', }, }} />
<PromptInputAttachment />
<TypeTable type={{ data: { description: 'The attachment data to display.', type: 'FileUIPart & { id: string }', }, '...props': { description: 'Any other props are spread to the attachment div.', type: 'React.HTMLAttributes', }, }} />
<PromptInputActionMenu />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the underlying DropdownMenu component.', type: 'React.ComponentProps', }, }} />
<PromptInputActionMenuTrigger />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the underlying Button component.', type: 'React.ComponentProps', }, }} />
<PromptInputActionMenuContent />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the underlying DropdownMenuContent component.', type: 'React.ComponentProps', }, }} />
<PromptInputActionMenuItem />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the underlying DropdownMenuItem component.', type: 'React.ComponentProps', }, }} />
<PromptInputActionAddAttachments />
<TypeTable type={{ label: { description: 'Label for the menu item.', type: 'string', default: '"Add photos or files"', }, '...props': { description: 'Any other props are spread to the underlying DropdownMenuItem component.', type: 'React.ComponentProps', }, }} />
<PromptInputProvider />
<TypeTable type={{ initialInput: { description: 'Initial text input value.', type: 'string', }, children: { description: 'Child components that will have access to the provider context.', type: 'React.ReactNode', }, }} />
Optional global provider that lifts PromptInput state outside of PromptInput. When used, it allows you to access and control the input state from anywhere within the provider tree. If not used, PromptInput stays fully self-managed.
<PromptInputSpeechButton />
<TypeTable type={{ textareaRef: { description: 'Reference to the textarea element to insert transcribed text.', type: 'RefObject<HTMLTextAreaElement | null>', }, onTranscriptionChange: { description: 'Callback fired when transcription text changes.', type: '(text: string) => void', }, '...props': { description: 'Any other props are spread to the underlying PromptInputButton component.', type: 'React.ComponentProps', }, }} />
Built-in button component that provides native speech recognition using the Web Speech API. The button will be disabled if speech recognition is not supported in the browser. Displays a microphone icon and pulses while actively listening.
Hooks
usePromptInputAttachments
Access and manage file attachments within a PromptInput context.
const attachments = usePromptInputAttachments();
// Available methods:
attachments.files; // Array of current attachments
attachments.add(files); // Add new files
attachments.remove(id); // Remove an attachment by ID
attachments.clear(); // Clear all attachments
attachments.openFileDialog(); // Open file selection dialog
usePromptInputController
Access the full PromptInput controller from a PromptInputProvider. Only available when using the provider.
const controller = usePromptInputController();
// Available methods:
controller.textInput.value; // Current text input value
controller.textInput.setInput(value); // Set text input value
controller.textInput.clear(); // Clear text input
controller.attachments; // Same as usePromptInputAttachments
useProviderAttachments
Access attachments context from a PromptInputProvider. Only available when using the provider.
const attachments = useProviderAttachments();
// Same interface as usePromptInputAttachments
<PromptInputHeader />
<TypeTable type={{ '...props': { description: 'Any other props (except align) are spread to the InputGroupAddon component.', type: 'Omit<React.ComponentProps, "align">', }, }} />
<PromptInputHoverCard />
<TypeTable type={{ openDelay: { description: 'Delay in milliseconds before opening.', type: 'number', default: '0', }, closeDelay: { description: 'Delay in milliseconds before closing.', type: 'number', default: '0', }, '...props': { description: 'Any other props are spread to the HoverCard component.', type: 'React.ComponentProps', }, }} />
<PromptInputHoverCardTrigger />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the HoverCardTrigger component.', type: 'React.ComponentProps', }, }} />
<PromptInputHoverCardContent />
<TypeTable type={{ align: { description: 'Alignment of the hover card content.', type: '"start" | "center" | "end"', default: '"start"', }, '...props': { description: 'Any other props are spread to the HoverCardContent component.', type: 'React.ComponentProps', }, }} />
<PromptInputTabsList />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the div element.', type: 'React.HTMLAttributes', }, }} />
<PromptInputTab />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the div element.', type: 'React.HTMLAttributes', }, }} />
<PromptInputTabLabel />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the h3 element.', type: 'React.HTMLAttributes', }, }} />
<PromptInputTabBody />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the div element.', type: 'React.HTMLAttributes', }, }} />
<PromptInputTabItem />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the div element.', type: 'React.HTMLAttributes', }, }} />
<PromptInputCommand />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the Command component.', type: 'React.ComponentProps', }, }} />
<PromptInputCommandInput />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the CommandInput component.', type: 'React.ComponentProps', }, }} />
<PromptInputCommandList />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the CommandList component.', type: 'React.ComponentProps', }, }} />
<PromptInputCommandEmpty />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the CommandEmpty component.', type: 'React.ComponentProps', }, }} />
<PromptInputCommandGroup />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the CommandGroup component.', type: 'React.ComponentProps', }, }} />
<PromptInputCommandItem />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the CommandItem component.', type: 'React.ComponentProps', }, }} />
<PromptInputCommandSeparator />
<TypeTable type={{ '...props': { description: 'Any other props are spread to the CommandSeparator component.', type: 'React.ComponentProps', }, }} />