@fungi.computer/caps 0.0.0-stage → 0.0.1

package/docs/api/components/icon-radio.md

@@ -0,0 +1,42 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/icon-radio
+
+# components/icon-radio
+
+## Type Aliases
+
+### IconRadioProps
+
+```ts
+type IconRadioProps = object &
+  Omit<RadioGroupItemProps, "children" | "indicator">;
+```
+
+Props accepted by IconRadio. Use it inside the existing RadioGroup.
+
+#### Type Declaration
+
+| Name       | Type        | Description                                                       |
+| ---------- | ----------- | ----------------------------------------------------------------- |
+| `label`    | `string`    | -                                                                 |
+| `icon`     | `ReactNode` | -                                                                 |
+| `caption?` | `string`    | A short visible legend; it does not replace the accessible label. |
+
+## Variables
+
+### IconRadio
+
+```ts
+const IconRadio: ForwardRefExoticComponent<
+  object &
+    Omit<RadioGroupItemProps, "children" | "indicator"> &
+    RefAttributes<HTMLInputElement>
+>;
+```
+
+One icon choice in a native, mutually exclusive Caps RadioGroup.

package/docs/api/components/inline-code.md

@@ -0,0 +1,21 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/inline-code
+
+# components/inline-code
+
+## Variables
+
+### InlineCode
+
+```ts
+const InlineCode: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLElement> & RefAttributes<HTMLElement>
+>;
+```
+
+A subdued inline code value for identifiers and other technical labels.

package/docs/api/components/input-group.md

@@ -0,0 +1,53 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/input-group
+
+# components/input-group
+
+## Type Aliases
+
+### InputGroupProps
+
+```ts
+type InputGroupProps = HTMLAttributes<HTMLDivElement>;
+```
+
+Props accepted by InputGroup.
+
+---
+
+### InputGroupAddonProps
+
+```ts
+type InputGroupAddonProps = HTMLAttributes<HTMLDivElement>;
+```
+
+Props accepted by InputGroupAddon.
+
+## Variables
+
+### InputGroup
+
+```ts
+const InputGroup: ForwardRefExoticComponent<
+  InputGroupProps & RefAttributes<HTMLDivElement>
+>;
+```
+
+Join a control with caller-owned prefixes, suffixes, or actions.
+
+---
+
+### InputGroupAddon
+
+```ts
+const InputGroupAddon: ForwardRefExoticComponent<
+  InputGroupAddonProps & RefAttributes<HTMLDivElement>
+>;
+```
+
+An addon region for an InputGroup.

package/docs/api/components/input.md

@@ -0,0 +1,54 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/input
+
+# components/input
+
+## Type Aliases
+
+### InputProps
+
+```ts
+type InputProps = object & InputHTMLAttributes<HTMLInputElement>;
+```
+
+Props accepted by Input.
+
+#### Type Declaration
+
+| Name       | Type      |
+| ---------- | --------- |
+| `invalid?` | `boolean` |
+
+## Variables
+
+### Input
+
+```ts
+const Input: ForwardRefExoticComponent<
+  object &
+    InputHTMLAttributes<HTMLInputElement> &
+    RefAttributes<HTMLInputElement>
+>;
+```
+
+A styled native text input that preserves caller-owned value and event behavior.
+
+---
+
+### SearchInput
+
+```ts
+const SearchInput: ForwardRefExoticComponent<
+  object &
+    InputHTMLAttributes<HTMLInputElement> &
+    object &
+    RefAttributes<HTMLInputElement>
+>;
+```
+
+A native search input with an optional decorative leading icon.

package/docs/api/components/item-grid.md

@@ -0,0 +1,262 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/item-grid
+
+# components/item-grid
+
+## Type Aliases
+
+### ItemGridItem
+
+```ts
+type ItemGridItem = object;
+```
+
+One item placed on the grid. Coordinates are cells from the top left.
+
+#### Properties
+
+##### id
+
+```ts
+id: string;
+```
+
+##### label
+
+```ts
+label: string;
+```
+
+Accessible name, e.g. "Axe" or "Bread".
+
+##### x
+
+```ts
+x: number;
+```
+
+##### y
+
+```ts
+y: number;
+```
+
+##### w?
+
+```ts
+optional w?: number;
+```
+
+Footprint width in cells after rotation. Defaults to 1.
+
+##### h?
+
+```ts
+optional h?: number;
+```
+
+Footprint height in cells after rotation. Defaults to 1.
+
+##### icon?
+
+```ts
+optional icon?: ReactNode;
+```
+
+Decorative art: a sprite, an image or an SVG.
+
+##### quantity?
+
+```ts
+optional quantity?: number;
+```
+
+Stack count, drawn in pixel numerals when above 1.
+
+##### selected?
+
+```ts
+optional selected?: boolean;
+```
+
+---
+
+### ItemGridGhost
+
+```ts
+type ItemGridGhost = object;
+```
+
+A drop preview: where the held item would land, and whether it may.
+
+#### Properties
+
+##### x
+
+```ts
+x: number;
+```
+
+##### y
+
+```ts
+y: number;
+```
+
+##### w
+
+```ts
+w: number;
+```
+
+##### h
+
+```ts
+h: number;
+```
+
+##### legal
+
+```ts
+legal: boolean;
+```
+
+##### reason?
+
+```ts
+optional reason?: string;
+```
+
+Why an illegal drop is refused, in the host's words.
+
+---
+
+### ItemGridCell
+
+```ts
+type ItemGridCell = object;
+```
+
+A grid cell, with the item covering it if any.
+
+#### Properties
+
+##### x
+
+```ts
+x: number;
+```
+
+##### y
+
+```ts
+y: number;
+```
+
+##### item
+
+```ts
+item: ItemGridItem | null;
+```
+
+---
+
+### ItemGridCellSize
+
+```ts
+type ItemGridCellSize = "sm" | "md" | "lg";
+```
+
+Cell sizes: pockets, a backpack and a big chest view.
+
+---
+
+### ItemGridProps
+
+```ts
+type ItemGridProps = Omit<HTMLAttributes<HTMLDivElement>, "children"> & object;
+```
+
+Props accepted by ItemGrid.
+
+#### Type Declaration
+
+| Name                    | Type                                        | Description                                                             |
+| ----------------------- | ------------------------------------------- | ----------------------------------------------------------------------- |
+| `label`                 | `string`                                    | Accessible name of the container, e.g. "Backpack".                      |
+| `columns`               | `number`                                    | -                                                                       |
+| `rows`                  | `number`                                    | -                                                                       |
+| `items`                 | readonly [`ItemGridItem`](#itemgriditem)[]  | -                                                                       |
+| `ghost?`                | [`ItemGridGhost`](#itemgridghost) \| `null` | -                                                                       |
+| `cellSize?`             | [`ItemGridCellSize`](#itemgridcellsize)     | -                                                                       |
+| `activeCell?`           | `object`                                    | Controlled keyboard cursor. Omit to let the grid keep its own.          |
+| `activeCell.x`          | `number`                                    | -                                                                       |
+| `activeCell.y`          | `number`                                    | -                                                                       |
+| `onActiveCellChange()?` | (`cell`) => `void`                          | The keyboard cursor moved to another cell.                              |
+| `onCellActivate()?`     | (`cell`) => `void`                          | Click, Enter or Space on a cell. The host decides pick up, drop or use. |
+| `onCellHover()?`        | (`cell`) => `void`                          | Pointer over a cell, or `null` on leaving the grid; for drag ghosts.    |
+
+---
+
+### ItemSlotState
+
+```ts
+type ItemSlotState = "idle" | "legal" | "illegal";
+```
+
+How a slot answers the item being held over it.
+
+---
+
+### ItemSlotProps
+
+```ts
+type ItemSlotProps = Omit<ButtonHTMLAttributes<HTMLButtonElement>, "children"> &
+  object;
+```
+
+Props accepted by ItemSlot.
+
+#### Type Declaration
+
+| Name           | Type                                                        | Description                                      |
+| -------------- | ----------------------------------------------------------- | ------------------------------------------------ |
+| `label`        | `string`                                                    | Slot name, e.g. "Head" or "Main hand".           |
+| `item?`        | \| \{ `label`: `string`; `icon?`: `ReactNode`; \} \| `null` | The equipped item, if any.                       |
+| `placeholder?` | `ReactNode`                                                 | Faint outline art shown while the slot is empty. |
+| `state?`       | [`ItemSlotState`](#itemslotstate)                           | -                                                |
+
+## Variables
+
+### ItemGrid
+
+```ts
+const ItemGrid: ForwardRefExoticComponent<
+  Omit<HTMLAttributes<HTMLDivElement>, "children"> &
+    object &
+    RefAttributes<HTMLDivElement>
+>;
+```
+
+A Diablo-style item grid. Cells carry the keyboard and pointer interface; items
+and the drop ghost are drawn above them from the host's facts. The grid never
+moves, merges or validates items: it shows what the host says.
+
+---
+
+### ItemSlot
+
+```ts
+const ItemSlot: ForwardRefExoticComponent<
+  Omit<ButtonHTMLAttributes<HTMLButtonElement>, "children"> &
+    object &
+    RefAttributes<HTMLButtonElement>
+>;
+```
+
+One equipment slot for a paper doll: a pocket, its item and its name.

package/docs/api/components/keycap.md

@@ -0,0 +1,102 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/keycap
+
+# components/keycap
+
+## Type Aliases
+
+### KeycapTone
+
+```ts
+type KeycapTone = "neutral" | "primary" | "accent" | "inverse" | "destructive";
+```
+
+Molded key colors. `inverse` is the contrasting key; `destructive` stays neutral
+until hovered or focused; the rest follow the theme.
+
+---
+
+### KeycapSize
+
+```ts
+type KeycapSize = "sm" | "md" | "lg";
+```
+
+Keycap sizes: a legend chip, a dock key and a big face key.
+
+---
+
+### KeycapProps
+
+```ts
+type KeycapProps = HTMLAttributes<HTMLElement> & object;
+```
+
+Props accepted by Keycap.
+
+#### Type Declaration
+
+| Name       | Type                        | Description                                                     |
+| ---------- | --------------------------- | --------------------------------------------------------------- |
+| `tone?`    | [`KeycapTone`](#keycaptone) | -                                                               |
+| `size?`    | [`KeycapSize`](#keycapsize) | -                                                               |
+| `pressed?` | `boolean`                   | Show the key held down. Presentation only; the host owns input. |
+
+---
+
+### KeycapButtonProps
+
+```ts
+type KeycapButtonProps = Omit<
+  ButtonHTMLAttributes<HTMLButtonElement>,
+  "children"
+> &
+  object;
+```
+
+Props accepted by KeycapButton.
+
+#### Type Declaration
+
+| Name        | Type                        | Description                                                                                                                                         |
+| ----------- | --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `label`     | `ReactNode`                 | Visible name of the action, e.g. "Build". `null` makes an icon-only key, which then needs an `aria-label`.                                          |
+| `shortcut?` | `string`                    | The keyboard key that runs the same action, shown as a small keycap.                                                                                |
+| `icon?`     | `ReactNode`                 | Decorative icon before the label.                                                                                                                   |
+| `readout?`  | `ReactNode`                 | Extra readout after the label, such as a PixelNumber count.                                                                                         |
+| `tone?`     | [`KeycapTone`](#keycaptone) | -                                                                                                                                                   |
+| `pressed?`  | `boolean`                   | Toggle state for mode keys. `undefined` is a momentary key; a boolean adds `aria-pressed` and lights the key's indicator.                           |
+| `expanded?` | `boolean`                   | Disclosure state for keys that open a palette or window. A boolean adds `aria-expanded` and lights the lamp; use it instead of `pressed` for menus. |
+
+## Variables
+
+### Keycap
+
+```ts
+const Keycap: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLElement> & object & RefAttributes<HTMLElement>
+>;
+```
+
+One molded key legend, rendered as native `<kbd>`: the key a player presses. The
+key sits on its own travel so pressed and resting keys take the same room.
+
+---
+
+### KeycapButton
+
+```ts
+const KeycapButton: ForwardRefExoticComponent<
+  Omit<ButtonHTMLAttributes<HTMLButtonElement>, "children"> &
+    object &
+    RefAttributes<HTMLButtonElement>
+>;
+```
+
+A chunky action key for game docks and toy panels. The host owns the action and
+the keyboard binding; `shortcut` only labels it.

package/docs/api/components/label.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/label
+
+# components/label
+
+## Type Aliases
+
+### LabelProps
+
+```ts
+type LabelProps = object & LabelHTMLAttributes<HTMLLabelElement>;
+```
+
+Props accepted by Label.
+
+#### Type Declaration
+
+| Name        | Type      | Description                                     |
+| ----------- | --------- | ----------------------------------------------- |
+| `optional?` | `boolean` | Adds a quiet "Optional" readout after the text. |
+| `required?` | `boolean` | -                                               |
+
+## Variables
+
+### Label
+
+```ts
+const Label: ForwardRefExoticComponent<
+  object &
+    LabelHTMLAttributes<HTMLLabelElement> &
+    RefAttributes<HTMLLabelElement>
+>;
+```
+
+A label primitive that associates caller-provided text with a form control.

package/docs/api/components/listbox.md

@@ -0,0 +1,131 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/listbox
+
+# components/listbox
+
+## Type Aliases
+
+### ListboxItemState
+
+```ts
+type ListboxItemState = object;
+```
+
+Intrinsic focus and selection state supplied when rendering a Listbox item.
+
+#### Properties
+
+##### active
+
+```ts
+active: boolean;
+```
+
+##### disabled
+
+```ts
+disabled: boolean;
+```
+
+##### selected
+
+```ts
+selected: boolean;
+```
+
+---
+
+### ListboxProps
+
+```ts
+type ListboxProps<T, Multiple> = object &
+  Omit<
+    HTMLAttributes<HTMLDivElement>,
+    "defaultValue" | "onChange" | "onSelect" | "value"
+  > &
+  Multiple extends true
+  ? object
+  : Multiple extends false
+    ? object
+    : | {
+          defaultValue?: ListboxValue;
+          multiple?: false;
+          onValueChange?: (value, item) => void;
+          value?: ListboxValue;
+        }
+      | {
+          defaultValue?: ListboxValue<true>;
+          multiple: true;
+          onValueChange?: (value, item) => void;
+          value?: ListboxValue<true>;
+        };
+```
+
+Props accepted by Listbox.
+
+#### Type Declaration
+
+| Name            | Type                                       | Description                                                   |
+| --------------- | ------------------------------------------ | ------------------------------------------------------------- |
+| `emptyMessage?` | `ReactNode`                                | -                                                             |
+| `getKey()`      | (`item`) => `string`                       | Returns the stable key used for focus and selection.          |
+| `getLabel()`    | (`item`) => `string`                       | Returns the accessible label used for an item.                |
+| `isDisabled()?` | (`item`) => `boolean`                      | Determines whether an item can receive focus or selection.    |
+| `items`         | readonly `T`[]                             | -                                                             |
+| `rootRef?`      | `React.Ref`\<`HTMLDivElement`\>            | Receives the selection control's root div.                    |
+| `renderItem()?` | (`item`, `active`, `state`) => `ReactNode` | Renders an item with its intrinsic focus and selection state. |
+
+#### Type Parameters
+
+| Type Parameter                 | Default type |
+| ------------------------------ | ------------ |
+| `T`                            | -            |
+| `Multiple` _extends_ `boolean` | `false`      |
+
+---
+
+### ListboxValue
+
+```ts
+type ListboxValue<Multiple> = Multiple extends true ? string[] : null | string;
+```
+
+Supported ListboxValue values.
+
+#### Type Parameters
+
+| Type Parameter                 | Default type |
+| ------------------------------ | ------------ |
+| `Multiple` _extends_ `boolean` | `false`      |
+
+## Functions
+
+### Listbox()
+
+```ts
+function Listbox<T>(input): Element;
+```
+
+A selection primitive with caller-owned values and intrinsic keyboard
+navigation.
+
+#### Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `T`            |
+
+#### Parameters
+
+| Parameter | Type                                              |
+| --------- | ------------------------------------------------- |
+| `input`   | [`ListboxProps`](#listboxprops)\<`T`, `boolean`\> |
+
+#### Returns
+
+`Element`