{ "package": "ionbase-ui", "version": "0.138.1", "usage": "Pick a component here, then read dist/meta/.json for its full contract.", "hooks": [ "useAgentRun", "useLocale", "useTableColumns", "useTableSelection", "useTableSort", "useToast" ], "helpers": [ "agentRunFrom", "agentRunHasEnded", "agentRunLog", "agentRunReducer", "chartAxisProps", "chartGridProps", "chartSeriesClass", "chartTooltipProps", "initialAgentRunState", "replayAgentRun" ], "components": { "Accordion": { "summary": "Sections that collapse, with the document's heading structure intact. Holds the open set and the heading level.", "status": "stable", "variants": {}, "detail": "dist/meta/Accordion.json", "hasIntent": true }, "AccordionItem": { "summary": "One collapsible section: an always-visible title that toggles a region beneath it.", "status": "stable", "variants": {}, "detail": "dist/meta/AccordionItem.json", "hasIntent": true }, "AgentActivity": { "summary": "An ordered, plain-language log of what the agent is doing. Status is text and shape, never colour alone.", "status": "stable", "variants": {}, "detail": "dist/meta/AgentActivity.json", "hasIntent": true }, "AgentActivityStep": { "summary": "One step in an activity log: what happened, in the user's language, with a status carried by shape and text.", "status": "stable", "variants": { "status": [ "pending", "active", "done", "failed", "skipped" ] }, "detail": "dist/meta/AgentActivityStep.json", "hasIntent": true }, "AgentStop": { "summary": "The always-visible way to end a running agent. Not optional, and not behind a menu.", "status": "stable", "variants": { "size": [ "sm", "md", "lg" ] }, "detail": "dist/meta/AgentStop.json", "hasIntent": true }, "AILabel": { "summary": "Marks content as generated by AI, and opens what that means — what was generated, from what, and what to check. The explanation is required.", "status": "stable", "variants": { "placement": [ "top", "bottom", "left", "right" ], "size": [ "sm", "md" ] }, "detail": "dist/meta/AILabel.json", "hasIntent": true }, "Alert": { "summary": "A persistent, in-page status message. Intent picks the ARIA role for you.", "status": "stable", "variants": { "intent": [ "neutral", "primary", "success", "warning", "error", "information" ], "emphasis": [ "subtle", "solid" ], "layout": [ "inline", "banner" ] }, "detail": "dist/meta/Alert.json", "hasIntent": true }, "ApprovalGate": { "summary": "A proposed action held until a person approves, rejects or amends it. It renders the decision; it does not enforce it.", "status": "stable", "variants": { "risk": [ "low", "medium", "high" ], "status": [ "pending", "approved", "rejected", "expired" ] }, "detail": "dist/meta/ApprovalGate.json", "hasIntent": true }, "AppSwitcher": { "summary": "The nine-dot button in a suite's header and the grid of products it opens — links, each to a product's home, with the one you are in marked.", "status": "stable", "variants": {}, "detail": "dist/meta/AppSwitcher.json", "hasIntent": true }, "Avatar": { "summary": "A person or entity marker. Content is chosen by precedence — image, then initials, then icon — not by a type prop.", "status": "stable", "variants": { "size": [ "sm", "md", "lg", "mini" ], "shape": [ "circle", "square" ], "topIndicator": [ "neutral", "primary", "success", "warning", "error", "information" ], "bottomIndicator": [ "neutral", "primary", "success", "warning", "error", "information" ] }, "detail": "dist/meta/Avatar.json", "hasIntent": true }, "AvatarGradient": { "summary": "Avatar's initials-only sibling: a tinted, bevelled disc in one of seven colours, for people with no photo.", "status": "stable", "variants": { "size": [ "sm", "md", "lg", "mini" ], "color": [ "slate", "blue", "violet", "pink", "orange", "green", "red" ] }, "detail": "dist/meta/AvatarGradient.json", "hasIntent": true }, "AvatarGroup": { "summary": "Overlapping Avatars with a `+N` overflow, for showing several people in one row's width.", "status": "stable", "variants": { "size": [ "sm", "md", "lg", "mini" ], "shape": [ "circle", "square" ] }, "detail": "dist/meta/AvatarGroup.json", "hasIntent": true }, "Badge": { "summary": "A small, non-interactive label that classifies the thing next to it. Presentational — no role, no live region.", "status": "stable", "variants": { "intent": [ "neutral", "primary", "success", "warning", "error", "information" ], "size": [ "sm", "md", "lg" ], "shape": [ "pill", "rounded" ] }, "detail": "dist/meta/Badge.json", "hasIntent": true }, "Banner": { "summary": "A notice about the whole product, across the top of it — maintenance tonight, a trial ending, the workspace read-only or scheduled for deletion. Alert's banner layout on one line, in the app shell; a dismissal is remembered with `dismissKey`.", "status": "stable", "variants": { "intent": [ "neutral", "primary", "success", "warning", "error", "information" ], "emphasis": [ "subtle", "solid" ] }, "detail": "dist/meta/Banner.json", "hasIntent": true }, "Breadcrumb": { "summary": "Where this page sits in the hierarchy, and how to get back up. An ordered list inside a named landmark.", "status": "stable", "variants": {}, "detail": "dist/meta/Breadcrumb.json", "hasIntent": true }, "BreadcrumbItem": { "summary": "One crumb. A link to an ancestor, or the current page rendered as text.", "status": "stable", "variants": {}, "detail": "dist/meta/BreadcrumbItem.json", "hasIntent": true }, "Button": { "summary": "Triggers an action in place. Never navigates.", "status": "stable", "variants": { "variant": [ "success", "primary-brand", "primary-neutral", "primary-soft", "secondary", "tertiary", "destructive" ], "size": [ "sm", "md", "lg", "xl" ] }, "detail": "dist/meta/Button.json", "hasIntent": true }, "ButtonGroup": { "summary": "A row of actions — a dialog's Cancel and Confirm, a form's Back, Save and Next, a record's header actions. Owns the gap, the order and what happens when the row runs out of room.", "status": "stable", "variants": { "align": [ "start", "center", "end" ], "overflow": [ "menu", "wrap" ] }, "detail": "dist/meta/ButtonGroup.json", "hasIntent": true }, "Calendar": { "summary": "One month in the page for a day chosen by where it falls — a day to resume on, a delivery day — taking and returning a YYYY-MM-DD string.", "status": "stable", "variants": {}, "detail": "dist/meta/Calendar.json", "hasIntent": true }, "Card": { "summary": "A bordered surface that groups one part of a page, with an optional title row. A titled card is a named region; an untitled one is a plain surface.", "status": "stable", "variants": { "intent": [ "default", "danger" ] }, "detail": "dist/meta/Card.json", "hasIntent": true }, "ChartLegend": { "summary": "Which colour is which series, for a chart drawn with visx. The swatch reads the same token as the series.", "status": "stable", "variants": { "shape": [ "square", "line" ] }, "detail": "dist/meta/ChartLegend.json", "hasIntent": true }, "ChartTooltip": { "summary": "The panel showing the values under the pointer on a visx chart. visx positions it; this draws it.", "status": "stable", "variants": {}, "detail": "dist/meta/ChartTooltip.json", "hasIntent": true }, "ChatMessage": { "summary": "One turn in a transcript — who, when, what, and what can be done with it. An article named by its author and time; never a live region.", "status": "stable", "variants": { "from": [ "person", "assistant" ] }, "detail": "dist/meta/ChatMessage.json", "hasIntent": true }, "Checkbox": { "summary": "A native checkbox with the system's styling, supporting an indeterminate state.", "status": "stable", "variants": { "size": [ "sm", "md", "lg" ], "intent": [ "neutral", "danger", "brand" ] }, "detail": "dist/meta/Checkbox.json", "hasIntent": true }, "CheckboxGroup": { "summary": "A set of checkboxes answering one question. Owns the selected values, the group's label, help and error, and \"select at least one\".", "status": "stable", "variants": { "size": [ "sm", "md", "lg" ], "intent": [ "neutral", "danger", "brand" ], "orientation": [ "vertical", "horizontal" ] }, "detail": "dist/meta/CheckboxGroup.json", "hasIntent": true }, "Citation": { "summary": "The inline source marker. The visible number is for the eye; the accessible name is the sentence.", "status": "stable", "variants": {}, "detail": "dist/meta/Citation.json", "hasIntent": true }, "CitationList": { "summary": "The footer list of sources, as an ordered list so the count and order are structural.", "status": "stable", "variants": {}, "detail": "dist/meta/CitationList.json", "hasIntent": true }, "CitationListItem": { "summary": "One source row: its number, what it is, and the passage it supports.", "status": "stable", "variants": {}, "detail": "dist/meta/CitationListItem.json", "hasIntent": true }, "Coachmark": { "summary": "A callout pointing at one thing on the page, to say what it is or what changed — anchored to its target by id or ref, which is ringed while it shows. Several in a row are a Tour.", "status": "stable", "variants": { "placement": [ "top", "bottom", "start", "end" ] }, "detail": "dist/meta/Coachmark.json", "hasIntent": true }, "CodeSnippet": { "summary": "Code shown as code: a name in a sentence, a command to run, a block to paste. Commands and blocks scroll rather than wrap, are named regions a keyboard can scroll, and carry a CopyButton that copies all of it.", "status": "stable", "variants": { "type": [ "inline", "single", "multi" ] }, "detail": "dist/meta/CodeSnippet.json", "hasIntent": true }, "ColorPicker": { "summary": "A colour chosen by a person — a brand accent, a label, a chart series — as a hex field with a swatch button that opens a saturation and brightness area, a hue strip and any preset swatches, taking and returning `#RRGGBB`.", "status": "stable", "variants": { "size": [ "sm", "md", "lg" ] }, "detail": "dist/meta/ColorPicker.json", "hasIntent": true }, "Combobox": { "summary": "A text field that filters a list of options down to one selected value.", "status": "stable", "variants": { "size": [ "sm", "md", "lg" ], "menuTrigger": [ "focus", "input", "manual" ] }, "detail": "dist/meta/Combobox.json", "hasIntent": true }, "CommandPalette": { "summary": "A searchable list of every command in the product, opened with ⌘K / Ctrl+K from anywhere, that runs the chosen command and closes.", "status": "stable", "variants": {}, "detail": "dist/meta/CommandPalette.json", "hasIntent": true }, "ConfidenceIndicator": { "summary": "How much to trust the thing next to it — three levels with a required basis, never a percentage.", "status": "stable", "variants": { "level": [ "low", "medium", "high" ] }, "detail": "dist/meta/ConfidenceIndicator.json", "hasIntent": true }, "ContextMenu": { "summary": "The menu a right-click opens on a thing — a row's actions, a file's. Shift+F10 and the Menu key open it from the keyboard, under the thing. A shortcut to actions that are also reachable some other way.", "status": "stable", "variants": {}, "detail": "dist/meta/ContextMenu.json", "hasIntent": true }, "CopyButton": { "summary": "Copies a value — an ID, a key, a command — confirms in place with a check and \"Copied\" for two seconds, and announces it. When the clipboard refuses it says so, and hands over the text.", "status": "stable", "variants": { "variant": [ "secondary", "tertiary" ], "size": [ "sm", "md", "lg" ] }, "detail": "dist/meta/CopyButton.json", "hasIntent": true }, "DatePicker": { "summary": "A segmented date field with a calendar attached, taking and returning a YYYY-MM-DD string.", "status": "stable", "variants": { "size": [ "sm", "md", "lg" ] }, "detail": "dist/meta/DatePicker.json", "hasIntent": true }, "DateRangePicker": { "summary": "Two segmented date fields sharing one calendar, returning an inclusive { start, end } of YYYY-MM-DD strings.", "status": "stable", "variants": { "size": [ "sm", "md", "lg" ] }, "detail": "dist/meta/DateRangePicker.json", "hasIntent": true }, "DateTimePicker": { "summary": "A date and a time of day as one field — day, month, year, hour and minute in segments, with the calendar and a time field in its popover — taking and returning a wall-clock YYYY-MM-DDTHH:MM string.", "status": "stable", "variants": { "size": [ "sm", "md", "lg" ], "granularity": [ "minute", "second" ] }, "detail": "dist/meta/DateTimePicker.json", "hasIntent": true }, "DescriptionList": { "summary": "Label–value pairs as a real `
` — a record's details, a settings summary, a wizard's review step. Three layouts; an empty value is shown as \"—\" and read as words.", "status": "stable", "variants": { "layout": [ "horizontal", "stacked", "row" ] }, "detail": "dist/meta/DescriptionList.json", "hasIntent": true }, "DescriptionListItem": { "summary": "One term and its value inside a DescriptionList: a `
` holding a `
` and a `
`.", "status": "stable", "variants": {}, "detail": "dist/meta/DescriptionListItem.json", "hasIntent": true }, "Divider": { "summary": "A semantic thematic break, rendered as a real
.", "status": "stable", "variants": { "orientation": [ "vertical", "horizontal" ] }, "detail": "dist/meta/Divider.json", "hasIntent": true }, "Drawer": { "summary": "A modal panel anchored to an edge. Modal behaviour — focus trap, Escape, scrim — with the shape of a side panel.", "status": "stable", "variants": { "placement": [ "top", "bottom", "start", "end" ], "size": [ "sm", "md", "lg" ] }, "detail": "dist/meta/Drawer.json", "hasIntent": true }, "DualListbox": { "summary": "Choose some of many in two lists side by side — what is available, and what is chosen — with buttons that move options across, and optionally an order for what is chosen. A form field.", "status": "stable", "variants": {}, "detail": "dist/meta/DualListbox.json", "hasIntent": true }, "EmptyState": { "summary": "The state a region shows when it has nothing to show, and why — first run, no results, no access, or a failed fetch.", "status": "stable", "variants": { "reason": [ "error", "first-run", "no-results", "no-access" ], "size": [ "inline", "page", "panel" ] }, "detail": "dist/meta/EmptyState.json", "hasIntent": true }, "Fieldset": { "summary": "A
/ that groups related fields under one label, one description and one error — an address, a pair of limits, a date typed as two fields.", "status": "stable", "variants": { "orientation": [ "vertical", "horizontal" ] }, "detail": "dist/meta/Fieldset.json", "hasIntent": true }, "FileUpload": { "summary": "A drop target wrapped around a real file input, with client-side accept and size checks.", "status": "stable", "variants": { "size": [ "sm", "md" ] }, "detail": "dist/meta/FileUpload.json", "hasIntent": true }, "FullCard": { "summary": "A full-bleed row: a text column beside a framed media panel, mirrored by `alignment`.", "status": "stable", "variants": { "alignment": [ "left", "right" ] }, "detail": "dist/meta/FullCard.json", "hasIntent": true }, "Grid": { "summary": "Columns that line up across rows, with gaps from the spacing scale. Reach for it before writing grid CSS: cards and tiles, a main column beside its aside, a form in two columns.", "status": "stable", "variants": { "collapse": [ "tablet", "mobile", "never" ], "align": [ "start", "center", "end", "stretch" ], "as": [ "form", "div", "span", "section", "nav", "ul", "ol", "li", "header", "footer", "fieldset" ] }, "detail": "dist/meta/Grid.json", "hasIntent": true }, "Header": { "summary": "The page header bar. Renders Figma's Desktop, Tablet, Mobile-Closed and Mobile-Open from one DOM tree.", "status": "stable", "variants": { "menuType": [ "dialog", "panel" ] }, "detail": "dist/meta/Header.json", "hasIntent": true }, "I18nProvider": { "summary": "Sets the locale every IonBase component reads: react-aria's provider, re-exported. For right-to-left it is half the switch — arrow keys follow the locale, while the layout follows `dir` on the page.", "status": "stable", "variants": {}, "detail": "dist/meta/I18nProvider.json", "hasIntent": true }, "Icon": { "summary": "Applies the system's icon sizing and accessibility defaults to any SVG component you hand it. The package ships no icon set.", "status": "stable", "variants": {}, "detail": "dist/meta/Icon.json", "hasIntent": true }, "InlineEdit": { "summary": "A value that becomes a field where it stands — an agent's purpose under its name, a row's label. The value is text with an Edit button beside it; editing shows the field with Save and Cancel. Enter saves, Escape cancels, focus goes in and comes back, and a failed or invalid save keeps what was typed.", "status": "stable", "variants": { "size": [ "sm", "md" ] }, "detail": "dist/meta/InlineEdit.json", "hasIntent": true }, "InlineLoading": { "summary": "The pending → done → failed of one action, in place — \"Saving…\", \"Saved\", \"Not saved\" beside the switch that was flipped or the button that was pressed. A live region that is always mounted, around StatusIndicator's arc, check and octagon.", "status": "stable", "variants": { "status": [ "active", "error", "inactive", "finished" ], "size": [ "sm", "md" ] }, "detail": "dist/meta/InlineLoading.json", "hasIntent": true }, "Input": { "summary": "A single-line text field, together with its label, helper text and error message.", "status": "stable", "variants": { "size": [ "sm", "md", "lg" ], "autoCapitalize": [ "none", "off", "on", "sentences", "words", "characters" ] }, "detail": "dist/meta/Input.json", "hasIntent": true }, "Kbd": { "summary": "A key, or a keyboard shortcut, drawn as keycaps in the reader's platform's own symbols and read aloud by name.", "status": "stable", "variants": { "platform": [ "mac", "other" ] }, "detail": "dist/meta/Kbd.json", "hasIntent": true }, "Link": { "summary": "Navigation to somewhere else. Renders an when given `href`, a