@fungi.computer/caps 0.0.0-stage → 0.0.1

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

@@ -0,0 +1,79 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / blocks/permission-grid
+
+# blocks/permission-grid
+
+## Type Aliases
+
+### PermissionState
+
+```ts
+type PermissionState = "allowed" | "denied";
+```
+
+Whether the capability is available in this scope.
+
+---
+
+### PermissionGridRow
+
+```ts
+type PermissionGridRow = Readonly<{
+  id: string;
+  mark: ReactNode;
+  label: string;
+  group?: string;
+  state: PermissionState;
+  stateLabel: string;
+  scope: string;
+  control?: ReactNode;
+}>;
+```
+
+One capability row.
+
+---
+
+### PermissionGridProps
+
+```ts
+type PermissionGridProps = Readonly<{
+  caption: ReactNode;
+  summary?: ReactNode;
+  rows: readonly PermissionGridRow[];
+  headings?: Readonly<{
+    capability: string;
+    state: string;
+    scope: string;
+    control?: string;
+  }>;
+  className?: string;
+}>;
+```
+
+Props accepted by PermissionGrid.
+
+## Functions
+
+### PermissionGrid()
+
+```ts
+function PermissionGrid(__namedParameters): Element;
+```
+
+Product-neutral, dense capability sheet: one row per capability.
+
+#### Parameters
+
+| Parameter           | Type                                          |
+| ------------------- | --------------------------------------------- |
+| `__namedParameters` | [`PermissionGridProps`](#permissiongridprops) |
+
+#### Returns
+
+`Element`

package/docs/api/blocks/pricing-card.md

@@ -0,0 +1,90 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / blocks/pricing-card
+
+# blocks/pricing-card
+
+## Type Aliases
+
+### PricingPlan
+
+```ts
+type PricingPlan = object;
+```
+
+Caller-provided pricing plan data.
+
+#### Properties
+
+##### name
+
+```ts
+name: ReactNode;
+```
+
+##### description?
+
+```ts
+optional description?: ReactNode;
+```
+
+##### price?
+
+```ts
+optional price?: ReactNode;
+```
+
+##### interval?
+
+```ts
+optional interval?: ReactNode;
+```
+
+---
+
+### PricingCardLayout
+
+```ts
+type PricingCardLayout = "stacked" | "banded";
+```
+
+Supported PricingCard layouts.
+
+---
+
+### PricingCardProps
+
+```ts
+type PricingCardProps = HTMLAttributes<HTMLDivElement> & object;
+```
+
+Props accepted by PricingCard.
+
+#### Type Declaration
+
+| Name        | Type                                                          | Description                                                                                                                          |
+| ----------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
+| `plan`      | [`PricingPlan`](#pricingplan)                                 | -                                                                                                                                    |
+| `features?` | `ReactNode`                                                   | Caller-owned feature rows.                                                                                                           |
+| `action?`   | `ReactNode`                                                   | Caller-owned action control; this block never invokes or configures it.                                                              |
+| `status?`   | `ReactNode`                                                   | Caller-owned status content, such as a badge.                                                                                        |
+| `art?`      | `ReactNode`                                                   | Caller-owned illustration, such as an `img` with its own alt text.                                                                   |
+| `layout?`   | [`PricingCardLayout`](#pricingcardlayout)                     | `stacked` groups the title and price in the header. `banded` places the name above the illustration and keeps the price on one line. |
+| `featured?` | `boolean`                                                     | Marks the one plan a page recommends with a heavier shadow.                                                                          |
+| `density?`  | [`CardProps`](../components/card.md#cardprops)\[`"density"`\] | Use tighter section spacing for dense plan comparisons.                                                                              |
+
+## Variables
+
+### PricingCard
+
+```ts
+const PricingCard: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & object & RefAttributes<HTMLDivElement>
+>;
+```
+
+Displays supplied plan data and slots; checkout and policy stay with the host.

package/docs/api/blocks/release-tag.md

@@ -0,0 +1,62 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / blocks/release-tag
+
+# blocks/release-tag
+
+## Type Aliases
+
+### ReleaseTagEntry
+
+```ts
+type ReleaseTagEntry = Readonly<{
+  name: string;
+  version: string;
+}>;
+```
+
+One shipped thing and its version, printed under the tag.
+
+---
+
+### ReleaseTagProps
+
+```ts
+type ReleaseTagProps = Omit<HTMLAttributes<HTMLElement>, "title"> & object;
+```
+
+Props accepted by ReleaseTag.
+
+#### Type Declaration
+
+| Name      | Type                                             | Description                                                                 |
+| --------- | ------------------------------------------------ | --------------------------------------------------------------------------- |
+| `title`   | readonly `string`[]                              | One or two short lines printed large on the tag, such as ["Fungi", "Beta"]. |
+| `label?`  | `ReactNode`                                      | A small accent strip under the title, such as "Update".                     |
+| `entries` | readonly [`ReleaseTagEntry`](#releasetagentry)[] | -                                                                           |
+
+## Functions
+
+### ReleaseTag()
+
+```ts
+function ReleaseTag(__namedParameters): Element;
+```
+
+A release badge: a torn-off calendar page with binder rings, a stacked title,
+one accent strip and a ruled list of names and versions below. Presentation
+only; the caller supplies every word.
+
+#### Parameters
+
+| Parameter           | Type                                  |
+| ------------------- | ------------------------------------- |
+| `__namedParameters` | [`ReleaseTagProps`](#releasetagprops) |
+
+#### Returns
+
+`Element`

package/docs/api/blocks/resource-select.md

@@ -0,0 +1,126 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / blocks/resource-select
+
+# blocks/resource-select
+
+## Type Aliases
+
+### ResourceOption
+
+```ts
+type ResourceOption = object;
+```
+
+Caller-provided resource option data.
+
+#### Properties
+
+##### disabled?
+
+```ts
+optional disabled?: boolean;
+```
+
+##### id
+
+```ts
+id: string;
+```
+
+##### label
+
+```ts
+label: string;
+```
+
+##### searchText?
+
+```ts
+optional searchText?: string;
+```
+
+---
+
+### ResourceSelectProps
+
+```ts
+type ResourceSelectProps = object;
+```
+
+Props accepted by ResourceSelect.
+
+#### Properties
+
+##### onSelect
+
+```ts
+onSelect: (option) => void;
+```
+
+Called after an option is selected.
+
+###### Parameters
+
+| Parameter | Type                                |
+| --------- | ----------------------------------- |
+| `option`  | [`ResourceOption`](#resourceoption) |
+
+###### Returns
+
+`void`
+
+##### options
+
+```ts
+options: readonly ResourceOption[];
+```
+
+##### placeholder?
+
+```ts
+optional placeholder?: string;
+```
+
+##### triggerProps?
+
+```ts
+optional triggerProps?: ButtonHTMLAttributes<HTMLButtonElement> & DataAttributes;
+```
+
+Native caller metadata, including data-* attributes.
+
+##### value?
+
+```ts
+optional value?: string;
+```
+
+---
+
+### DataAttributes
+
+```ts
+type DataAttributes = Record<
+  `data-${string}`,
+  boolean | number | string | undefined
+>;
+```
+
+Native `data-*` attribute map accepted alongside typed props.
+
+## Variables
+
+### ResourceSelect
+
+```ts
+const ResourceSelect: ForwardRefExoticComponent<
+  ResourceSelectProps & RefAttributes<HTMLButtonElement>
+>;
+```
+
+A resource-selection block with caller-owned options and selected value.

package/docs/api/blocks/result-state.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) / blocks/result-state
+
+# blocks/result-state
+
+## Type Aliases
+
+### ResultStateProps
+
+```ts
+type ResultStateProps = Omit<HTMLAttributes<HTMLElement>, "title"> & object;
+```
+
+Props accepted by ResultState.
+
+#### Type Declaration
+
+| Name          | Type        |
+| ------------- | ----------- |
+| `actions?`    | `ReactNode` |
+| `description` | `ReactNode` |
+| `icon?`       | `ReactNode` |
+| `title`       | `ReactNode` |
+
+## Variables
+
+### ResultState
+
+```ts
+const ResultState: ForwardRefExoticComponent<
+  Omit<HTMLAttributes<HTMLElement>, "title"> &
+    object &
+    RefAttributes<HTMLElement>
+>;
+```
+
+A labelled result presentation; hosts own its meaning and next actions.

package/docs/api/blocks/section-card.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) / blocks/section-card
+
+# blocks/section-card
+
+## Type Aliases
+
+### SectionCardProps
+
+```ts
+type SectionCardProps = HTMLAttributes<HTMLDivElement> & object;
+```
+
+Props accepted by SectionCard.
+
+#### Type Declaration
+
+| Name            | Type                 | Description                                                        |
+| --------------- | -------------------- | ------------------------------------------------------------------ |
+| `heading`       | `ReactNode`          | The host-provided section heading.                                 |
+| `description?`  | `ReactNode`          | Optional host-provided supporting copy.                            |
+| `actions?`      | `ReactNode`          | Optional host-provided controls or status content.                 |
+| `children?`     | `ReactNode`          | The section body, supplied by the host through normal composition. |
+| `span?`         | `"auto"` \| `"full"` | Inside a SectionGrid, `full` spans every column; `auto` takes one. |
+| `headingLevel?` | `2` \| `3`           | Heading level; the host keeps its document outline. Defaults to 3. |
+
+## Variables
+
+### SectionCard
+
+```ts
+const SectionCard: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLDivElement> & object & RefAttributes<HTMLDivElement>
+>;
+```
+
+A presentational card shell. It does not assign behavior to action content.

package/docs/api/blocks/section-heading.md

@@ -0,0 +1,61 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / blocks/section-heading
+
+# blocks/section-heading
+
+## Type Aliases
+
+### EyebrowTone
+
+```ts
+type EyebrowTone = "quiet" | "primary" | "secondary" | "live";
+```
+
+Supported Eyebrow tones. `live` marks something happening right now.
+
+---
+
+### EyebrowProps
+
+```ts
+type EyebrowProps = HTMLAttributes<HTMLParagraphElement> & object;
+```
+
+Props accepted by Eyebrow.
+
+#### Type Declaration
+
+| Name    | Type                          |
+| ------- | ----------------------------- |
+| `tone?` | [`EyebrowTone`](#eyebrowtone) |
+
+## Variables
+
+### SectionHeading
+
+```ts
+const SectionHeading: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLHeadingElement> & RefAttributes<HTMLHeadingElement>
+>;
+```
+
+A shelf or section title with shared case and tracking.
+
+---
+
+### Eyebrow
+
+```ts
+const Eyebrow: ForwardRefExoticComponent<
+  HTMLAttributes<HTMLParagraphElement> &
+    object &
+    RefAttributes<HTMLParagraphElement>
+>;
+```
+
+A small contextual label with shared case and tracking.