ionbase-ui 0.51.0 → 0.69.0

package/dist/meta/ToolCall.json

@@ -0,0 +1,192 @@
+{
+  "name": "ToolCall",
+  "source": "src/components/ToolCall.tsx",
+  "propsType": "ToolCallProps",
+  "description": "ToolCall — the evidence behind one step of an agent run.\n\nAgentActivityStep says what the agent did in the user's language. ToolCall\nis where the person checking that account goes next: which tool, with what\narguments, and what came back. The title is still plain language and still\nrequired, so the technical detail supplements the account rather than\nreplacing it.\n\nCOLLAPSED BY DEFAULT, EXCEPT THE FAILURE\n\nA run makes dozens of calls, and a thread of expanded JSON is unreadable.\nBut `errorMessage` renders outside the disclosure: evidence that takes a\nclick to reach is evidence nobody reads, and a failure is the one thing in\nthe call a reader must not miss.\n\nTHE DETAILS ARE UNMOUNTED WHEN CLOSED — unlike Accordion, deliberately.\nAccordion keeps collapsed panels for the form state inside them; a tool call\nholds no user state, and its payloads can be megabytes of JSON multiplied by\nevery call in the thread.\n\nA CALL WITH NOTHING TO SHOW IS NOT A BUTTON. With no input and no output the\nheader renders as text: a disclosure that discloses nothing announces as\nexpandable and does nothing.\n\nTHE PAYLOADS ARE FOCUSABLE. Each is a scroll container capped in height, and\na scroll container a keyboard user cannot focus is one they cannot scroll.\n\nIt does not announce status changes. AgentActivity owns the run's live\nregion; a second one here would talk over it.",
+  "import": "import { ToolCall } from 'ionbase-ui';",
+  "status": "stable",
+  "summary": "The evidence behind one step of an agent run: which tool, with what input, and what came back — collapsed by default, with any failure shown without a click.",
+  "useWhen": [
+    "a person may need to check how an agent reached a result — which search it ran, which record it wrote",
+    "beneath or beside an AgentActivityStep, for the steps that called a tool",
+    "debugging or audit views where the arguments matter as much as the outcome"
+  ],
+  "useInstead": [
+    {
+      "when": "the reader needs to know what the agent did, not how",
+      "use": "AgentActivityStep",
+      "why": "the plain-language log is the account; ToolCall is the evidence for it, and a thread of tool calls alone is a log nobody but an engineer can read"
+    },
+    {
+      "when": "the call has not happened yet and needs permission",
+      "use": "ApprovalGate",
+      "why": "ToolCall reports a call; it does not ask whether to make one"
+    }
+  ],
+  "variants": {
+    "status": {
+      "pending": {
+        "use": "the default — queued, not started"
+      },
+      "active": {
+        "use": "running now"
+      },
+      "done": {
+        "use": "returned successfully"
+      },
+      "failed": {
+        "use": "errored. Pass `errorMessage`, which shows without expanding"
+      },
+      "skipped": {
+        "use": "not run — rejected at an ApprovalGate, or a cached result was used"
+      }
+    }
+  },
+  "slots": {
+    "errorMessage": {
+      "accepts": "text",
+      "note": "what went wrong, in words — not a stack trace"
+    }
+  },
+  "a11y": {
+    "guarantees": [
+      "the header is a disclosure button with aria-expanded; with no input and no output it is plain text instead, because a disclosure that discloses nothing is a dead control",
+      "status is rendered as visually hidden text inside the header, and the glyph differs in shape per status",
+      "each payload is a focusable, named scroll region, so a keyboard user can scroll a capped payload",
+      "errorMessage renders outside the disclosure, so a failure is never hidden behind a click"
+    ],
+    "notes": [
+      "it does not announce status changes — AgentActivity owns the run's live region, and a second one would talk over it",
+      "the details unmount when collapsed, unlike Accordion: a tool call holds no user state and payloads can be large"
+    ]
+  },
+  "antiPatterns": [
+    {
+      "dont": "title=\"search_invoices\"",
+      "do": "title=\"Searched the invoice archive\" name=\"search_invoices\"",
+      "why": "the function name describes the implementation; the title is what tells a reader whether the step was the right one"
+    },
+    {
+      "dont": "passing input or output with credentials, tokens or personal data still in it",
+      "why": "it renders exactly what it is given, to anyone who can see the thread"
+    },
+    {
+      "dont": "defaultExpanded on every call in a run",
+      "why": "a thread of open JSON buries the answer; open the one the reader is likely to check, or none"
+    },
+    {
+      "dont": "status=\"failed\" with no errorMessage",
+      "why": "a failure the reader cannot diagnose is just a red mark"
+    }
+  ],
+  "stylesheet": "src/styles/tool-call.css",
+  "tokens": [
+    "--border-error-subtle",
+    "--border-focus",
+    "--border-subtle",
+    "--border-width-default",
+    "--border-width-thick",
+    "--font-family-mono",
+    "--font-family-sans",
+    "--font-weight-medium",
+    "--icon-error",
+    "--icon-primary",
+    "--icon-secondary",
+    "--icon-size-sm",
+    "--icon-success",
+    "--icon-tertiary",
+    "--ion-duration-base",
+    "--ion-ease-out",
+    "--radius-md",
+    "--radius-sm",
+    "--spacing-12",
+    "--spacing-4",
+    "--spacing-8",
+    "--surface-default",
+    "--surface-error-subtle",
+    "--surface-hover",
+    "--surface-muted",
+    "--text-default",
+    "--text-error",
+    "--text-secondary",
+    "--text-tertiary",
+    "--type-body-sm",
+    "--type-body-sm-line-height",
+    "--type-caption",
+    "--type-caption-line-height"
+  ],
+  "props": {
+    "title": {
+      "type": "string",
+      "required": true,
+      "origin": "own",
+      "description": "What the call did, in the user's language — \"Searched the invoice archive\".\nRequired: the tool's function name is not a description of the work."
+    },
+    "name": {
+      "type": "string | undefined",
+      "required": false,
+      "origin": "own",
+      "description": "The tool's technical name, shown in monospace beside the title."
+    },
+    "status": {
+      "type": "AgentActivityStatus | undefined",
+      "required": false,
+      "origin": "own",
+      "description": "The same vocabulary as AgentActivityStep, so the two never disagree.",
+      "values": [
+        "pending",
+        "active",
+        "done",
+        "failed",
+        "skipped"
+      ]
+    },
+    "input": {
+      "type": "unknown",
+      "required": false,
+      "origin": "own",
+      "description": "What the agent passed in. Objects and arrays render as formatted JSON,\nstrings as they are. Redact secrets before passing it — this renders\nexactly what it is given."
+    },
+    "output": {
+      "type": "unknown",
+      "required": false,
+      "origin": "own",
+      "description": "What came back. Rendered as `input` is."
+    },
+    "errorMessage": {
+      "type": "React.ReactNode",
+      "required": false,
+      "origin": "own",
+      "description": "Why a `failed` call failed. Shown under the header whether or not the\ndetails are expanded — a failure that takes a click to read is not read."
+    },
+    "durationMs": {
+      "type": "number | undefined",
+      "required": false,
+      "origin": "own",
+      "description": "How long the call took, in milliseconds."
+    },
+    "defaultExpanded": {
+      "type": "boolean | undefined",
+      "required": false,
+      "origin": "own",
+      "description": "Uncontrolled: whether the details start open."
+    },
+    "isExpanded": {
+      "type": "boolean | undefined",
+      "required": false,
+      "origin": "own",
+      "description": "Controlled: whether the details are open. Pass `onExpandedChange` with it."
+    },
+    "onExpandedChange": {
+      "type": "((isExpanded: boolean) => void) | undefined",
+      "required": false,
+      "origin": "own"
+    }
+  },
+  "propCounts": {
+    "own": 10,
+    "aria": 0,
+    "dom": 277,
+    "other": 0
+  }
+}

package/dist/meta/Tooltip.json

@@ -113,10 +113,10 @@
       "origin": "own",
       "description": "Matches the Figma `Placement` variant, and names where the TOOLTIP sits —\nnot where the arrow points. `top` is above the trigger, with the arrow on\nthe tooltip's bottom edge.\n\nTreated as a preference, not a guarantee: it flips to the opposite side\nwhen there is no room, which is the behaviour Figma cannot draw.",
       "values": [
-        "right",
-        "left",
         "top",
-        "bottom"
+        "bottom",
+        "right",
+        "left"
       ]
     },
     "delay": {