@fungi.computer/caps 0.0.0-stage → 0.0.1

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

package/docs/api/components/loader.md

@@ -0,0 +1,51 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/loader
+
+# components/loader
+
+## Type Aliases
+
+### LoaderVariant
+
+```ts
+type LoaderVariant = "line" | "wander" | "square" | "donut" | "bloom";
+```
+
+Fluid motion formations, sharing one material.
+
+---
+
+### LoaderProps
+
+```ts
+type LoaderProps = object & HTMLAttributes<HTMLSpanElement>;
+```
+
+Props accepted by Loader.
+
+#### Type Declaration
+
+| Name          | Type                                                    | Description                                                              |
+| ------------- | ------------------------------------------------------- | ------------------------------------------------------------------------ |
+| `decorative?` | `boolean`                                               | -                                                                        |
+| `label?`      | `ReactNode`                                             | -                                                                        |
+| `size?`       | `"sm"` \| `"md"` \| `"lg"` \| `"fill"`                  | `fill` grows the formation to its container, as a full-tile placeholder. |
+| `variant?`    | [`LoaderVariant`](#loadervariant)                       | -                                                                        |
+| `tone?`       | `"neutral"` \| `"accent"` \| `"primary"` \| `"success"` | -                                                                        |
+
+## Variables
+
+### Loader
+
+```ts
+const Loader: ForwardRefExoticComponent<
+  object & HTMLAttributes<HTMLSpanElement> & RefAttributes<HTMLSpanElement>
+>;
+```
+
+Connecting gooey beads, with a static silhouette for reduced motion.

package/docs/api/components/markdown.md

@@ -0,0 +1,91 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/markdown
+
+# components/markdown
+
+## Type Aliases
+
+### MarkdownProps
+
+```ts
+type MarkdownProps = object;
+```
+
+Props accepted by Markdown.
+
+#### Properties
+
+##### children
+
+```ts
+children: string;
+```
+
+The Markdown source, including an unfinished streaming response.
+
+##### className?
+
+```ts
+optional className?: string;
+```
+
+Extra classes merged onto the rendered container.
+
+##### components?
+
+```ts
+optional components?: MarkdownComponents;
+```
+
+Element treatments; links use the shared policy, images are filtered first.
+
+##### frontmatter?
+
+```ts
+optional frontmatter?: boolean;
+```
+
+Strip a leading YAML frontmatter block before rendering. Defaults to true.
+
+##### policy?
+
+```ts
+optional policy?: "default" | "visitor";
+```
+
+Visitor content allows only absolute HTTP(S) links and never loads images.
+
+##### typography?
+
+```ts
+optional typography?: "prose" | "inherit";
+```
+
+Use Caps Prose, or inherit typography from the containing surface.
+
+## Functions
+
+### Markdown()
+
+```ts
+function Markdown(__namedParameters): ReactNode;
+```
+
+Shared Markdown renderer with safe links, images and highlighted code. Documents
+use Caps Prose; containing surfaces can supply their own typography and element
+treatments. Replacing the source renders streaming partial Markdown.
+
+#### Parameters
+
+| Parameter           | Type                              |
+| ------------------- | --------------------------------- |
+| `__namedParameters` | [`MarkdownProps`](#markdownprops) |
+
+#### Returns
+
+`ReactNode`

package/docs/api/components/minimap-labels.md

@@ -0,0 +1,84 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/minimap-labels
+
+# components/minimap-labels
+
+## Type Aliases
+
+### MinimapLabelSide
+
+```ts
+type MinimapLabelSide =
+  | "below"
+  | "above"
+  | "right"
+  | "left"
+  | "below-right"
+  | "below-left"
+  | "above-right"
+  | "above-left"
+  | "hidden";
+```
+
+Where a mark's name sits, or `hidden`.
+
+---
+
+### MinimapLabelInput
+
+```ts
+type MinimapLabelInput = Readonly<{
+  x: number;
+  y: number;
+  named: boolean;
+  solid: boolean;
+  goal: boolean;
+  label: string;
+}>;
+```
+
+A caller-provided minimap label and its anchor.
+
+---
+
+### MinimapLabelMetrics
+
+```ts
+type MinimapLabelMetrics = Readonly<{
+  width: number;
+  height: number;
+  charWidth: number;
+  lineHeight: number;
+  padding: number;
+  dot: number;
+  gap: number;
+}>;
+```
+
+Measured label dimensions used to place minimap labels.
+
+## Functions
+
+### layoutMinimapLabels()
+
+```ts
+function layoutMinimapLabels(marks, metrics): MinimapLabelSide[];
+```
+
+The side each mark's label takes, index for index with `marks`.
+
+#### Parameters
+
+| Parameter | Type                                                                                                                                       |
+| --------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| `marks`   | readonly `Readonly`\<\{ `x`: `number`; `y`: `number`; `named`: `boolean`; `solid`: `boolean`; `goal`: `boolean`; `label`: `string`; \}\>[] |
+| `metrics` | [`MinimapLabelMetrics`](#minimaplabelmetrics)                                                                                              |
+
+#### Returns
+
+[`MinimapLabelSide`](#minimaplabelside)[]

package/docs/api/components/monogram.md

@@ -0,0 +1,96 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/monogram
+
+# components/monogram
+
+## Type Aliases
+
+### MonogramTone
+
+```ts
+type MonogramTone =
+  "primary" | "secondary" | "accent" | "info" | "success" | "warning";
+```
+
+Theme tones a Monogram may take; the current Stipe theme supplies each color.
+
+---
+
+### MonogramSize
+
+```ts
+type MonogramSize = "default" | "lg" | "xl";
+```
+
+Monogram scales: `default` sits inline with text; larger sizes stand alone as an
+identity mark.
+
+---
+
+### MonogramSubject
+
+```ts
+type MonogramSubject = "actor" | "app";
+```
+
+Who the Monogram marks: people and Agents get a disc, Apps a rounded tile.
+
+---
+
+### MonogramProps
+
+```ts
+type MonogramProps = object & Omit<HTMLAttributes<HTMLSpanElement>, "children">;
+```
+
+Props accepted by Monogram.
+
+#### Type Declaration
+
+| Name       | Type                                  | Description                                                |
+| ---------- | ------------------------------------- | ---------------------------------------------------------- |
+| `name`     | `string`                              | The name whose first letter is shown.                      |
+| `seed?`    | `string`                              | Stable identity that picks the tone; defaults to the name. |
+| `size?`    | [`MonogramSize`](#monogramsize)       | -                                                          |
+| `subject?` | [`MonogramSubject`](#monogramsubject) | -                                                          |
+| `variant?` | `"initial"` \| `"specimen"`           | -                                                          |
+
+## Variables
+
+### Monogram
+
+```ts
+const Monogram: ForwardRefExoticComponent<
+  object &
+    Omit<HTMLAttributes<HTMLSpanElement>, "children"> &
+    RefAttributes<HTMLSpanElement>
+>;
+```
+
+A small decorative identity mark: the name's first letter on a quiet tinted
+disc. The enclosing control owns the accessible name.
+
+## Functions
+
+### monogramTone()
+
+```ts
+function monogramTone(seed): MonogramTone;
+```
+
+A stable tone for an identity: the same seed always gets the same tone.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `seed`    | `string` |
+
+#### Returns
+
+[`MonogramTone`](#monogramtone)

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

package/docs/api/components/navigation-rail.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/navigation-rail
+
+# components/navigation-rail
+
+## Type Aliases
+
+### NavigationRailProps
+
+```ts
+type NavigationRailProps = HTMLAttributes<HTMLElement> & object;
+```
+
+Props accepted by NavigationRail.
+
+#### Type Declaration
+
+| Name         | Type      | Description                                                               |
+| ------------ | --------- | ------------------------------------------------------------------------- |
+| `fitAtWide?` | `boolean` | Let a long rail fit across wide layouts while retaining mobile scrolling. |
+
+## Variables
+
+### NavigationRail
+
+```ts
+const NavigationRail: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLElement> & object & RefAttributes<HTMLElement>
+>;
+```
+
+A horizontal navigation list that signals when links continue off-screen.

package/docs/api/components/overlay-root.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/overlay-root
+
+# components/overlay-root
+
+## Type Aliases
+
+### OverlayLayer
+
+```ts
+type OverlayLayer = "popover" | "dialog" | "toast" | "tooltip";
+```
+
+Semantic destinations; the host owns their paint order and positioning.
+
+---
+
+### OverlayContainers
+
+```ts
+type OverlayContainers = Readonly<Record<OverlayLayer, HTMLElement | null>>;
+```
+
+Host portal roots; null keeps an overlay waiting until its layer mounts.
+
+## Functions
+
+### OverlayRoot()
+
+```ts
+function OverlayRoot(__namedParameters): Element;
+```
+
+Supply shell portal roots without teaching Caps about the shell's layout.
+
+#### Parameters
+
+| Parameter                             | Type                                                                                                                                        | Description                                                              |
+| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
+| `__namedParameters`                   | \{ `containers`: [`OverlayContainers`](#overlaycontainers); `children?`: `ReactNode`; `subscribeDismiss?`: (`listener`) => () => `void`; \} | -                                                                        |
+| `__namedParameters.containers`        | [`OverlayContainers`](#overlaycontainers)                                                                                                   | -                                                                        |
+| `__namedParameters.children?`         | `ReactNode`                                                                                                                                 | -                                                                        |
+| `__namedParameters.subscribeDismiss?` | (`listener`) => () => `void`                                                                                                                | Subscribe to the host losing focus to a child surface or another window. |
+
+#### Returns
+
+`Element`
+
+---
+
+### useOverlayRoot()
+
+```ts
+function useOverlayRoot(layer): HTMLElement | null;
+```
+
+Wait for a provided root; standalone overlays use the current document body.
+
+#### Parameters
+
+| Parameter | Type                            |
+| --------- | ------------------------------- |
+| `layer`   | [`OverlayLayer`](#overlaylayer) |
+
+#### Returns
+
+`HTMLElement` \| `null`
+
+---
+
+### useOverlayDismiss()
+
+```ts
+function useOverlayDismiss(dismiss): void;
+```
+
+Retire a transient overlay when its owning host requests light dismissal.
+
+#### Parameters
+
+| Parameter | Type         |
+| --------- | ------------ |
+| `dismiss` | () => `void` |
+
+#### Returns
+
+`void`

package/docs/api/components/pixel-number.md

@@ -0,0 +1,120 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/pixel-number
+
+# components/pixel-number
+
+## Type Aliases
+
+### PixelNumberSize
+
+```ts
+type PixelNumberSize = "sm" | "md" | "lg" | "xl";
+```
+
+Supported PixelNumber sizes: one font pixel is 2, 3, 4 or 6 CSS pixels.
+
+---
+
+### PixelNumberTone
+
+```ts
+type PixelNumberTone =
+  "current" | "primary" | "accent" | "success" | "warning" | "error";
+```
+
+Semantic tones supplied by the current theme.
+
+---
+
+### PixelNumberProps
+
+```ts
+type PixelNumberProps = Omit<HTMLAttributes<HTMLSpanElement>, "children"> &
+  object;
+```
+
+Props accepted by PixelNumber. Pass a `value`, or readout `text`.
+
+#### Type Declaration
+
+| Name       | Type                                  | Description                                                                                                                            |
+| ---------- | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
+| `value?`   | `number`                              | A number to draw.                                                                                                                      |
+| `text?`    | `string`                              | Readout text instead of a number: digits and `: . + - / × %` and spaces.                                                               |
+| `pad?`     | `number`                              | Left-pad the whole part of `value` with zeros to this many digits.                                                                     |
+| `signed?`  | `boolean`                             | Prefix a positive `value` with `+`, for gains and floating numbers.                                                                    |
+| `size?`    | [`PixelNumberSize`](#pixelnumbersize) | -                                                                                                                                      |
+| `tone?`    | [`PixelNumberTone`](#pixelnumbertone) | -                                                                                                                                      |
+| `outline?` | `boolean`                             | Ring every lit pixel with the ink line, like a sprite outline, so the number reads over any world: damage, pickups and floating gains. |
+
+## Variables
+
+### PIXEL\_NUMBER\_CHARACTERS
+
+```ts
+const PIXEL_NUMBER_CHARACTERS: readonly string[];
+```
+
+Characters the pixel face can draw.
+
+---
+
+### PixelNumber
+
+```ts
+const PixelNumber: ForwardRefExoticComponent<
+  Omit<HTMLAttributes<HTMLSpanElement>, "children"> &
+    object &
+    RefAttributes<HTMLSpanElement>
+>;
+```
+
+Crisp pixel numerals drawn as SVG, so they stay sharp at every size and never
+depend on a font file. The readable text is kept for assistive tech.
+
+## Functions
+
+### formatPixelNumber()
+
+```ts
+function formatPixelNumber(value, pad?, signed?): string;
+```
+
+Format a number the way PixelNumber draws it.
+
+#### Parameters
+
+| Parameter | Type      | Default value |
+| --------- | --------- | ------------- |
+| `value`   | `number`  | `undefined`   |
+| `pad`     | `number`  | `0`           |
+| `signed`  | `boolean` | `false`       |
+
+#### Returns
+
+`string`
+
+---
+
+### checkPixelText()
+
+```ts
+function checkPixelText(text): string;
+```
+
+Reject characters the pixel face cannot draw, naming the ones it can.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `text`    | `string` |
+
+#### Returns
+
+`string`

package/docs/api/components/popover.md

@@ -0,0 +1,80 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/popover
+
+# components/popover
+
+## Type Aliases
+
+### PopoverProps
+
+```ts
+type PopoverProps = HTMLAttributes<HTMLDivElement> & object;
+```
+
+Props accepted by Popover.
+
+#### Type Declaration
+
+| Name    | Type                  | Description                             |
+| ------- | --------------------- | --------------------------------------- |
+| `open`  | `boolean`             | Whether the popover is shown.           |
+| `side?` | `"top"` \| `"bottom"` | Which edge of the anchor it opens from. |
+
+---
+
+### PopoverOptionProps
+
+```ts
+type PopoverOptionProps = HTMLAttributes<HTMLDivElement> & object;
+```
+
+Props accepted by PopoverOption.
+
+#### Type Declaration
+
+| Name     | Type      | Description                                                   |
+| -------- | --------- | ------------------------------------------------------------- |
+| `active` | `boolean` | Whether keyboard navigation currently highlights this option. |
+
+## Variables
+
+### PopoverAnchor
+
+```ts
+const PopoverAnchor: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement>
+>;
+```
+
+The positioned box a Popover attaches to.
+
+---
+
+### Popover
+
+```ts
+const Popover: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & object & RefAttributes<HTMLDivElement>
+>;
+```
+
+A non-modal raised panel attached to its PopoverAnchor. It never takes focus, so
+the anchored control (for example a composer) keeps typing while the popover
+lists suggestions.
+
+---
+
+### PopoverOption
+
+```ts
+const PopoverOption: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & object & RefAttributes<HTMLDivElement>
+>;
+```
+
+One option row inside a Popover list; pointer presses keep focus where it is.