{ "name": "PromptInput", "source": "src/components/PromptInput.tsx", "propsType": "PromptInputProps", "description": "PromptInput — where a person writes to an agent.\n\nWHY IT IS NOT A TEXTAREA AND A BUTTON\n\nEvery composer is assembled that way, and every one re-implements the same\nfour bugs:\n\n Enter during IME composition sends half a word. Japanese, Chinese and\n Korean input confirm a candidate with Enter; a handler that does not check\n `isComposing` sends the message mid-character. That excludes whole\n languages from the product, silently, and nobody on an English keyboard\n ever sees it.\n\n The prompt is lost when sending fails. Clearing on submit is right —\n waiting for the server makes the composer feel broken — but clearing and\n never restoring destroys what may have been a long message. Uncontrolled,\n a rejected `onSubmit` promise puts the text back.\n\n The stop control lives somewhere else. While a run is going, the send\n button's place is exactly where the user's pointer and attention already\n are, so that is where `AgentStop` goes — the same control, the same\n guarantees, not a second stop button with different ones.\n\n The keyboard contract is invisible. \"Enter sends, Shift+Enter for a new\n line\" is announced through `aria-describedby`, because a screen-reader\n user who presses Enter expecting a newline has just sent a message.\n\nWHAT IT DOES NOT DO\n\nIt does not upload, pick models or render messages. `attachments` and\n`actions` are slots, because what a product attaches and which tools it\noffers are the product's decisions.", "import": "import { PromptInput } from 'ionbase-ui';", "status": "stable", "summary": "Where a person writes to an agent: a growing text field, a send control that becomes the stop control while a run is going, and slots for attachments and tools.", "useWhen": [ "a chat or assistant surface where the user's message starts a run", "a command bar that sends free text to an agent" ], "useInstead": [ { "when": "the text is a form value submitted with other fields", "use": "Textarea", "why": "Enter-to-send inside a form fights the form's own submit, and a single field of a larger form is not a composer" }, { "when": "the input is a single-line search", "use": "Input", "why": "a search box does not grow, does not stop runs, and Enter means search rather than send" }, { "when": "the run needs a stop control and was not started from this composer", "use": "AgentStop", "why": "the composer's stop belongs to the run it sent; a run started elsewhere keeps its stop beside its own activity" } ], "variants": { "submitKey": { "enter": { "use": "the default — chat. Enter sends, Shift+Enter is a new line" }, "mod-enter": { "use": "long messages, where a stray Enter is expensive. Cmd/Ctrl+Enter sends and Enter is a new line" } } }, "slots": { "actions": { "accepts": "Button", "note": "attach, a model picker, a tool toggle — at the start of the toolbar. Icon-only buttons need their own aria-label" }, "attachments": { "accepts": "Badge", "note": "what is attached, above the text. Each removable item needs a remove control named for the file" } }, "a11y": { "requires": [ "`label` — the accessible name of the field. A placeholder is not one: it disappears on the first keystroke" ], "guarantees": [ "the send key is described through aria-describedby, so a screen-reader user knows Enter sends before pressing it", "Enter pressed while an IME is composing never sends — Japanese, Chinese and Korean input confirm candidates with Enter", "while `isRunning` with `onStop`, the send control is replaced in place by AgentStop, with its guarantees: it keeps its place while stopping and announces once", "focus stays in the field after sending, so the next message can be typed straight away" ], "notes": [ "the field stays editable while a run is going; only submitting is refused", "uncontrolled, the field clears on send and a rejected onSubmit promise restores the text — unless the user has already started typing something new" ] }, "antiPatterns": [ { "dont": "