@fungi.computer/caps 0.0.0-stage → 0.0.1

package/docs/api/components/textarea.md

@@ -0,0 +1,40 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/textarea
+
+# components/textarea
+
+## Type Aliases
+
+### TextareaProps
+
+```ts
+type TextareaProps = object & TextareaHTMLAttributes<HTMLTextAreaElement>;
+```
+
+Props accepted by Textarea.
+
+#### Type Declaration
+
+| Name       | Type      |
+| ---------- | --------- |
+| `invalid?` | `boolean` |
+
+## Variables
+
+### Textarea
+
+```ts
+const Textarea: ForwardRefExoticComponent<
+  object &
+    TextareaHTMLAttributes<HTMLTextAreaElement> &
+    RefAttributes<HTMLTextAreaElement>
+>;
+```
+
+A styled multiline text input that preserves caller-owned value and event
+behavior.

package/docs/api/components/toaster.md

@@ -0,0 +1,29 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/toaster
+
+# components/toaster
+
+## Functions
+
+### Toaster()
+
+```ts
+function Toaster(__namedParameters): ReactPortal | null;
+```
+
+Sonner owns gestures, stacking, focus and lifetime; Caps owns the surface.
+
+#### Parameters
+
+| Parameter           | Type           |
+| ------------------- | -------------- |
+| `__namedParameters` | `ToasterProps` |
+
+#### Returns
+
+`ReactPortal` \| `null`

package/docs/api/components/tool-call-chip.md

@@ -0,0 +1,68 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/tool-call-chip
+
+# components/tool-call-chip
+
+## Type Aliases
+
+### ToolCallChipProps
+
+```ts
+type ToolCallChipProps = Readonly<{
+  name: string;
+  state: ActivityState;
+  startedAt: number;
+  finishedAt?: number;
+  onRetry?: () => void;
+  className?: string;
+}>;
+```
+
+Props accepted by ToolCallChip.
+
+## Functions
+
+### formatCallTime()
+
+```ts
+function formatCallTime(milliseconds): string;
+```
+
+A tool call's time: milliseconds under a second, then the activity clock.
+
+#### Parameters
+
+| Parameter      | Type     |
+| -------------- | -------- |
+| `milliseconds` | `number` |
+
+#### Returns
+
+`string`
+
+---
+
+### ToolCallChip()
+
+```ts
+function ToolCallChip(__namedParameters): Element;
+```
+
+One tool call as a chip. While it runs a quiet fill wipes across and a live
+clock counts; when it lands the fill completes and washes away; when it fails
+the chip shakes and offers a retry.
+
+#### Parameters
+
+| Parameter           | Type                                      |
+| ------------------- | ----------------------------------------- |
+| `__namedParameters` | [`ToolCallChipProps`](#toolcallchipprops) |
+
+#### Returns
+
+`Element`

package/docs/api/components/tooltip.md

@@ -0,0 +1,113 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/tooltip
+
+# components/tooltip
+
+## Type Aliases
+
+### TooltipSide
+
+```ts
+type TooltipSide = "bottom" | "left" | "right" | "top";
+```
+
+Supported TooltipSide values.
+
+---
+
+### TooltipProps
+
+```ts
+type TooltipProps = object & Omit<HTMLAttributes<HTMLSpanElement>, "children">;
+```
+
+Props accepted by Tooltip.
+
+#### Type Declaration
+
+| Name              | Type                          | Description                                  |
+| ----------------- | ----------------------------- | -------------------------------------------- |
+| `children`        | `ReactNode`                   | -                                            |
+| `defaultOpen?`    | `boolean`                     | -                                            |
+| `delayDuration?`  | `number`                      | -                                            |
+| `onOpenChange()?` | (`open`) => `void`            | Called after the tooltip open state changes. |
+| `open?`           | `boolean`                     | -                                            |
+| `side?`           | [`TooltipSide`](#tooltipside) | -                                            |
+
+---
+
+### TooltipTriggerProps
+
+```ts
+type TooltipTriggerProps = object & ButtonHTMLAttributes<HTMLButtonElement>;
+```
+
+Props accepted by TooltipTrigger.
+
+#### Type Declaration
+
+| Name        | Type        |
+| ----------- | ----------- |
+| `asChild?`  | `boolean`   |
+| `children?` | `ReactNode` |
+
+---
+
+### TooltipContentProps
+
+```ts
+type TooltipContentProps = object & HTMLAttributes<HTMLDivElement>;
+```
+
+Props accepted by TooltipContent.
+
+#### Type Declaration
+
+| Name       | Type        |
+| ---------- | ----------- |
+| `children` | `ReactNode` |
+
+## Variables
+
+### Tooltip
+
+```ts
+const Tooltip: ForwardRefExoticComponent<
+  object &
+    Omit<HTMLAttributes<HTMLSpanElement>, "children"> &
+    RefAttributes<HTMLSpanElement>
+>;
+```
+
+A tooltip controller with explicit controlled or uncontrolled open state.
+
+---
+
+### TooltipTrigger
+
+```ts
+const TooltipTrigger: ForwardRefExoticComponent<
+  object &
+    ButtonHTMLAttributes<HTMLButtonElement> &
+    RefAttributes<HTMLButtonElement>
+>;
+```
+
+The trigger control for a Tooltip.
+
+---
+
+### TooltipContent
+
+```ts
+const TooltipContent: ForwardRefExoticComponent<
+  object & HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement>
+>;
+```
+
+The positioned content region for a Tooltip.

package/docs/api/components/trading-card.md

@@ -0,0 +1,95 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/trading-card
+
+# components/trading-card
+
+## Type Aliases
+
+### TradingCardFinish
+
+```ts
+type TradingCardFinish = "standard" | "holo";
+```
+
+Print finish: `holo` adds a foil sheen on hover that stills for reduced motion.
+
+---
+
+### TradingCardFact
+
+```ts
+type TradingCardFact = Readonly<{
+  label: string;
+  value: ReactNode;
+}>;
+```
+
+One footer fact, printed like a trading card's weakness or retreat line.
+
+---
+
+### TradingCardMove
+
+```ts
+type TradingCardMove = Readonly<{
+  cost?: ReactNode;
+  name: string;
+  value?: ReactNode;
+  children?: ReactNode;
+}>;
+```
+
+The card's one move: a cost of symbols, a name, and caller-owned text or
+controls.
+
+---
+
+### TradingCardProps
+
+```ts
+type TradingCardProps = Omit<
+  HTMLAttributes<HTMLElement>,
+  "title" | "children"
+> &
+  object;
+```
+
+Props accepted by TradingCard.
+
+#### Type Declaration
+
+| Name         | Type                                             | Description                                                     |
+| ------------ | ------------------------------------------------ | --------------------------------------------------------------- |
+| `name`       | `string`                                         | -                                                               |
+| `stage?`     | `string`                                         | A small stage label printed before the name, such as "Spore".   |
+| `stat?`      | `ReactNode`                                      | The stat printed at the right of the name bar, such as "60 SP". |
+| `typeLine?`  | `string`                                         | The type line under the art window.                             |
+| `art`        | `ReactNode`                                      | -                                                               |
+| `move`       | [`TradingCardMove`](#tradingcardmove)            | -                                                               |
+| `flavor?`    | `ReactNode`                                      | -                                                               |
+| `facts?`     | readonly [`TradingCardFact`](#tradingcardfact)[] | -                                                               |
+| `setNumber?` | `string`                                         | Collector number, such as "001/001".                            |
+| `rarity?`    | `ReactNode`                                      | A small rarity mark printed by the set number.                  |
+| `finish?`    | [`TradingCardFinish`](#tradingcardfinish)        | -                                                               |
+
+## Variables
+
+### TradingCard
+
+```ts
+const TradingCard: ForwardRefExoticComponent<
+  Omit<HTMLAttributes<HTMLElement>, "title" | "children"> &
+    object &
+    RefAttributes<HTMLElement>
+>;
+```
+
+A 63:88 trading card: a bright rim, a name bar with a stage and stat, an art
+window, one move row that can hold a real form, a flavor line and a footer of
+facts with a set number and rarity mark. The move body is caller-owned, so a
+form inside it keeps its own labels, focus and errors.

package/docs/api/components/undo-action.md

@@ -0,0 +1,117 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/undo-action
+
+# components/undo-action
+
+## Type Aliases
+
+### FuseProps
+
+```ts
+type FuseProps = object;
+```
+
+Props accepted by Fuse.
+
+#### Properties
+
+##### duration
+
+```ts
+duration: number;
+```
+
+How long the fuse burns, in milliseconds: a decision window, not motion.
+
+##### paused?
+
+```ts
+optional paused?: boolean;
+```
+
+Hold the burn, for example while the pointer rests on the action.
+
+##### onBurnt
+
+```ts
+onBurnt: () => void;
+```
+
+Called once when the fuse has burnt down.
+
+###### Returns
+
+`void`
+
+##### className?
+
+```ts
+optional className?: string;
+```
+
+---
+
+### UndoActionProps
+
+```ts
+type UndoActionProps = object &
+  Omit<ButtonProps, "children" | "onClick" | "result" | "resultLabel">;
+```
+
+Props accepted by UndoAction.
+
+#### Type Declaration
+
+| Name                 | Type         | Description                                                                |
+| -------------------- | ------------ | -------------------------------------------------------------------------- |
+| `children`           | `ReactNode`  | The action's label, such as "Stop".                                        |
+| `onCommit()`         | () => `void` | Runs when the undo window closes without an undo: the action happens then. |
+| `armedAnnouncement`  | `string`     | Spoken when the action is armed, such as "Port 5173 stops in 5 seconds".   |
+| `undoneAnnouncement` | `string`     | Spoken after an undo, such as "Port 5173 kept open".                       |
+| `undoLabel?`         | `ReactNode`  | -                                                                          |
+| `undoMs?`            | `number`     | The undo window in milliseconds.                                           |
+
+## Variables
+
+### UndoAction
+
+```ts
+const UndoAction: ForwardRefExoticComponent<
+  object &
+    Omit<ButtonProps, "children" | "onClick" | "result" | "resultLabel"> &
+    RefAttributes<HTMLButtonElement>
+>;
+```
+
+A destructive action that waits for its undo window instead of asking first.
+Pressing it turns the same button into Undo with a fuse burning along its edge;
+Undo or Escape cancels, and the action commits when the fuse runs out. Resting
+the pointer on it holds the fuse.
+
+## Functions
+
+### Fuse()
+
+```ts
+function Fuse(__namedParameters): Element;
+```
+
+A hairline that burns down over its duration, then calls `onBurnt`. Its
+thickness is the theme's `--stipe-motion-fuse` (0 hides it but the window still
+runs). Under reduced motion it ticks down once a second instead of burning
+smoothly.
+
+#### Parameters
+
+| Parameter           | Type                      |
+| ------------------- | ------------------------- |
+| `__namedParameters` | [`FuseProps`](#fuseprops) |
+
+#### Returns
+
+`Element`

package/docs/api/components/undo-toast.md

@@ -0,0 +1,49 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/undo-toast
+
+# components/undo-toast
+
+## Type Aliases
+
+### UndoToastOptions
+
+```ts
+type UndoToastOptions = Readonly<{
+  title: ReactNode;
+  description?: ReactNode;
+  onCommit: () => void;
+  onUndo?: () => void;
+  undoLabel?: string;
+  undoMs?: number;
+  toasterId?: string;
+}>;
+```
+
+What an undo toast says and does.
+
+## Functions
+
+### toastUndo()
+
+```ts
+function toastUndo(options): string | number;
+```
+
+Show a done-and-undoable toast: the action is deferred while a fuse burns along
+the toast's edge, Undo or Escape cancels it, and resting on the toast holds the
+fuse. Returns the toast id.
+
+#### Parameters
+
+| Parameter | Type                                    |
+| --------- | --------------------------------------- |
+| `options` | [`UndoToastOptions`](#undotoastoptions) |
+
+#### Returns
+
+`string` \| `number`

package/docs/api/components/visually-hidden.md

@@ -0,0 +1,37 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/visually-hidden
+
+# components/visually-hidden
+
+## Type Aliases
+
+### VisuallyHiddenProps
+
+```ts
+type VisuallyHiddenProps = object & HTMLAttributes<HTMLElement>;
+```
+
+Props accepted by VisuallyHidden.
+
+#### Type Declaration
+
+| Name       | Type      |
+| ---------- | --------- |
+| `asChild?` | `boolean` |
+
+## Variables
+
+### VisuallyHidden
+
+```ts
+const VisuallyHidden: ForwardRefExoticComponent<
+  object & HTMLAttributes<HTMLElement> & RefAttributes<HTMLElement>
+>;
+```
+
+Content visually hidden while remaining available to assistive technology.