@fungi.computer/caps 0.0.0-stage → 0.0.1

package/docs/api/components/rough.md

@@ -0,0 +1,66 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/rough
+
+# components/rough
+
+## Type Aliases
+
+### RoughProps
+
+```ts
+type RoughProps = object & HTMLAttributes<HTMLElement>;
+```
+
+Props accepted by Rough.
+
+#### Type Declaration
+
+| Name         | Type                                      | Description                                                                         |
+| ------------ | ----------------------------------------- | ----------------------------------------------------------------------------------- |
+| `mark`       | [`RoughMark`](rough-drawing.md#roughmark) | The mark: a box, underline, circle, highlight, speech bubble or line.               |
+| `tone?`      | [`RoughTone`](rough-drawing.md#roughtone) | Theme ink (the default) or the primary accent.                                      |
+| `seed?`      | `number`                                  | Fixes the wobble, so the mark looks the same on every render.                       |
+| `weight?`    | `number`                                  | Stroke width in CSS pixels.                                                         |
+| `roughness?` | `number`                                  | 0 is a ruler, 3 is a scribble.                                                      |
+| `fill?`      | `"none"` \| `"solid"` \| `"hachure"`      | Fill inside a box, circle or bubble.                                                |
+| `tail?`      | `"left"` \| `"right"` \| `"none"`         | For `bubble`: the lower corner its tail leaves from.                                |
+| `points?`    | `string`                                  | For `line`: percent points in the box, e.g. `0,100 100,0`.                          |
+| `animate?`   | `boolean`                                 | Draw the mark in once, stroke by stroke, after `delay`. Skipped for reduced motion. |
+| `delay?`     | `number`                                  | Seconds to wait before an `animate` mark draws in (default 0.2).                    |
+| `block?`     | `boolean`                                 | Render as a block (`div`) instead of inline (`span`).                               |
+
+## Variables
+
+### Rough
+
+```ts
+const Rough: ForwardRefExoticComponent<
+  object & HTMLAttributes<HTMLElement> & RefAttributes<HTMLElement>
+>;
+```
+
+A hand-drawn Rough.js mark (box, underline, circle, highlight, speech bubble or
+leader line) around its children, in theme ink or primary. Rough.js loads lazily
+after hydration; until then, and without JavaScript, a plain CSS border,
+underline or tint stands in. The mark is `aria-hidden` and never takes pointer
+events, so the children keep their focus rings and clicks.
+
+Static pages can write the same attributes (see
+[drawRough](rough-drawing.md#drawrough)) instead of hydrating this component.
+
+## References
+
+### RoughMark
+
+Re-exports [RoughMark](rough-drawing.md#roughmark)
+
+---
+
+### RoughTone
+
+Re-exports [RoughTone](rough-drawing.md#roughtone)

package/docs/api/components/scroll-area.md

@@ -0,0 +1,22 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/scroll-area
+
+# components/scroll-area
+
+## Variables
+
+### ScrollArea
+
+```ts
+const ScrollArea: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & object & RefAttributes<HTMLDivElement>
+>;
+```
+
+Native scrolling with a plastic thumb responding to changes in scroll speed. The
+ref and native props address the viewport; className sizes the frame.

package/docs/api/components/scroll-motion.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/scroll-motion
+
+# components/scroll-motion

package/docs/api/components/scroll-to-bottom-blob-state.md

@@ -0,0 +1,162 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/scroll-to-bottom-blob-state
+
+# components/scroll-to-bottom-blob-state
+
+## Type Aliases
+
+### ScrollDirection
+
+```ts
+type ScrollDirection = "forward" | "reverse";
+```
+
+Scroll layout used to measure the distance from the latest content.
+
+---
+
+### ScrollGeometry
+
+```ts
+type ScrollGeometry = Readonly<{
+  clientHeight: number;
+  scrollHeight: number;
+  scrollTop: number;
+}>;
+```
+
+The native geometry needed by the drop, in CSS pixels.
+
+---
+
+### DropTokens
+
+```ts
+type DropTokens = Pick<
+  Motion,
+  "springDuration" | "bounce" | "stretch" | "fast" | "reduced"
+>;
+```
+
+Theme-resolved physics and accessibility settings.
+
+---
+
+### DropState
+
+```ts
+type DropState = Readonly<{
+  phase: "hidden" | "welling" | "resting" | "tugged" | "merging";
+  shown: boolean;
+  jumped: boolean;
+  velocity: number;
+  y: number;
+  vy: number;
+  volume: number;
+  vv: number;
+  opacity: number;
+  unread: number;
+  bead: number;
+}>;
+```
+
+Continuous drop state; no DOM or timers are needed to advance it.
+
+---
+
+### DropInput
+
+```ts
+type DropInput = Readonly<{
+  distance: number;
+  delta: number;
+  unread: number;
+  jump?: boolean;
+}>;
+```
+
+One frame's scroll displacement, end distance, unread count and jump intent.
+
+## Functions
+
+### distanceToBottom()
+
+```ts
+function distanceToBottom(geometry, direction): number;
+```
+
+Distance from the visual end; column-reverse ends at scrollTop zero.
+
+#### Parameters
+
+| Parameter   | Type                                  |
+| ----------- | ------------------------------------- |
+| `geometry`  | [`ScrollGeometry`](#scrollgeometry)   |
+| `direction` | [`ScrollDirection`](#scrolldirection) |
+
+#### Returns
+
+`number`
+
+---
+
+### createDropState()
+
+```ts
+function createDropState(): DropState;
+```
+
+A drop starts hidden until its scroller is more than 48px from the end.
+
+#### Returns
+
+[`DropState`](#dropstate)
+
+---
+
+### unreadVolume()
+
+```ts
+function unreadVolume(unread): number;
+```
+
+Subtle unread volume, capped at fifteen percent.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `unread`  | `number` |
+
+#### Returns
+
+`number`
+
+---
+
+### stepDrop()
+
+```ts
+function stepDrop(previous, input, elapsed, tokens): DropState;
+```
+
+Advance with bounded substeps so long browser frames cannot destabilize the
+springs.
+
+#### Parameters
+
+| Parameter  | Type                        |
+| ---------- | --------------------------- |
+| `previous` | [`DropState`](#dropstate)   |
+| `input`    | [`DropInput`](#dropinput)   |
+| `elapsed`  | `number`                    |
+| `tokens`   | [`DropTokens`](#droptokens) |
+
+#### Returns
+
+[`DropState`](#dropstate)

package/docs/api/components/scroll-to-bottom-blob.md

@@ -0,0 +1,73 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/scroll-to-bottom-blob
+
+# components/scroll-to-bottom-blob
+
+## Type Aliases
+
+### ScrollToBottomBlobProps
+
+```ts
+type ScrollToBottomBlobProps = object;
+```
+
+Props accepted by the persistent jump-to-bottom water drop.
+
+#### Properties
+
+##### direction?
+
+```ts
+optional direction?: ScrollDirection;
+```
+
+Forward is ordinary DOM order; reverse supports column-reverse scrollers.
+
+##### scrollerRef
+
+```ts
+scrollerRef: RefObject<HTMLDivElement | null>;
+```
+
+##### onJump
+
+```ts
+onJump: () => void;
+```
+
+Ask the host to scroll to its latest content.
+
+###### Returns
+
+`void`
+
+##### unread?
+
+```ts
+optional unread?: number;
+```
+
+Appended messages since the reader left the end.
+
+##### focusAfterJump?
+
+```ts
+optional focusAfterJump?: RefObject<HTMLElement | null>;
+```
+
+Focus destination after keyboard activation; defaults to the scroller.
+
+## Variables
+
+### ScrollToBottomBlob
+
+```ts
+const ScrollToBottomBlob: NamedExoticComponent<ScrollToBottomBlobProps>;
+```
+
+A continuously tugged water drop, with its own visibility and focus lifecycle.

package/docs/api/components/select.md

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

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

@@ -0,0 +1,58 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/send-action
+
+# components/send-action
+
+## Type Aliases
+
+### SendActionState
+
+```ts
+type SendActionState = "empty" | "ready" | "busy";
+```
+
+Where a composer's send action is: nothing to send, ready, or working.
+
+---
+
+### SendActionProps
+
+```ts
+type SendActionProps = object &
+  Omit<ButtonProps, "children" | "size" | "loading" | "aria-label">;
+```
+
+Props accepted by SendAction.
+
+#### Type Declaration
+
+| Name         | Type                                  | Description                                                          |
+| ------------ | ------------------------------------- | -------------------------------------------------------------------- |
+| `state`      | [`SendActionState`](#sendactionstate) | -                                                                    |
+| `aria-label` | `string`                              | The accessible name while it sends, such as "Generate image".        |
+| `onStop()?`  | () => `void`                          | Offered while busy: the arrow becomes a stop square that calls this. |
+| `stopLabel?` | `string`                              | The accessible name of the stop action.                              |
+| `iconSize?`  | `number`                              | Glyph size in pixels.                                                |
+
+## Variables
+
+### SendAction
+
+```ts
+const SendAction: ForwardRefExoticComponent<
+  object &
+    Omit<ButtonProps, "aria-label" | "children" | "size" | "loading"> &
+    RefAttributes<HTMLButtonElement>
+>;
+```
+
+A composer's send key. Empty, it rests disabled; given something to send it
+wakes with a small pop; sending, its arrow launches away and a working indicator
+(or, with `onStop`, a stop square) takes its place; when the work ends the arrow
+drops back in. All timing comes from the theme's motion tokens, and reduced
+motion keeps short fades only.

package/docs/api/components/separator.md

@@ -0,0 +1,38 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/separator
+
+# components/separator
+
+## Type Aliases
+
+### SeparatorProps
+
+```ts
+type SeparatorProps = object & HTMLAttributes<HTMLDivElement>;
+```
+
+Props accepted by Separator.
+
+#### Type Declaration
+
+| Name           | Type                           |
+| -------------- | ------------------------------ |
+| `decorative?`  | `boolean`                      |
+| `orientation?` | `"horizontal"` \| `"vertical"` |
+
+## Variables
+
+### Separator
+
+```ts
+const Separator: ForwardRefExoticComponent<
+  object & HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement>
+>;
+```
+
+A visual separator between regions.

package/docs/api/components/skeleton.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/skeleton
+
+# components/skeleton
+
+## Type Aliases
+
+### SkeletonProps
+
+```ts
+type SkeletonProps = HTMLAttributes<HTMLSpanElement>;
+```
+
+Props accepted by Skeleton.
+
+## Variables
+
+### Skeleton
+
+```ts
+const Skeleton: ForwardRefExoticComponent<
+  SkeletonProps & RefAttributes<HTMLSpanElement>
+>;
+```
+
+A loading placeholder that preserves caller-provided native span props.

package/docs/api/components/slider.md

@@ -0,0 +1,70 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/slider
+
+# components/slider
+
+## Type Aliases
+
+### SliderTone
+
+```ts
+type SliderTone =
+  | "neutral"
+  | "primary"
+  | "secondary"
+  | "accent"
+  | "success"
+  | "info"
+  | "warning"
+  | "error";
+```
+
+Supported SliderTone values.
+
+---
+
+### SliderSize
+
+```ts
+type SliderSize = "xs" | "sm" | "default" | "lg";
+```
+
+Supported SliderSize values.
+
+---
+
+### SliderProps
+
+```ts
+type SliderProps = object &
+  Omit<InputHTMLAttributes<HTMLInputElement>, "size" | "type">;
+```
+
+Props accepted by Slider.
+
+#### Type Declaration
+
+| Name    | Type                        |
+| ------- | --------------------------- |
+| `size?` | [`SliderSize`](#slidersize) |
+| `tone?` | [`SliderTone`](#slidertone) |
+
+## Variables
+
+### Slider
+
+```ts
+const Slider: ForwardRefExoticComponent<
+  object &
+    Omit<InputHTMLAttributes<HTMLInputElement>, "size" | "type"> &
+    RefAttributes<HTMLInputElement>
+>;
+```
+
+A native range input with product-neutral tone and size variants. On a Screen it
+reads the screen context and draws as a segmented level.

package/docs/api/components/stat.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/stat
+
+# components/stat
+
+## Type Aliases
+
+### StatProps
+
+```ts
+type StatProps = object & Omit<HTMLAttributes<HTMLDListElement>, "children">;
+```
+
+Props accepted by Stat.
+
+#### Type Declaration
+
+| Name           | Type                       | Description                                                          |
+| -------------- | -------------------------- | -------------------------------------------------------------------- |
+| `label`        | `ReactNode`                | -                                                                    |
+| `value`        | `ReactNode`                | -                                                                    |
+| `description?` | `ReactNode`                | -                                                                    |
+| `density?`     | `"regular"` \| `"compact"` | Reduce internal padding when a statistic sits inside a compact card. |
+
+## Variables
+
+### Stat
+
+```ts
+const Stat: ForwardRefExoticComponent<
+  object &
+    Omit<HTMLAttributes<HTMLDListElement>, "children"> &
+    RefAttributes<HTMLDListElement>
+>;
+```
+
+A compact statistic presentation for caller-provided values.

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

@@ -0,0 +1,19 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/status-bead
+
+# components/status-bead
+
+## Type Aliases
+
+### BeadGlyph
+
+```ts
+type BeadGlyph = "dot" | "pill" | "bang";
+```
+
+The bead's own silhouettes.

package/docs/api/components/status-mark.md

@@ -0,0 +1,19 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/status-mark
+
+# components/status-mark
+
+## Type Aliases
+
+### StatusMarkGlyph
+
+```ts
+type StatusMarkGlyph = "ring" | "arc" | "check" | "cross";
+```
+
+The task glyphs: waiting, working, finished, refused.