@fungi.computer/caps 0.0.0-stage → 0.0.1

package/docs/api/components/presence.md

@@ -0,0 +1,106 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/presence
+
+# components/presence
+
+## Type Aliases
+
+### PresenceProps
+
+```ts
+type PresenceProps = object & HTMLAttributes<HTMLDivElement>;
+```
+
+Props accepted by Presence.
+
+#### Type Declaration
+
+| Name       | Type        | Description                                                                      |
+| ---------- | ----------- | -------------------------------------------------------------------------------- |
+| `show`     | `boolean`   | Whether the content is present. Leaving content stays mounted until it has left. |
+| `appear?`  | `boolean`   | Animate the first mount too (for content that arrives after the page).           |
+| `children` | `ReactNode` | -                                                                                |
+
+---
+
+### CollapseProps
+
+```ts
+type CollapseProps = object & HTMLAttributes<HTMLDivElement>;
+```
+
+Props accepted by Collapse.
+
+#### Type Declaration
+
+| Name       | Type        | Description                                                                              |
+| ---------- | ----------- | ---------------------------------------------------------------------------------------- |
+| `open`     | `boolean`   | Open: the content takes its height. Closed: no space, and out of the accessibility tree. |
+| `children` | `ReactNode` | -                                                                                        |
+
+---
+
+### SwapProps
+
+```ts
+type SwapProps = object & HTMLAttributes<HTMLDivElement>;
+```
+
+Props accepted by Swap.
+
+#### Type Declaration
+
+| Name       | Type                 | Description                                                                                 |
+| ---------- | -------------------- | ------------------------------------------------------------------------------------------- |
+| `swapKey`  | `string`             | Names the current content. A new key crossfades from the old content to the new.            |
+| `anchor?`  | `"start"` \| `"end"` | Which edge leaving content holds to while the box resizes; `end` for right-aligned actions. |
+| `children` | `ReactNode`          | -                                                                                           |
+
+## Variables
+
+### Presence
+
+```ts
+const Presence: ForwardRefExoticComponent<
+  object & HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement>
+>;
+```
+
+Content that arrives and leaves instead of popping: it makes room, fades in
+while travelling the theme's `--stipe-motion-distance`, and on leaving fades out
+and gives its room back before it unmounts. Reduced motion keeps a short fade
+only.
+
+---
+
+### Collapse
+
+```ts
+const Collapse: ForwardRefExoticComponent<
+  object & HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement>
+>;
+```
+
+Content that opens and closes its own space: an inserted alert, a field error, a
+disclosure body. Height and opacity follow the theme's tempo; under reduced
+motion the space changes at once and only the fade remains.
+
+---
+
+### Swap
+
+```ts
+const Swap: ForwardRefExoticComponent<
+  object & HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement>
+>;
+```
+
+One piece of content replaced by another without a hard cut: loading to loaded,
+"Saving…" to "Saved". The old content fades out (blurred by the theme's
+`--stipe-motion-blur`) as the new one arrives, and the box eases to the new
+size. Reduced motion keeps the crossfade and drops the travel.

package/docs/api/components/price-tag.md

@@ -0,0 +1,48 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/price-tag
+
+# components/price-tag
+
+## Type Aliases
+
+### PriceTagProps
+
+```ts
+type PriceTagProps = Readonly<{
+  price:
+    | {
+        kind: "free";
+      }
+    | {
+        kind: "one-time";
+        label: string;
+      };
+}>;
+```
+
+The caller-provided price shown on a store entry.
+
+## Functions
+
+### PriceTag()
+
+```ts
+function PriceTag(__namedParameters): Element;
+```
+
+A compact, theme-backed price label for store entries.
+
+#### Parameters
+
+| Parameter           | Type                              |
+| ------------------- | --------------------------------- |
+| `__namedParameters` | [`PriceTagProps`](#pricetagprops) |
+
+#### Returns
+
+`Element`

package/docs/api/components/progress.md

@@ -0,0 +1,90 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/progress
+
+# components/progress
+
+## Type Aliases
+
+### ProgressTone
+
+```ts
+type ProgressTone =
+  | "neutral"
+  | "primary"
+  | "secondary"
+  | "accent"
+  | "success"
+  | "info"
+  | "warning"
+  | "error";
+```
+
+Supported ProgressTone values.
+
+---
+
+### ProgressProps
+
+```ts
+type ProgressProps = object & ProgressHTMLAttributes<HTMLProgressElement>;
+```
+
+Props accepted by Progress.
+
+#### Type Declaration
+
+| Name    | Type                            |
+| ------- | ------------------------------- |
+| `tone?` | [`ProgressTone`](#progresstone) |
+
+---
+
+### GameMeterProps
+
+```ts
+type GameMeterProps = Omit<HTMLAttributes<HTMLDivElement>, "children"> & object;
+```
+
+A compact labelled resource meter for game windows. Values come from the game.
+
+#### Type Declaration
+
+| Name    | Type                            |
+| ------- | ------------------------------- |
+| `label` | `string`                        |
+| `value` | `number`                        |
+| `max`   | `number`                        |
+| `tone?` | [`ProgressTone`](#progresstone) |
+
+## Variables
+
+### Progress
+
+```ts
+const Progress: ForwardRefExoticComponent<
+  object &
+    ProgressHTMLAttributes<HTMLProgressElement> &
+    RefAttributes<HTMLProgressElement>
+>;
+```
+
+A progress indicator for caller-provided progress values.
+
+---
+
+### GameMeter
+
+```ts
+const GameMeter: ForwardRefExoticComponent<
+  Omit<HTMLAttributes<HTMLDivElement>, "children"> &
+    object &
+    RefAttributes<HTMLDivElement>
+>;
+```
+
+Pair a game's bounded resource value with its visible and accessible meter.

package/docs/api/components/prose.md

@@ -0,0 +1,48 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/prose
+
+# components/prose
+
+## Type Aliases
+
+### ProseVariant
+
+```ts
+type ProseVariant = "default" | "dropcap";
+```
+
+Supported Prose treatments.
+
+---
+
+### ProseProps
+
+```ts
+type ProseProps = object & HTMLAttributes<HTMLElement>;
+```
+
+Props accepted by Prose.
+
+#### Type Declaration
+
+| Name       | Type                            |
+| ---------- | ------------------------------- |
+| `variant?` | [`ProseVariant`](#prosevariant) |
+
+## Variables
+
+### Prose
+
+```ts
+const Prose: ForwardRefExoticComponent<
+  object & HTMLAttributes<HTMLElement> & RefAttributes<HTMLElement>
+>;
+```
+
+Tailwind Typography's `prose` rhythm and measure in the active theme's colours
+and faces; the caller supplies the document content.

package/docs/api/components/quota-meter.md

@@ -0,0 +1,47 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/quota-meter
+
+# components/quota-meter
+
+## Type Aliases
+
+### QuotaMeterProps
+
+```ts
+type QuotaMeterProps = object &
+  Omit<HTMLAttributes<HTMLDivElement>, "children">;
+```
+
+Props accepted by QuotaMeter.
+
+#### Type Declaration
+
+| Name           | Type                                       |
+| -------------- | ------------------------------------------ |
+| `label`        | `ReactNode`                                |
+| `value`        | `number`                                   |
+| `max`          | `number`                                   |
+| `valueLabel?`  | `ReactNode`                                |
+| `maxLabel?`    | `ReactNode`                                |
+| `description?` | `ReactNode`                                |
+| `indicator?`   | `ReactNode`                                |
+| `tone?`        | [`ProgressTone`](progress.md#progresstone) |
+
+## Variables
+
+### QuotaMeter
+
+```ts
+const QuotaMeter: ForwardRefExoticComponent<
+  object &
+    Omit<HTMLAttributes<HTMLDivElement>, "children"> &
+    RefAttributes<HTMLDivElement>
+>;
+```
+
+A meter presentation for caller-provided quota values.

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

@@ -0,0 +1,9 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/radio-bead
+
+# components/radio-bead

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

@@ -0,0 +1,126 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/radio-group
+
+# components/radio-group
+
+## Type Aliases
+
+### RadioGroupProps
+
+```ts
+type RadioGroupProps = object &
+  Omit<
+    FieldsetHTMLAttributes<HTMLFieldSetElement>,
+    "defaultValue" | "onChange"
+  >;
+```
+
+Props accepted by RadioGroup.
+
+#### Type Declaration
+
+| Name               | Type                           | Description                                    |
+| ------------------ | ------------------------------ | ---------------------------------------------- |
+| `children`         | `ReactNode`                    | -                                              |
+| `defaultValue?`    | `string`                       | -                                              |
+| `name?`            | `string`                       | -                                              |
+| `onValueChange()?` | (`value`) => `void`            | Called after the selected radio value changes. |
+| `orientation?`     | `"horizontal"` \| `"vertical"` | -                                              |
+| `value?`           | `string`                       | -                                              |
+
+---
+
+### RadioGroupItemProps
+
+```ts
+type RadioGroupItemProps = object &
+  Omit<
+    InputHTMLAttributes<HTMLInputElement>,
+    "checked" | "defaultChecked" | "name" | "type" | "value"
+  >;
+```
+
+Props accepted by RadioGroupItem.
+
+#### Type Declaration
+
+| Name         | Type        | Description                                                          |
+| ------------ | ----------- | -------------------------------------------------------------------- |
+| `value`      | `string`    | -                                                                    |
+| `indicator?` | `ReactNode` | Replaces the bead while the native input continues to own selection. |
+
+---
+
+### RadioGroupCardProps
+
+```ts
+type RadioGroupCardProps = object & RadioGroupItemProps;
+```
+
+Props accepted by RadioGroupCard.
+
+#### Type Declaration
+
+| Name           | Type        | Description                                                           |
+| -------------- | ----------- | --------------------------------------------------------------------- |
+| `title`        | `ReactNode` | -                                                                     |
+| `description?` | `ReactNode` | -                                                                     |
+| `meta?`        | `ReactNode` | A short readout on the card's trailing edge, such as a price or size. |
+
+## Variables
+
+### RadioGroup
+
+```ts
+const RadioGroup: ForwardRefExoticComponent<
+  object &
+    Omit<
+      FieldsetHTMLAttributes<HTMLFieldSetElement>,
+      "defaultValue" | "onChange"
+    > &
+    RefAttributes<HTMLFieldSetElement>
+>;
+```
+
+A radio-group primitive with caller-owned selection state.
+
+---
+
+### RadioGroupItem
+
+```ts
+const RadioGroupItem: ForwardRefExoticComponent<
+  object &
+    Omit<
+      InputHTMLAttributes<HTMLInputElement>,
+      "name" | "defaultChecked" | "type" | "value" | "checked"
+    > &
+    RefAttributes<HTMLInputElement>
+>;
+```
+
+A selectable item in a RadioGroup.
+
+---
+
+### RadioGroupCard
+
+```ts
+const RadioGroupCard: ForwardRefExoticComponent<
+  object &
+    object &
+    Omit<
+      InputHTMLAttributes<HTMLInputElement>,
+      "name" | "defaultChecked" | "type" | "value" | "checked"
+    > &
+    RefAttributes<HTMLInputElement>
+>;
+```
+
+A radio choice presented as a card: bead, title, optional description and a
+trailing readout. The whole card is the hit area; the title names it.

package/docs/api/components/resize-handle.md

@@ -0,0 +1,46 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/resize-handle
+
+# components/resize-handle
+
+## Type Aliases
+
+### ResizeHandleProps
+
+```ts
+type ResizeHandleProps = Omit<HTMLAttributes<HTMLDivElement>, "onChange"> &
+  object;
+```
+
+Accessible grip presentation with caller-owned resize state and pointer gesture.
+
+#### Type Declaration
+
+| Name              | Type                           | Description                                               |
+| ----------------- | ------------------------------ | --------------------------------------------------------- |
+| `aria-label`      | `string`                       | -                                                         |
+| `orientation`     | `"horizontal"` \| `"vertical"` | -                                                         |
+| `variant?`        | `"grip"` \| `"notch"`          | -                                                         |
+| `value`           | `number`                       | -                                                         |
+| `min`             | `number`                       | -                                                         |
+| `max`             | `number`                       | -                                                         |
+| `onValueChange()` | (`value`) => `void`            | Receives a clamped pixel position from keyboard controls. |
+
+## Variables
+
+### ResizeHandle
+
+```ts
+const ResizeHandle: ForwardRefExoticComponent<
+  Omit<HTMLAttributes<HTMLDivElement>, "onChange"> &
+    object &
+    RefAttributes<HTMLDivElement>
+>;
+```
+
+Visual and keyboard surface for a caller-owned resize gesture.

package/docs/api/components/rough-drawing.md

@@ -0,0 +1,122 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/rough-drawing
+
+# components/rough-drawing
+
+## Type Aliases
+
+### RoughMark
+
+```ts
+type RoughMark =
+  "box" | "underline" | "circle" | "highlight" | "bubble" | "line";
+```
+
+A hand-drawn mark around, under or behind an element.
+
+---
+
+### RoughTone
+
+```ts
+type RoughTone = "ink" | "primary";
+```
+
+Theme ink (`currentColor` by default) or the theme's primary accent.
+
+---
+
+### RoughSpec
+
+```ts
+type RoughSpec = Readonly<{
+  mark: RoughMark;
+  seed: number;
+  weight: number;
+  roughness: number;
+  fill: "none" | "solid" | "hachure";
+  tail: "left" | "right" | "none";
+  points: readonly (readonly [number, number][]);
+}>;
+```
+
+Parsed `data-rough-*` settings for one element.
+
+## Functions
+
+### parseRoughPoints()
+
+```ts
+function parseRoughPoints(value): readonly (readonly [number, number][]);
+```
+
+Read `0,100 40,20 100,0` as percent points, dropping malformed pairs.
+
+#### Parameters
+
+| Parameter | Type                    |
+| --------- | ----------------------- |
+| `value`   | `string` \| `undefined` |
+
+#### Returns
+
+readonly readonly \[`number`, `number`\][]
+
+---
+
+### readRoughSpec()
+
+```ts
+function readRoughSpec(element): Readonly<{
+  mark: RoughMark;
+  seed: number;
+  weight: number;
+  roughness: number;
+  fill: "none" | "solid" | "hachure";
+  tail: "none" | "left" | "right";
+  points: readonly (readonly [number, number][]);
+}> | null;
+```
+
+Parse an element's `data-caps-rough` and `data-rough-*` attributes.
+
+#### Parameters
+
+| Parameter | Type          |
+| --------- | ------------- |
+| `element` | `HTMLElement` |
+
+#### Returns
+
+\| `Readonly`\<\{ `mark`: [`RoughMark`](#roughmark); `seed`: `number`; `weight`:
+`number`; `roughness`: `number`; `fill`: `"none"` \| `"solid"` \| `"hachure"`;
+`tail`: `"none"` \| `"left"` \| `"right"`; `points`: readonly readonly
+\[`number`, `number`\][]; \}\> \| `null`
+
+---
+
+### drawRough()
+
+```ts
+function drawRough(root?): () => void;
+```
+
+Draw every `[data-caps-rough]` element inside `root` (and `root` itself),
+loading Rough.js on first use, and redraw each one when its size changes.
+Returns a function that stops watching sizes. If Rough.js cannot load, the CSS
+fallback stays.
+
+#### Parameters
+
+| Parameter | Type         | Default value |
+| --------- | ------------ | ------------- |
+| `root`    | `ParentNode` | `document`    |
+
+#### Returns
+
+() => `void`