@fungi.computer/caps 0.0.0-stage → 0.0.1

package/docs/api/components/game-hud.md

@@ -0,0 +1,359 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/game-hud
+
+# components/game-hud
+
+## Type Aliases
+
+### GameRegionName
+
+```ts
+type GameRegionName =
+  "top-left" | "top-right" | "right" | "bottom" | "bottom-left" | "center";
+```
+
+A region of the game layer, laid over a full-bleed world.
+
+---
+
+### HudTone
+
+```ts
+type HudTone = "success" | "warning" | "error" | "info";
+```
+
+Semantic bar tones; the theme supplies each colour.
+
+---
+
+### HudBarProps
+
+```ts
+type HudBarProps = Omit<HTMLAttributes<HTMLDivElement>, "children"> & object;
+```
+
+Props accepted by HudBar.
+
+#### Type Declaration
+
+| Name     | Type                  |
+| -------- | --------------------- |
+| `label`  | `string`              |
+| `value`  | `number`              |
+| `max`    | `number`              |
+| `tone?`  | [`HudTone`](#hudtone) |
+| `glyph?` | `ReactNode`           |
+
+---
+
+### HudPhase
+
+```ts
+type HudPhase = "day" | "dusk" | "night" | "dawn";
+```
+
+The light of the day a clock shows.
+
+---
+
+### PortraitMood
+
+```ts
+type PortraitMood = "ok" | "warn" | "bad";
+```
+
+How a portrait's subject is doing.
+
+---
+
+### MinimapMarkKind
+
+```ts
+type MinimapMarkKind = "self" | "ally" | "foe" | "place" | "goal";
+```
+
+What a minimap mark stands for; the theme colours each kind.
+
+---
+
+### MinimapMark
+
+```ts
+type MinimapMark = Readonly<{
+  x: number;
+  y: number;
+  kind: MinimapMarkKind;
+  label: string;
+}>;
+```
+
+One mark on the minimap, in whole grid cells.
+
+---
+
+### GameCardKind
+
+```ts
+type GameCardKind = "goal" | "letter" | "dialogue" | "end" | "screen";
+```
+
+What a game card is for; each kind sets its size and voice.
+
+---
+
+### RecipePart
+
+```ts
+type RecipePart = Readonly<{
+  label: string;
+  glyph: string;
+  have?: number;
+  need?: number;
+  quantity?: number;
+}>;
+```
+
+One ingredient or product of a recipe.
+
+## Variables
+
+### GameLayer
+
+```ts
+const GameLayer: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & object & RefAttributes<HTMLDivElement>
+>;
+```
+
+Positions HUD regions over the world; the world stays interactive between them.
+
+---
+
+### GameRegion
+
+```ts
+const GameRegion: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & object & RefAttributes<HTMLDivElement>
+>;
+```
+
+One named HUD region; only its children take pointer input.
+
+---
+
+### GameScrim
+
+```ts
+const GameScrim: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement>
+>;
+```
+
+A dimmed stage for title, pause and end screens; it centres one card.
+
+---
+
+### HudPlate
+
+```ts
+const HudPlate: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & object & RefAttributes<HTMLDivElement>
+>;
+```
+
+A floating paper plate drawn in the sprites' ink line.
+
+---
+
+### HudBar
+
+```ts
+const HudBar: ForwardRefExoticComponent<
+  Omit<HTMLAttributes<HTMLDivElement>, "children"> &
+    object &
+    RefAttributes<HTMLDivElement>
+>;
+```
+
+A segmented resource bar: health, hunger, noise, hull.
+
+---
+
+### HudChip
+
+```ts
+const HudChip: ForwardRefExoticComponent<
+  Omit<HTMLAttributes<HTMLSpanElement>, "children"> &
+    object &
+    RefAttributes<HTMLSpanElement>
+>;
+```
+
+A counted thing on the HUD: bandages, crowns, round shot.
+
+---
+
+### HudClock
+
+```ts
+const HudClock: ForwardRefExoticComponent<
+  Omit<HTMLAttributes<HTMLDivElement>, "children"> &
+    object &
+    RefAttributes<HTMLDivElement>
+>;
+```
+
+The game clock: a phase mark, a label, an optional countdown and time.
+
+---
+
+### Portrait
+
+```ts
+const Portrait: ForwardRefExoticComponent<
+  Omit<HTMLAttributes<HTMLDivElement>, "children"> &
+    object &
+    RefAttributes<HTMLDivElement>
+>;
+```
+
+A person in the portrait strip: their mark, name and what they are doing.
+
+---
+
+### MinimapPlate
+
+```ts
+const MinimapPlate: ForwardRefExoticComponent<
+  Omit<HTMLAttributes<HTMLElement>, "children"> &
+    object &
+    RefAttributes<HTMLElement>
+>;
+```
+
+A small chart of the world: a paper grid with named marks. Names are laid out so
+none overlap (layoutMinimapLabels); one with no room hides and shows on hover or
+focus.
+
+---
+
+### GameCard
+
+```ts
+const GameCard: ForwardRefExoticComponent<
+  Omit<HTMLAttributes<HTMLElement>, "title"> &
+    object &
+    RefAttributes<HTMLElement>
+>;
+```
+
+A paper card: goals, letters, dialogue, pause and end screens.
+
+---
+
+### HudKeys
+
+```ts
+const HudKeys: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & object & RefAttributes<HTMLDivElement>
+>;
+```
+
+A row of keycaps: a dock across the bottom or a rail down the side.
+
+---
+
+### OfferRow
+
+```ts
+const OfferRow: ForwardRefExoticComponent<
+  Omit<HTMLAttributes<HTMLDivElement>, "children"> &
+    object &
+    RefAttributes<HTMLDivElement>
+>;
+```
+
+A shop or trade line: what, why, how much, and the act of buying it.
+
+---
+
+### RecipeRow
+
+```ts
+const RecipeRow: ForwardRefExoticComponent<
+  Omit<HTMLAttributes<HTMLDivElement>, "children"> &
+    object &
+    RefAttributes<HTMLDivElement>
+>;
+```
+
+A workbench recipe: inputs (short ones marked) become the output.
+
+## Functions
+
+### HudNumber()
+
+```ts
+function HudNumber(__namedParameters): Element;
+```
+
+A readable number in the theme's numeric font.
+
+#### Parameters
+
+| Parameter                 | Type                                                            |
+| ------------------------- | --------------------------------------------------------------- |
+| `__namedParameters`       | \{ `value`: `string` \| `number`; `size?`: `"sm"` \| `"md"`; \} |
+| `__namedParameters.value` | `string` \| `number`                                            |
+| `__namedParameters.size?` | `"sm"` \| `"md"`                                                |
+
+#### Returns
+
+`Element`
+
+---
+
+### GoalLine()
+
+```ts
+function GoalLine(__namedParameters): Element;
+```
+
+A ticked or open line on a goal card.
+
+#### Parameters
+
+| Parameter                    | Type                                              |
+| ---------------------------- | ------------------------------------------------- |
+| `__namedParameters`          | \{ `done`: `boolean`; `children`: `ReactNode`; \} |
+| `__namedParameters.done`     | `boolean`                                         |
+| `__namedParameters.children` | `ReactNode`                                       |
+
+#### Returns
+
+`Element`
+
+---
+
+### MadeWith()
+
+```ts
+function MadeWith(__namedParameters): Element;
+```
+
+The quiet credit line on an end card.
+
+#### Parameters
+
+| Parameter           | Type                                                                  |
+| ------------------- | --------------------------------------------------------------------- |
+| `__namedParameters` | `Omit`\<`AnchorHTMLAttributes`\<`HTMLAnchorElement`\>, `"children"`\> |
+
+#### Returns
+
+`Element`

package/docs/api/components/generation-frame.md

@@ -0,0 +1,59 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/generation-frame
+
+# components/generation-frame
+
+## Type Aliases
+
+### GenerationStatus
+
+```ts
+type GenerationStatus =
+  "queued" | "generating" | "refining" | "done" | "failed";
+```
+
+Where one generated piece of media is in its life.
+
+---
+
+### GenerationFrameProps
+
+```ts
+type GenerationFrameProps = object &
+  Omit<HTMLAttributes<HTMLDivElement>, "children">;
+```
+
+Props accepted by GenerationFrame.
+
+#### Type Declaration
+
+| Name           | Type                                    | Description                                                      |
+| -------------- | --------------------------------------- | ---------------------------------------------------------------- |
+| `status`       | [`GenerationStatus`](#generationstatus) | -                                                                |
+| `children?`    | `ReactNode`                             | The finished media (or, while refining, a rough preview of it).  |
+| `aspectRatio?` | `number`                                | Width over height. Omit when the parent already sizes the frame. |
+| `label?`       | `ReactNode`                             | What is happening, for people using a screen reader.             |
+| `indicator?`   | `ReactNode`                             | The working indicator; Caps' bloom loader by default.            |
+| `failure?`     | `ReactNode`                             | Shown over the dimmed frame when generation fails.               |
+
+## Variables
+
+### GenerationFrame
+
+```ts
+const GenerationFrame: ForwardRefExoticComponent<
+  object &
+    Omit<HTMLAttributes<HTMLDivElement>, "children"> &
+    RefAttributes<HTMLDivElement>
+>;
+```
+
+One fixed frame for a generation, from queued to done: the frame keeps its size
+the whole time, so nothing around it moves. The finished media develops inside
+it (it sharpens out of a soft blur), and a failure dims the frame behind its
+message. Reduced motion keeps short fades only.

package/docs/api/components/hold-button.md

@@ -0,0 +1,44 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/hold-button
+
+# components/hold-button
+
+## Type Aliases
+
+### HoldButtonProps
+
+```ts
+type HoldButtonProps = object & Omit<ButtonProps, "children" | "onClick">;
+```
+
+Props accepted by HoldButton.
+
+#### Type Declaration
+
+| Name          | Type         | Description                                                        |
+| ------------- | ------------ | ------------------------------------------------------------------ |
+| `children`    | `ReactNode`  | -                                                                  |
+| `onConfirm()` | () => `void` | Runs once the button has been held for `holdMs`.                   |
+| `holdMs?`     | `number`     | How long to hold, in milliseconds: a deliberate pause, not motion. |
+| `holdHint?`   | `string`     | Spoken description of the gesture.                                 |
+
+## Variables
+
+### HoldButton
+
+```ts
+const HoldButton: ForwardRefExoticComponent<
+  object &
+    Omit<ButtonProps, "children" | "onClick"> &
+    RefAttributes<HTMLButtonElement>
+>;
+```
+
+For an action nothing can undo: press and hold (pointer, Space or Enter) while a
+fill rises; let go early and it drops back; hold to the top and the action runs.
+Under reduced motion the fill rises in three steps.

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

@@ -0,0 +1,56 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/icon-button
+
+# components/icon-button
+
+## Type Aliases
+
+### IconButtonIconSize
+
+```ts
+type IconButtonIconSize = "xs" | "sm" | "md" | "lg";
+```
+
+Supported IconButton glyph sizes.
+
+---
+
+### IconButtonProps
+
+```ts
+type IconButtonProps = object & Omit<ButtonProps, "children" | "size">;
+```
+
+Props accepted by IconButton.
+
+#### Type Declaration
+
+| Name         | Type                                                                 |
+| ------------ | -------------------------------------------------------------------- |
+| `aria-label` | `string`                                                             |
+| `active?`    | `boolean`                                                            |
+| `icon`       | `ReactNode`                                                          |
+| `iconSize?`  | [`IconButtonIconSize`](#iconbuttoniconsize)                          |
+| `reveal?`    | `boolean`                                                            |
+| `size?`      | [`ButtonProps`](button.md#buttonprops)\[`"size"`\] \| `"responsive"` |
+| `tone?`      | `"default"` \| `"destructive"`                                       |
+
+## Variables
+
+### IconButton
+
+```ts
+const IconButton: ForwardRefExoticComponent<
+  object &
+    Omit<ButtonProps, "children" | "size"> &
+    RefAttributes<HTMLButtonElement>
+>;
+```
+
+A compact button for an icon control with an accessible name supplied by the
+caller.

package/docs/api/components/icon-checkbox.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-checkbox
+
+# components/icon-checkbox
+
+## Type Aliases
+
+### IconCheckboxProps
+
+```ts
+type IconCheckboxProps = object & Omit<CheckboxProps, "children" | "indicator">;
+```
+
+Props accepted by IconCheckbox. The full label names the native input.
+
+#### Type Declaration
+
+| Name          | Type                       | Description                                                           |
+| ------------- | -------------------------- | --------------------------------------------------------------------- |
+| `label`       | `string`                   | -                                                                     |
+| `icon`        | `ReactNode`                | -                                                                     |
+| `caption?`    | `string`                   | A short visible legend; it does not replace the accessible label.     |
+| `appearance?` | `"default"` \| `"compact"` | Compact instruments show the icon and caption without a tile or lamp. |
+
+## Variables
+
+### IconCheckbox
+
+```ts
+const IconCheckbox: ForwardRefExoticComponent<
+  object &
+    Omit<CheckboxProps, "children" | "indicator"> &
+    RefAttributes<HTMLInputElement>
+>;
+```
+
+An independent icon choice composed from the native Caps Checkbox.

package/docs/api/components/icon-choice-mark.md

@@ -0,0 +1,31 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/icon-choice-mark
+
+# components/icon-choice-mark
+
+## Functions
+
+### IconChoiceMark()
+
+```ts
+function IconChoiceMark(__namedParameters): Element;
+```
+
+The decorative face shared by icon choices; its native input names it.
+
+#### Parameters
+
+| Parameter                    | Type                                             |
+| ---------------------------- | ------------------------------------------------ |
+| `__namedParameters`          | \{ `icon`: `ReactNode`; `caption?`: `string`; \} |
+| `__namedParameters.icon`     | `ReactNode`                                      |
+| `__namedParameters.caption?` | `string`                                         |
+
+#### Returns
+
+`Element`

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

@@ -0,0 +1,92 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/icon-lamp
+
+# components/icon-lamp
+
+## Type Aliases
+
+### IconLampProps
+
+```ts
+type IconLampProps = object & Omit<HTMLAttributes<HTMLElement>, "children">;
+```
+
+Props accepted by IconLamp.
+
+#### Type Declaration
+
+| Name           | Type                            | Description                                                          |
+| -------------- | ------------------------------- | -------------------------------------------------------------------- |
+| `label`        | `string`                        | The full name read with the state, such as "Read files".             |
+| `icon`         | `ReactNode`                     | -                                                                    |
+| `caption?`     | `string`                        | A short visible legend; it does not replace the accessible label.    |
+| `on`           | `boolean`                       | Lit: the icon in colour with the ink lamp. Off: the grey silhouette. |
+| `stateLabels?` | readonly \[`string`, `string`\] | How the state reads aloud, as [on, off].                             |
+
+---
+
+### IconLampItem
+
+```ts
+type IconLampItem = Omit<IconLampProps, "stateLabels"> & object;
+```
+
+One lamp in an IconLamps row.
+
+#### Type Declaration
+
+| Name | Type     |
+| ---- | -------- |
+| `id` | `string` |
+
+---
+
+### IconLampsProps
+
+```ts
+type IconLampsProps = object &
+  Omit<HTMLAttributes<HTMLUListElement>, "children">;
+```
+
+Props accepted by IconLamps.
+
+#### Type Declaration
+
+| Name           | Type                                       |
+| -------------- | ------------------------------------------ |
+| `items`        | readonly [`IconLampItem`](#iconlampitem)[] |
+| `stateLabels?` | readonly \[`string`, `string`\]            |
+
+## Variables
+
+### IconLamp
+
+```ts
+const IconLamp: ForwardRefExoticComponent<
+  object &
+    Omit<HTMLAttributes<HTMLElement>, "children"> &
+    RefAttributes<HTMLElement>
+>;
+```
+
+A read-only icon state: an icon key's face with no input, for rights or settings
+shown but not changed here. It reads as "Label: state".
+
+---
+
+### IconLamps
+
+```ts
+const IconLamps: ForwardRefExoticComponent<
+  object &
+    Omit<HTMLAttributes<HTMLUListElement>, "children"> &
+    RefAttributes<HTMLUListElement>
+>;
+```
+
+A named row of read-only icon lamps; name it with `aria-label(ledby)`.