@fungi.computer/caps 0.0.0-stage → 0.0.1

package/docs/api/components/window.md

@@ -0,0 +1,291 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/window
+
+# components/window
+
+## Type Aliases
+
+### WindowFrameProps
+
+```ts
+type WindowFrameProps = HTMLAttributes<HTMLElement> & object;
+```
+
+Window presentation only. The host owns geometry, focus order and lifecycle.
+
+#### Type Declaration
+
+| Name          | Type      | Description                                                           |
+| ------------- | --------- | --------------------------------------------------------------------- |
+| `active?`     | `boolean` | -                                                                     |
+| `floating?`   | `boolean` | -                                                                     |
+| `fitContent?` | `boolean` | Shrink a floating panel to its contents, up to the host's max-height. |
+
+---
+
+### WindowBackAction
+
+```ts
+type WindowBackAction = object;
+```
+
+A host-owned request to go back inside the window's content.
+
+#### Properties
+
+##### label
+
+```ts
+label: string;
+```
+
+Accessible name, e.g. "Back in Games".
+
+##### onBack
+
+```ts
+onBack: () => void;
+```
+
+Request going back; the host owns the history and the outcome.
+
+###### Returns
+
+`void`
+
+##### hint?
+
+```ts
+optional hint?: string;
+```
+
+Tooltip text, e.g. the keyboard route to the same action.
+
+---
+
+### WindowHeaderProps
+
+```ts
+type WindowHeaderProps = Omit<
+  HTMLAttributes<HTMLElement>,
+  "title" | "children"
+> &
+  object;
+```
+
+Supply handleProps only when the title is an interactive layout handle.
+
+#### Type Declaration
+
+| Name           | Type                                                                              | Description                                                          |
+| -------------- | --------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
+| `title`        | `string`                                                                          | -                                                                    |
+| `subtitle?`    | `string`                                                                          | Where the content is now, shown after the title and truncated first. |
+| `icon?`        | `ReactNode`                                                                       | -                                                                    |
+| `actions?`     | `ReactNode`                                                                       | -                                                                    |
+| `back?`        | [`WindowBackAction`](#windowbackaction)                                           | Present only while there is somewhere to go back to.                 |
+| `density?`     | `"regular"` \| `"compact"`                                                        | `compact` is a slim bar for tiled layouts; touch targets keep 44px.  |
+| `handleProps?` | `Omit`\<`ButtonHTMLAttributes`\<`HTMLButtonElement`\>, `"children"` \| `"type"`\> | -                                                                    |
+
+---
+
+### WindowActionsProps
+
+```ts
+type WindowActionsProps = object;
+```
+
+Available callbacks determine available controls; no inert placeholder actions.
+
+#### Properties
+
+##### title
+
+```ts
+title: string;
+```
+
+##### floating?
+
+```ts
+optional floating?: boolean;
+```
+
+##### maximized?
+
+```ts
+optional maximized?: boolean;
+```
+
+##### onPromote?
+
+```ts
+optional onPromote?: () => void;
+```
+
+Request making this window the main tiled window.
+
+###### Returns
+
+`void`
+
+##### onToggleFloating?
+
+```ts
+optional onToggleFloating?: () => void;
+```
+
+Request switching between floating and tiled placement.
+
+###### Returns
+
+`void`
+
+##### onToggleMaximize?
+
+```ts
+optional onToggleMaximize?: () => void;
+```
+
+Request toggling maximized presentation.
+
+###### Returns
+
+`void`
+
+##### onMinimize?
+
+```ts
+optional onMinimize?: () => void;
+```
+
+Request minimizing; the caller owns window visibility.
+
+###### Returns
+
+`void`
+
+##### onClose?
+
+```ts
+optional onClose?: () => void;
+```
+
+Request closing; the caller owns disposal and removal.
+
+###### Returns
+
+`void`
+
+##### onSelect?
+
+```ts
+optional onSelect?: () => void;
+```
+
+Select a compact game panel for reading on a narrow screen.
+
+###### Returns
+
+`void`
+
+## Variables
+
+### WindowFrame
+
+```ts
+const WindowFrame: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLElement> & object & RefAttributes<HTMLElement>
+>;
+```
+
+A clipped, rounded shell for either a tiled or floating application.
+
+---
+
+### WindowBody
+
+```ts
+const WindowBody: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement>
+>;
+```
+
+The scrolling region stays inside the shell, beneath a stationary title bar.
+
+---
+
+### GameWindowContent
+
+```ts
+const GameWindowContent: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement>
+>;
+```
+
+Reading rhythm for compact game-window blocks and action keys.
+
+## Functions
+
+### WindowSnapPreview()
+
+```ts
+function WindowSnapPreview(__namedParameters): Element;
+```
+
+Decorative snap destination. Geometry and visibility belong to the layout owner.
+
+#### Parameters
+
+| Parameter           | Type                                 |
+| ------------------- | ------------------------------------ |
+| `__namedParameters` | `HTMLAttributes`\<`HTMLDivElement`\> |
+
+#### Returns
+
+`Element`
+
+---
+
+### WindowHeader()
+
+```ts
+function WindowHeader(__namedParameters): Element;
+```
+
+The handle, Back and actions are siblings, so presses never start a drag.
+
+#### Parameters
+
+| Parameter           | Type                                      |
+| ------------------- | ----------------------------------------- |
+| `__namedParameters` | [`WindowHeaderProps`](#windowheaderprops) |
+
+#### Returns
+
+`Element`
+
+---
+
+### WindowActions()
+
+```ts
+function WindowActions(__namedParameters): Element;
+```
+
+Consistent icons, ordering and accessible names for host-owned commands.
+
+#### Parameters
+
+| Parameter           | Type                                        |
+| ------------------- | ------------------------------------------- |
+| `__namedParameters` | [`WindowActionsProps`](#windowactionsprops) |
+
+#### Returns
+
+`Element`

package/docs/api/components/wizard.md

@@ -0,0 +1,65 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/wizard
+
+# components/wizard
+
+## Type Aliases
+
+### WizardStep
+
+```ts
+type WizardStep = object;
+```
+
+A named step. Values and validation remain in the caller's form.
+
+#### Properties
+
+##### id
+
+```ts
+id: string;
+```
+
+##### title
+
+```ts
+title: string;
+```
+
+##### content
+
+```ts
+content: ReactNode;
+```
+
+## Functions
+
+### Wizard()
+
+```ts
+function Wizard(__namedParameters): Element;
+```
+
+Controlled step presentation, composable with one TanStack Form across steps.
+
+#### Parameters
+
+| Parameter                         | Type                                                                                                                                                                                       | Description                                                                |
+| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- |
+| `__namedParameters`               | \{ `steps`: readonly [`WizardStep`](#wizardstep)[]; `current`: `string`; `onStepChange`: (`id`) => `void`; `disabled?`: `boolean`; `nextDisabled?`: `boolean`; `actions?`: `ReactNode`; \} | -                                                                          |
+| `__namedParameters.steps`         | readonly [`WizardStep`](#wizardstep)[]                                                                                                                                                     | -                                                                          |
+| `__namedParameters.current`       | `string`                                                                                                                                                                                   | -                                                                          |
+| `__namedParameters.onStepChange`  | (`id`) => `void`                                                                                                                                                                           | -                                                                          |
+| `__namedParameters.disabled?`     | `boolean`                                                                                                                                                                                  | -                                                                          |
+| `__namedParameters.nextDisabled?` | `boolean`                                                                                                                                                                                  | Validation may block advancing without preventing edits to previous steps. |
+| `__namedParameters.actions?`      | `ReactNode`                                                                                                                                                                                | -                                                                          |
+
+#### Returns
+
+`Element`

package/docs/api/enhance/cigarette-card.md

@@ -0,0 +1,52 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / enhance/cigarette-card
+
+# enhance/cigarette-card
+
+## Functions
+
+### setCigaretteCardFlipped()
+
+```ts
+function setCigaretteCardFlipped(card, flipped): void;
+```
+
+Show one face of a server-rendered CigaretteCard.
+
+#### Parameters
+
+| Parameter | Type          |
+| --------- | ------------- |
+| `card`    | `HTMLElement` |
+| `flipped` | `boolean`     |
+
+#### Returns
+
+`void`
+
+---
+
+### enhanceCigaretteCards()
+
+```ts
+function enhanceCigaretteCards(root?): () => void;
+```
+
+Flip server-rendered CigaretteCards on click, tap, Enter or Space. The card is a
+native button, so the keyboard reaches it as a click; this only toggles the
+pressed state. Returns a cleanup that removes the listener.
+
+#### Parameters
+
+| Parameter | Type                        | Default value |
+| --------- | --------------------------- | ------------- |
+| `root`    | `Document` \| `HTMLElement` | `document`    |
+
+#### Returns
+
+() => `void`

package/docs/api/enhance/sketch.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) / enhance/sketch
+
+# enhance/sketch
+
+## Functions
+
+### sketch()
+
+```ts
+function sketch(root?): () => void;
+```
+
+The opt-in pencil layer for server-rendered field-guide pages.
+
+Markup contract, all plain attributes so any host can use it without React:
+
+- `data-sketch-root` marks a positioned host; its overlay is drawn inside it.
+- `data-sketch="circle" | "underline"` marks inline text to annotate.
+- `data-sketch-leader-x` / `data-sketch-leader-y` (fractions of the target box)
+  on a note draw a leader from the note to the `data-sketch-target` inside the
+  same `data-sketch-item`. The layout decides whether leaders apply by setting
+  `--caps-sketch-leader: on` on the note.
+
+Strokes use `currentColor`, so a theme switch recolors them without a redraw.
+The host receives `data-sketch-drawn` once annotations exist, which lets Caps
+hide the static CSS fallbacks they replace.
+
+#### Parameters
+
+| Parameter | Type         | Default value |
+| --------- | ------------ | ------------- |
+| `root`    | `ParentNode` | `document`    |
+
+#### Returns
+
+() => `void`