@fungi.computer/caps 0.0.0-stage → 0.0.1

package/docs/api/components/status.md

@@ -0,0 +1,105 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/status
+
+# components/status
+
+## Type Aliases
+
+### StatusGlyph
+
+```ts
+type StatusGlyph = "dot" | "pill" | "bang" | StatusMarkGlyph;
+```
+
+The target silhouette. Bead glyphs (`dot`, `pill`, `bang`) morph between each
+other; task glyphs (`ring` waiting, `arc` working, `check` finished, `cross`
+refused) morph between each other.
+
+---
+
+### StatusMotion
+
+```ts
+type StatusMotion = "none" | "pulse" | "bounce";
+```
+
+Continuous activity, independent of the target silhouette.
+
+---
+
+### StatusTone
+
+```ts
+type StatusTone =
+  | "neutral"
+  | "primary"
+  | "secondary"
+  | "accent"
+  | "success"
+  | "info"
+  | "warning"
+  | "error";
+```
+
+Semantic colors supplied by the current Stipe theme.
+
+---
+
+### StatusSize
+
+```ts
+type StatusSize = "default" | "compact";
+```
+
+Status size keeps secondary state compact in dense rows.
+
+---
+
+### StatusAppearance
+
+```ts
+type StatusAppearance = "plain" | "chip";
+```
+
+`chip` seats the bead and label in a tone-tinted pill.
+
+---
+
+### StatusProps
+
+```ts
+type StatusProps = object & Omit<HTMLAttributes<HTMLSpanElement>, "children">;
+```
+
+Presentation only: the caller maps its state to glyph, tone, and motion.
+
+#### Type Declaration
+
+| Name          | Type                                    | Description                                                 |
+| ------------- | --------------------------------------- | ----------------------------------------------------------- |
+| `label?`      | `ReactNode`                             | -                                                           |
+| `glyph?`      | [`StatusGlyph`](#statusglyph)           | -                                                           |
+| `motion?`     | [`StatusMotion`](#statusmotion)         | -                                                           |
+| `tone?`       | [`StatusTone`](#statustone)             | -                                                           |
+| `size?`       | [`StatusSize`](#statussize)             | -                                                           |
+| `appearance?` | [`StatusAppearance`](#statusappearance) | -                                                           |
+| `progress?`   | `number`                                | For `arc`: how much is done, 0 to 1. Absent, the arc spins. |
+
+## Variables
+
+### Status
+
+```ts
+const Status: ForwardRefExoticComponent<
+  object &
+    Omit<HTMLAttributes<HTMLSpanElement>, "children"> &
+    RefAttributes<HTMLSpanElement>
+>;
+```
+
+A gooey SVG status bead with automatic, interruptible glyph transitions.

package/docs/api/components/store-card.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/store-card
+
+# components/store-card
+
+## Type Aliases
+
+### StoreCardProps
+
+```ts
+type StoreCardProps = Omit<HTMLAttributes<HTMLDivElement>, "title"> &
+  Readonly<{
+    title: string;
+    tagline: string;
+    variant?: "listing" | "cartridge" | "server";
+    layout?: "stack" | "split";
+    cover?: ReactNode;
+    icon?: ReactNode;
+    seller?: ReactNode;
+    price?: PriceTagProps["price"];
+    badges?: readonly string[];
+    action?: ReactNode;
+    href?: string;
+    onSelect?: () => void;
+  }>;
+```
+
+A shelf entry with independent opening and acquisition controls.
+
+## Functions
+
+### StoreCard()
+
+```ts
+function StoreCard(__namedParameters): Element;
+```
+
+Caps owns the cover, copy, metadata and independent interaction states.
+
+#### Parameters
+
+| Parameter           | Type                                |
+| ------------------- | ----------------------------------- |
+| `__namedParameters` | [`StoreCardProps`](#storecardprops) |
+
+#### Returns
+
+`Element`

package/docs/api/components/surface.md

@@ -0,0 +1,161 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/surface
+
+# components/surface
+
+## Type Aliases
+
+### SurfaceProps
+
+```ts
+type SurfaceProps = HTMLAttributes<HTMLDivElement> & object;
+```
+
+Native surface attributes with independent rim, depth and placement choices.
+
+#### Type Declaration
+
+| Name         | Type                           | Description                                                                 |
+| ------------ | ------------------------------ | --------------------------------------------------------------------------- |
+| `size?`      | `"sm"` \| `"md"` \| `"lg"`     | Rim scale, independent of the content's dimensions.                         |
+| `depth?`     | `"shallow"` \| `"deep"`        | -                                                                           |
+| `placement?` | `"standalone"` \| `"embedded"` | Embedded surfaces borrow their parent's casing; omit the exterior surround. |
+
+---
+
+### DisplayProps
+
+```ts
+type DisplayProps = SurfaceProps & object;
+```
+
+A recessed display with a separate gasket and screen face.
+
+#### Type Declaration
+
+| Name       | Type                      | Description                                           |
+| ---------- | ------------------------- | ----------------------------------------------------- |
+| `fit?`     | `"content"` \| `"fill"`   | Fill a flex region rather than sizing to its content. |
+| `density?` | `"normal"` \| `"compact"` | Reduce the gasket footprint for compact displays.     |
+
+---
+
+### ScreenHeaderProps
+
+```ts
+type ScreenHeaderProps = object &
+  Omit<HTMLAttributes<HTMLElement>, "title" | "children">;
+```
+
+Props accepted by ScreenHeader.
+
+#### Type Declaration
+
+| Name      | Type        | Description                                      |
+| --------- | ----------- | ------------------------------------------------ |
+| `icon?`   | `ReactNode` | A decorative Sigil or App icon before the title. |
+| `title`   | `ReactNode` | -                                                |
+| `status?` | `ReactNode` | A Status or short readout opposite the title.    |
+
+---
+
+### ScreenCellProps
+
+```ts
+type ScreenCellProps = object & HTMLAttributes<HTMLDivElement>;
+```
+
+Props accepted by ScreenCell.
+
+#### Type Declaration
+
+| Name          | Type                       | Description                                                         |
+| ------------- | -------------------------- | ------------------------------------------------------------------- |
+| `appearance?` | `"default"` \| `"compact"` | Compact rows put their subject icon and legend before the controls. |
+| `icon?`       | `ReactNode`                | A leading subject icon.                                             |
+| `legend?`     | `ReactNode`                | The cell's tiny mono legend, such as "Processes".                   |
+| `readout?`    | `ReactNode`                | A short value readout in the cell's corner, such as "2/4 ON".       |
+| `wide?`       | `boolean`                  | Span the full row instead of one column.                            |
+
+## Variables
+
+### Surface
+
+```ts
+const Surface: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & object & RefAttributes<HTMLDivElement>
+>;
+```
+
+A themeable frame around a surface. No padding or interaction ownership.
+
+---
+
+### Screen
+
+```ts
+const Screen: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement>
+>;
+```
+
+Display face using theme surfaces while preserving the inherited text font.
+
+---
+
+### Display
+
+```ts
+const Display: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> &
+    object &
+    object &
+    RefAttributes<HTMLDivElement>
+>;
+```
+
+Theme-owned recessed screen with a gasket and optional compact fill geometry.
+
+---
+
+### ScreenHeader
+
+```ts
+const ScreenHeader: ForwardRefExoticComponent<
+  object &
+    Omit<HTMLAttributes<HTMLElement>, "title" | "children"> &
+    RefAttributes<HTMLElement>
+>;
+```
+
+A screen's title bar, printed on the glass above a hairline.
+
+---
+
+### ScreenCells
+
+```ts
+const ScreenCells: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & object & RefAttributes<HTMLDivElement>
+>;
+```
+
+An instrument's cells: a grid of hairline-ruled cells that reflows to one column
+when narrow. Put ScreenCells straight inside a Screen or Display.
+
+---
+
+### ScreenCell
+
+```ts
+const ScreenCell: ForwardRefExoticComponent<
+  object & HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement>
+>;
+```
+
+One instrument cell: a legend, an optional corner readout and its content.

package/docs/api/components/switch-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/switch-bead
+
+# components/switch-bead

package/docs/api/components/switch.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/switch
+
+# components/switch
+
+## Type Aliases
+
+### SwitchProps
+
+```ts
+type SwitchProps = object &
+  Omit<InputHTMLAttributes<HTMLInputElement>, "defaultValue" | "type">;
+```
+
+Props accepted by Switch.
+
+#### Type Declaration
+
+| Name                 | Type                  | Description                             |
+| -------------------- | --------------------- | --------------------------------------- |
+| `onCheckedChange()?` | (`checked`) => `void` | Called after the checked state changes. |
+
+## Variables
+
+### Switch
+
+```ts
+const Switch: ForwardRefExoticComponent<
+  object &
+    Omit<InputHTMLAttributes<HTMLInputElement>, "defaultValue" | "type"> &
+    RefAttributes<HTMLInputElement>
+>;
+```
+
+A switch primitive with caller-owned checked state.

package/docs/api/components/tabs.md

@@ -0,0 +1,138 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/tabs
+
+# components/tabs
+
+## Type Aliases
+
+### TabsProps
+
+```ts
+type TabsProps = object & HTMLAttributes<HTMLDivElement>;
+```
+
+Props accepted by Tabs.
+
+#### Type Declaration
+
+| Name               | Type                | Description                                |
+| ------------------ | ------------------- | ------------------------------------------ |
+| `children`         | `ReactNode`         | -                                          |
+| `defaultValue?`    | `string`            | -                                          |
+| `onValueChange()?` | (`value`) => `void` | Called after the active tab value changes. |
+| `value?`           | `string`            | -                                          |
+
+---
+
+### TabsListVariant
+
+```ts
+type TabsListVariant = "bordered" | "segmented";
+```
+
+Supported tab-list presentations.
+
+---
+
+### TabsListProps
+
+```ts
+type TabsListProps = object & HTMLAttributes<HTMLDivElement>;
+```
+
+Props accepted by TabsList.
+
+#### Type Declaration
+
+| Name       | Type                                  | Description                                                                                                                         |
+| ---------- | ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
+| `variant?` | [`TabsListVariant`](#tabslistvariant) | `bordered` underlines the selected tab. `segmented` presents a small set of equal, mutually exclusive choices as one inset control. |
+
+---
+
+### TabsTriggerProps
+
+```ts
+type TabsTriggerProps = object & ButtonHTMLAttributes<HTMLButtonElement>;
+```
+
+Props accepted by TabsTrigger.
+
+#### Type Declaration
+
+| Name    | Type     |
+| ------- | -------- |
+| `value` | `string` |
+
+---
+
+### TabsContentProps
+
+```ts
+type TabsContentProps = object & HTMLAttributes<HTMLDivElement>;
+```
+
+Props accepted by TabsContent.
+
+#### Type Declaration
+
+| Name          | Type        |
+| ------------- | ----------- |
+| `children`    | `ReactNode` |
+| `forceMount?` | `boolean`   |
+| `value`       | `string`    |
+
+## Variables
+
+### Tabs
+
+```ts
+const Tabs: ForwardRefExoticComponent<
+  object & HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement>
+>;
+```
+
+A tab-list controller with explicit controlled or uncontrolled value state.
+
+---
+
+### TabsList
+
+```ts
+const TabsList: ForwardRefExoticComponent<
+  object & HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement>
+>;
+```
+
+The tab-list layout for a Tabs controller.
+
+---
+
+### TabsTrigger
+
+```ts
+const TabsTrigger: ForwardRefExoticComponent<
+  object &
+    ButtonHTMLAttributes<HTMLButtonElement> &
+    RefAttributes<HTMLButtonElement>
+>;
+```
+
+A selectable tab in a Tabs controller.
+
+---
+
+### TabsContent
+
+```ts
+const TabsContent: ForwardRefExoticComponent<
+  object & HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement>
+>;
+```
+
+The content panel associated with a Tabs value.