@fungi.computer/caps 0.0.0-stage → 0.0.1

package/docs/api/blocks/command-menu.md

@@ -0,0 +1,89 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / blocks/command-menu
+
+# blocks/command-menu
+
+## Type Aliases
+
+### CommandMenuItem
+
+```ts
+type CommandMenuItem = object;
+```
+
+Caller-provided command menu item data.
+
+#### Properties
+
+##### description?
+
+```ts
+optional description?: string;
+```
+
+##### disabled?
+
+```ts
+optional disabled?: boolean;
+```
+
+##### id
+
+```ts
+id: string;
+```
+
+##### label
+
+```ts
+label: string;
+```
+
+##### shortcut?
+
+```ts
+optional shortcut?: string;
+```
+
+Key hint shown before the label, e.g. `z` in a which-key list.
+
+---
+
+### CommandMenuProps
+
+```ts
+type CommandMenuProps = Omit<
+  HTMLAttributes<HTMLUListElement>,
+  "children" | "onSelect"
+> &
+  object;
+```
+
+Props accepted by CommandMenu.
+
+#### Type Declaration
+
+| Name         | Type                                             | Description                                                      |
+| ------------ | ------------------------------------------------ | ---------------------------------------------------------------- |
+| `items`      | readonly [`CommandMenuItem`](#commandmenuitem)[] | -                                                                |
+| `onSelect()` | (`id`) => `void`                                 | Called after a non-disabled item is selected.                    |
+| `selected?`  | `string`                                         | Caller-owned selected state; distinct from local keyboard focus. |
+
+## Variables
+
+### CommandMenu
+
+```ts
+const CommandMenu: ForwardRefExoticComponent<
+  Omit<HTMLAttributes<HTMLUListElement>, "children" | "onSelect"> &
+    object &
+    RefAttributes<HTMLUListElement>
+>;
+```
+
+A single-focus listbox with local navigation and caller-owned selection.

package/docs/api/blocks/composer.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) / blocks/composer
+
+# blocks/composer
+
+## Type Aliases
+
+### ComposerProps
+
+```ts
+type ComposerProps = HTMLAttributes<HTMLDivElement> & object;
+```
+
+Props accepted by Composer.
+
+#### Type Declaration
+
+| Name            | Type        | Description                                                                                   |
+| --------------- | ----------- | --------------------------------------------------------------------------------------------- |
+| `input`         | `ReactNode` | The caller-owned primary input control.                                                       |
+| `action?`       | `ReactNode` | The caller-owned action control. Its disabled state and accessible name stay on that control. |
+| `leading?`      | `ReactNode` | Optional caller-owned leading slot, such as an avatar.                                        |
+| `rowClassName?` | `string`    | Classes for the joined row; useful when the host exposes a busy state.                        |
+
+## Variables
+
+### Composer
+
+```ts
+const Composer: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & object & RefAttributes<HTMLDivElement>
+>;
+```
+
+Layout and slots only. It never assigns action-control semantics.

package/docs/api/blocks/empty-state.md

@@ -0,0 +1,97 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / blocks/empty-state
+
+# blocks/empty-state
+
+## Type Aliases
+
+### EmptyStateVariant
+
+```ts
+type EmptyStateVariant = "plain" | "panel" | "speech" | "hint" | "quiet";
+```
+
+How an absence presents itself. `plain` leaves layout to the host; `panel` is a
+recessed, centered invitation; `speech` lets the visual (a mascot) say the copy
+from a molded speech bubble; `hint` is a quiet centered footnote under content,
+such as the next thing to try; `quiet` is a left-aligned absence nested under a
+card or section heading, titled below that heading.
+
+---
+
+### EmptyStateHeadingLevel
+
+```ts
+type EmptyStateHeadingLevel = 2 | 3 | 4;
+```
+
+The document heading level of an EmptyState title.
+
+---
+
+### EmptyStateVisualState
+
+```ts
+type EmptyStateVisualState = Readonly<{
+  speaking: boolean;
+  thinking: boolean;
+}>;
+```
+
+What a visual is told while the EmptyState is on screen.
+
+---
+
+### EmptyStateSuggestion
+
+```ts
+type EmptyStateSuggestion = Readonly<{
+  label: string;
+  onSelect: () => void;
+}>;
+```
+
+A suggested next step, shown as a chip the host acts on.
+
+---
+
+### EmptyStateProps
+
+```ts
+type EmptyStateProps = Omit<HTMLAttributes<HTMLElement>, "title"> & object;
+```
+
+Props accepted by EmptyState.
+
+#### Type Declaration
+
+| Name              | Type                                                       | Description                                                                 |
+| ----------------- | ---------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `actions?`        | `ReactNode`                                                | -                                                                           |
+| `description`     | `ReactNode`                                                | -                                                                           |
+| `suggestions?`    | readonly [`EmptyStateSuggestion`](#emptystatesuggestion)[] | Chips that offer a starting point, such as a prompt to try.                 |
+| `thinking?`       | `boolean`                                                  | The host is working on something, such as creating what this state invites. |
+| `title`           | `ReactNode`                                                | -                                                                           |
+| `headingLevel?`   | [`EmptyStateHeadingLevel`](#emptystateheadinglevel)        | Heading level for the title; use one below the heading it sits under.       |
+| `visual?`         | `ReactNode`                                                | Static art.                                                                 |
+| `renderVisual()?` | (`state`) => `ReactNode`                                   | Render a visual from the current speaking and thinking state.               |
+| `variant?`        | [`EmptyStateVariant`](#emptystatevariant)                  | -                                                                           |
+
+## Variables
+
+### EmptyState
+
+```ts
+const EmptyState: ForwardRefExoticComponent<
+  Omit<HTMLAttributes<HTMLElement>, "title"> &
+    object &
+    RefAttributes<HTMLElement>
+>;
+```
+
+Product-neutral absence presentation; hosts supply copy, art, and actions.

package/docs/api/blocks/faq-chat.md

@@ -0,0 +1,147 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / blocks/faq-chat
+
+# blocks/faq-chat
+
+## Type Aliases
+
+### FaqChatEntry
+
+```ts
+type FaqChatEntry = object;
+```
+
+One reviewed question and its fixed answer.
+
+#### Properties
+
+##### id
+
+```ts
+id: string;
+```
+
+Stable identity for the entry.
+
+##### question
+
+```ts
+question: string;
+```
+
+The question as a visitor would ask it. Also shown as a suggestion.
+
+##### answer
+
+```ts
+answer: ReactNode;
+```
+
+The reviewed answer. The chat never generates text of its own.
+
+##### keywords?
+
+```ts
+optional keywords?: readonly string[];
+```
+
+Lowercase words or phrases that route a typed question here.
+
+##### actions?
+
+```ts
+optional actions?: ReactNode;
+```
+
+Caller-owned next steps shown under the answer, such as links.
+
+---
+
+### FaqChatFallback
+
+```ts
+type FaqChatFallback = object;
+```
+
+The reply for a typed question that matches no entry.
+
+#### Properties
+
+##### answer
+
+```ts
+answer: ReactNode;
+```
+
+##### actions?
+
+```ts
+optional actions?: ReactNode;
+```
+
+---
+
+### FaqChatProps
+
+```ts
+type FaqChatProps = Omit<HTMLAttributes<HTMLElement>, "title"> & object;
+```
+
+Props accepted by FaqChat.
+
+#### Type Declaration
+
+| Name           | Type                                       | Description                                           |
+| -------------- | ------------------------------------------ | ----------------------------------------------------- |
+| `entries`      | readonly [`FaqChatEntry`](#faqchatentry)[] | -                                                     |
+| `greeting`     | `ReactNode`                                | The first agent message, shown before any question.   |
+| `fallback`     | [`FaqChatFallback`](#faqchatfallback)      | -                                                     |
+| `title`        | `ReactNode`                                | Visible heading and accessible name of the chat.      |
+| `note?`        | `ReactNode`                                | A short honest note about where answers come from.    |
+| `avatar?`      | `ReactNode`                                | Optional mark shown beside the title, such as a logo. |
+| `inputLabel?`  | `string`                                   | Accessible label of the typed-question field.         |
+| `placeholder?` | `string`                                   | -                                                     |
+| `submitLabel?` | `string`                                   | -                                                     |
+
+## Variables
+
+### FaqChat
+
+```ts
+const FaqChat: ForwardRefExoticComponent<
+  Omit<HTMLAttributes<HTMLElement>, "title"> &
+    object &
+    RefAttributes<HTMLElement>
+>;
+```
+
+A chat-shaped FAQ. Visitors pick or type a question and get the caller's
+reviewed answer with its next steps. Message rows follow Parakeet: the visitor's
+turn sits on the surface with a primary rule, the answer is plain.
+
+## Functions
+
+### matchFaqEntry()
+
+```ts
+function matchFaqEntry(entries, text): FaqChatEntry | undefined;
+```
+
+Routes a typed question to the entry whose keywords it mentions most. Returns
+undefined when nothing matches, so the caller can answer honestly.
+
+#### Parameters
+
+| Parameter | Type                                       |
+| --------- | ------------------------------------------ |
+| `entries` | readonly [`FaqChatEntry`](#faqchatentry)[] |
+| `text`    | `string`                                   |
+
+#### Returns
+
+[`FaqChatEntry`](#faqchatentry) \| `undefined`

package/docs/api/blocks/game-share-card.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) / blocks/game-share-card
+
+# blocks/game-share-card
+
+## Type Aliases
+
+### GameShareCardProps
+
+```ts
+type GameShareCardProps = HTMLAttributes<HTMLDivElement> & object;
+```
+
+Presentation for a published game; fetching and navigation stay with the host.
+
+#### Type Declaration
+
+| Name       | Type           | Description                                                        |
+| ---------- | -------------- | ------------------------------------------------------------------ |
+| `heading`  | `ReactNode`    | -                                                                  |
+| `eyebrow?` | `ReactNode`    | -                                                                  |
+| `cover?`   | `ReactNode`    | -                                                                  |
+| `action`   | `ReactElement` | A host-owned link or button, presented as the primary play action. |
+
+## Variables
+
+### GameShareCard
+
+```ts
+const GameShareCard: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & object & RefAttributes<HTMLDivElement>
+>;
+```
+
+Compose a game's cover, share details and play action in the enclosing theme.

package/docs/api/blocks/launcher-grid.md

@@ -0,0 +1,86 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / blocks/launcher-grid
+
+# blocks/launcher-grid
+
+## Type Aliases
+
+### SectionGridProps
+
+```ts
+type SectionGridProps = HTMLAttributes<HTMLDivElement> & object;
+```
+
+SectionGrid props.
+
+#### Type Declaration
+
+| Name      | Type                     | Description                                                                                                                                                                                         |
+| --------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `layout?` | `"split"` \| `"desktop"` | `split` is a page's two-column section grid. `desktop` composes a home screen: it fills and scrolls its region, centers a bounded measure, and lets `span="full"` sections run across both columns. |
+
+---
+
+### AppGridItem
+
+```ts
+type AppGridItem = Readonly<{
+  id: string;
+  label: string;
+  icon: ReactNode;
+  status?: ReactNode;
+  disabled?: boolean;
+  muted?: boolean;
+  onSelect: () => void;
+}>;
+```
+
+A caller-owned App launch option.
+
+---
+
+### AppGridProps
+
+```ts
+type AppGridProps = Omit<HTMLAttributes<HTMLUListElement>, "children"> & object;
+```
+
+AppGrid props.
+
+#### Type Declaration
+
+| Name    | Type                                     | Description                                                                                                                  |
+| ------- | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `items` | readonly [`AppGridItem`](#appgriditem)[] | -                                                                                                                            |
+| `size?` | `"default"` \| `"lg"`                    | `default` is a quiet launcher. `lg` gives each mark a larger key and a more spacious label. The theme supplies its material. |
+
+## Variables
+
+### SectionGrid
+
+```ts
+const SectionGrid: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & object & RefAttributes<HTMLDivElement>
+>;
+```
+
+A two-column page section grid that stacks at the compact breakpoint.
+
+---
+
+### AppGrid
+
+```ts
+const AppGrid: ForwardRefExoticComponent<
+  Omit<HTMLAttributes<HTMLUListElement>, "children"> &
+    object &
+    RefAttributes<HTMLUListElement>
+>;
+```
+
+A responsive launcher grid with large marks and concise labels.

package/docs/api/blocks/listing-detail.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) / blocks/listing-detail
+
+# blocks/listing-detail
+
+## Type Aliases
+
+### ListingDetailProps
+
+```ts
+type ListingDetailProps = Readonly<{
+  identity: string;
+  title: string;
+  tagline: string;
+  icon?: ReactNode;
+  seller?: ReactNode;
+  action?: ReactNode;
+  back?: ReactNode;
+  note?: ReactNode;
+  screenshots?: readonly object[];
+  description?: readonly string[];
+  facts?: readonly object[];
+}>;
+```
+
+Product-neutral listing detail: callers own availability, navigation and facts.
+
+## Functions
+
+### ListingDetail()
+
+```ts
+function ListingDetail(__namedParameters): Element;
+```
+
+A focused detail heading, screenshot strip, readable body and fact sheet.
+
+#### Parameters
+
+| Parameter           | Type                                        |
+| ------------------- | ------------------------------------------- |
+| `__namedParameters` | [`ListingDetailProps`](#listingdetailprops) |
+
+#### Returns
+
+`Element`

package/docs/api/blocks/loading-state.md

@@ -0,0 +1,21 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / blocks/loading-state
+
+# blocks/loading-state
+
+## Variables
+
+### LoadingState
+
+```ts
+const LoadingState: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & object & RefAttributes<HTMLDivElement>
+>;
+```
+
+A bounded, labelled loading region; the caller owns the message.

package/docs/api/blocks/mosaic.md

@@ -0,0 +1,94 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / blocks/mosaic
+
+# blocks/mosaic
+
+## Type Aliases
+
+### MosaicItem
+
+```ts
+type MosaicItem = object;
+```
+
+A caller-resolved visual tile.
+
+#### Properties
+
+##### alt?
+
+```ts
+optional alt?: string;
+```
+
+##### height?
+
+```ts
+optional height?: number;
+```
+
+##### id
+
+```ts
+id: string;
+```
+
+##### disabled?
+
+```ts
+optional disabled?: boolean;
+```
+
+##### state?
+
+```ts
+optional state?: "loading" | "ready" | "error";
+```
+
+##### url?
+
+```ts
+optional url?: string;
+```
+
+##### width?
+
+```ts
+optional width?: number;
+```
+
+---
+
+### MosaicProps
+
+```ts
+type MosaicProps = HTMLAttributes<HTMLDivElement> & object;
+```
+
+Props accepted by Mosaic.
+
+#### Type Declaration
+
+| Name        | Type                                   | Description                                          |
+| ----------- | -------------------------------------- | ---------------------------------------------------- |
+| `empty?`    | `ReactNode`                            | -                                                    |
+| `items`     | readonly [`MosaicItem`](#mosaicitem)[] | -                                                    |
+| `label?`    | `ReactNode`                            | Caller-owned accessible copy for the list.           |
+| `onOpen()?` | (`item`) => `void`                     | When absent, tiles are deliberately non-interactive. |
+
+## Variables
+
+### Mosaic
+
+```ts
+const Mosaic: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & object & RefAttributes<HTMLDivElement>
+>;
+```
+
+Renders supplied tiles only; callers resolve data, policy, and navigation.