@fungi.computer/caps 0.0.0-stage → 0.0.1

package/docs/api/components/dialog.md

@@ -0,0 +1,235 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/dialog
+
+# components/dialog
+
+## Type Aliases
+
+### DialogChangeDetails
+
+```ts
+type DialogChangeDetails = BaseDialog.Root.ChangeEventDetails;
+```
+
+Details supplied to a Dialog open-change callback.
+
+---
+
+### DialogChangeReason
+
+```ts
+type DialogChangeReason = BaseDialog.Root.ChangeEventReason;
+```
+
+Supported DialogChangeReason values.
+
+---
+
+### DialogInteractionOwner
+
+```ts
+type DialogInteractionOwner = "host" | "local";
+```
+
+Supported DialogInteractionOwner values.
+
+---
+
+### DialogProps
+
+```ts
+type DialogProps<Payload> = BaseDialog.Root.Props<Payload> & object;
+```
+
+Props accepted by Dialog.
+
+#### Type Declaration
+
+| Name                | Type                                                |
+| ------------------- | --------------------------------------------------- |
+| `interactionOwner?` | [`DialogInteractionOwner`](#dialoginteractionowner) |
+
+#### Type Parameters
+
+| Type Parameter | Default type |
+| -------------- | ------------ |
+| `Payload`      | `unknown`    |
+
+---
+
+### DialogContentProps
+
+```ts
+type DialogContentProps = BaseDialog.Popup.Props &
+  Pick<BaseDialog.Portal.Props, "container" | "keepMounted">;
+```
+
+Props accepted by DialogContent.
+
+## Variables
+
+### DialogTrigger
+
+```ts
+const DialogTrigger: ForwardRefExoticComponent<
+  Omit<Props<unknown>, "ref"> & RefAttributes<HTMLButtonElement>
+>;
+```
+
+The trigger control for a Dialog.
+
+---
+
+### DialogPortal
+
+```ts
+const DialogPortal: ForwardRefExoticComponent<
+  Omit<DialogPortalProps, "ref"> & RefAttributes<HTMLDivElement>
+>;
+```
+
+Shell dialog destination, with Base UI container and mount lifetime overrides.
+
+---
+
+### DialogBackdrop
+
+```ts
+const DialogBackdrop: ForwardRefExoticComponent<
+  Omit<DialogBackdropProps, "ref"> & RefAttributes<HTMLDivElement>
+>;
+```
+
+The styled backdrop for a composed Dialog.
+
+---
+
+### DialogPopup
+
+```ts
+const DialogPopup: ForwardRefExoticComponent<
+  Omit<DialogPopupProps, "ref"> & RefAttributes<HTMLDivElement>
+>;
+```
+
+The styled popup with Base UI composition and caller-controlled focus targets.
+
+---
+
+### DialogContent
+
+```ts
+const DialogContent: ForwardRefExoticComponent<
+  Omit<DialogContentProps, "ref"> & RefAttributes<HTMLDivElement>
+>;
+```
+
+The default portal, backdrop and popup composition for a Dialog. Keeps child
+state across closes. Like Base UI, only full modal mode has a backdrop.
+
+---
+
+### DialogTitle
+
+```ts
+const DialogTitle: ForwardRefExoticComponent<
+  Omit<DialogTitleProps, "ref"> & RefAttributes<HTMLHeadingElement>
+>;
+```
+
+The accessible title for a Dialog.
+
+---
+
+### DialogDescription
+
+```ts
+const DialogDescription: ForwardRefExoticComponent<
+  Omit<DialogDescriptionProps, "ref"> & RefAttributes<HTMLParagraphElement>
+>;
+```
+
+The accessible description for a Dialog.
+
+---
+
+### DialogClose
+
+```ts
+const DialogClose: ForwardRefExoticComponent<
+  Omit<DialogCloseProps, "ref"> & RefAttributes<HTMLButtonElement>
+>;
+```
+
+A control that requests a Dialog to close.
+
+## Functions
+
+### Dialog()
+
+```ts
+function Dialog<Payload>(__namedParameters): Element;
+```
+
+A dialog controller with explicit controlled or uncontrolled open state.
+
+#### Type Parameters
+
+| Type Parameter | Default type |
+| -------------- | ------------ |
+| `Payload`      | `unknown`    |
+
+#### Parameters
+
+| Parameter           | Type                                       |
+| ------------------- | ------------------------------------------ |
+| `__namedParameters` | [`DialogProps`](#dialogprops)\<`Payload`\> |
+
+#### Returns
+
+`Element`
+
+---
+
+### DialogFooter()
+
+```ts
+function DialogFooter(__namedParameters): Element;
+```
+
+A footer layout for caller-provided Dialog actions.
+
+#### Parameters
+
+| Parameter           | Type                                 |
+| ------------------- | ------------------------------------ |
+| `__namedParameters` | `HTMLAttributes`\<`HTMLDivElement`\> |
+
+#### Returns
+
+`Element`
+
+---
+
+### DialogHeader()
+
+```ts
+function DialogHeader(__namedParameters): Element;
+```
+
+A header layout for caller-provided Dialog content.
+
+#### Parameters
+
+| Parameter           | Type                                 |
+| ------------------- | ------------------------------------ |
+| `__namedParameters` | `HTMLAttributes`\<`HTMLDivElement`\> |
+
+#### Returns
+
+`Element`

package/docs/api/components/diff-view.md

@@ -0,0 +1,59 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/diff-view
+
+# components/diff-view
+
+## Type Aliases
+
+### DiffViewLine
+
+```ts
+type DiffViewLine = Readonly<{
+  kind: "add" | "context" | "file" | "hunk" | "remove";
+  text: string;
+}>;
+```
+
+One presentational diff line; the caller owns parsing.
+
+---
+
+### DiffViewProps
+
+```ts
+type DiffViewProps = object & Omit<HTMLAttributes<HTMLPreElement>, "children">;
+```
+
+Props accepted by DiffView.
+
+#### Type Declaration
+
+| Name           | Type                                       | Description                                         |
+| -------------- | ------------------------------------------ | --------------------------------------------------- |
+| `lines`        | readonly [`DiffViewLine`](#diffviewline)[] | -                                                   |
+| `hiddenLines?` | `number`                                   | Lines the caller omitted, shown as a trailing note. |
+
+## Functions
+
+### DiffView()
+
+```ts
+function DiffView(__namedParameters): Element;
+```
+
+A compact monospace diff with add/remove/hunk/file line tones.
+
+#### Parameters
+
+| Parameter           | Type                              |
+| ------------------- | --------------------------------- |
+| `__namedParameters` | [`DiffViewProps`](#diffviewprops) |
+
+#### Returns
+
+`Element`

package/docs/api/components/disclosure.md

@@ -0,0 +1,71 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/disclosure
+
+# components/disclosure
+
+## Type Aliases
+
+### DisclosureTone
+
+```ts
+type DisclosureTone = "neutral" | "error";
+```
+
+Semantic tone of the disclosure header.
+
+---
+
+### DisclosureSize
+
+```ts
+type DisclosureSize = "group" | "row";
+```
+
+Density: `group` for a summary header, `row` for a compact nested row.
+
+---
+
+### DisclosureProps
+
+```ts
+type DisclosureProps = Readonly<{
+  open: boolean;
+  onOpenChange: (open) => void;
+  summary: ReactNode;
+  leading?: ReactNode;
+  trailing?: ReactNode;
+  children?: ReactNode;
+  tone?: DisclosureTone;
+  size?: DisclosureSize;
+  className?: string;
+}>;
+```
+
+Props accepted by Disclosure.
+
+## Functions
+
+### Disclosure()
+
+```ts
+function Disclosure(__namedParameters): Element;
+```
+
+A controlled one-line disclosure over Base UI Collapsible. The header is a
+native button carrying `aria-expanded` and `aria-controls`, so Enter and Space
+toggle it.
+
+#### Parameters
+
+| Parameter           | Type                                  |
+| ------------------- | ------------------------------------- |
+| `__namedParameters` | [`DisclosureProps`](#disclosureprops) |
+
+#### Returns
+
+`Element`

package/docs/api/components/dropdown-menu.md

@@ -0,0 +1,269 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/dropdown-menu
+
+# components/dropdown-menu
+
+## Type Aliases
+
+### DropdownMenuChangeDetails
+
+```ts
+type DropdownMenuChangeDetails = BaseMenu.Root.ChangeEventDetails;
+```
+
+Details supplied to a DropdownMenu open-change callback.
+
+---
+
+### DropdownMenuChangeReason
+
+```ts
+type DropdownMenuChangeReason = BaseMenu.Root.ChangeEventReason;
+```
+
+Supported DropdownMenuChangeReason values.
+
+---
+
+### DropdownMenuInteractionOwner
+
+```ts
+type DropdownMenuInteractionOwner = "host" | "local";
+```
+
+Supported DropdownMenuInteractionOwner values.
+
+---
+
+### DropdownMenuProps
+
+```ts
+type DropdownMenuProps<Payload> = BaseMenu.Root.Props<Payload> & object;
+```
+
+Props accepted by DropdownMenu.
+
+#### Type Declaration
+
+| Name                | Type                                                            |
+| ------------------- | --------------------------------------------------------------- |
+| `interactionOwner?` | [`DropdownMenuInteractionOwner`](#dropdownmenuinteractionowner) |
+
+#### Type Parameters
+
+| Type Parameter | Default type |
+| -------------- | ------------ |
+| `Payload`      | `unknown`    |
+
+---
+
+### DropdownMenuContentProps
+
+```ts
+type DropdownMenuContentProps = BaseMenu.Popup.Props &
+  Pick<BaseMenu.Portal.Props, "container" | "keepMounted"> &
+  Pick<
+    BaseMenu.Positioner.Props,
+    "align" | "alignOffset" | "side" | "sideOffset"
+  >;
+```
+
+Props accepted by DropdownMenuContent.
+
+---
+
+### DropdownMenuItemProps
+
+```ts
+type DropdownMenuItemProps = Omit<BaseMenu.Item.Props, "onSelect"> & object;
+```
+
+Props accepted by DropdownMenuItem.
+
+#### Type Declaration
+
+| Name          | Type                           | Description                        |
+| ------------- | ------------------------------ | ---------------------------------- |
+| `onSelect()?` | (`event`) => `void`            | Called when this item is selected. |
+| `variant?`    | `"default"` \| `"destructive"` | -                                  |
+
+---
+
+### DropdownMenuCheckboxItemProps
+
+```ts
+type DropdownMenuCheckboxItemProps = Omit<
+  BaseMenu.CheckboxItem.Props,
+  "onSelect"
+> &
+  Pick<DropdownMenuItemProps, "onSelect">;
+```
+
+Props accepted by DropdownMenuCheckboxItem.
+
+## Variables
+
+### DropdownMenuTrigger
+
+```ts
+const DropdownMenuTrigger: ForwardRefExoticComponent<
+  Omit<Props<unknown>, "ref"> & RefAttributes<HTMLButtonElement>
+>;
+```
+
+The trigger control for a DropdownMenu.
+
+---
+
+### DropdownMenuPortal
+
+```ts
+const DropdownMenuPortal: ForwardRefExoticComponent<
+  Omit<MenuPortalProps, "ref"> & RefAttributes<HTMLDivElement>
+>;
+```
+
+Shell popover destination, with Base UI container and mount lifetime overrides.
+
+---
+
+### DropdownMenuPositioner
+
+```ts
+const DropdownMenuPositioner: ForwardRefExoticComponent<
+  Omit<MenuPositionerProps, "ref"> & RefAttributes<HTMLDivElement>
+>;
+```
+
+Base UI owns placement; a shell's popover root supplies its collision boundary.
+
+---
+
+### DropdownMenuPopup
+
+```ts
+const DropdownMenuPopup: ForwardRefExoticComponent<
+  Omit<MenuPopupProps, "ref"> & RefAttributes<HTMLDivElement>
+>;
+```
+
+The styled popup for caller-composed menu placement and portal ownership.
+
+---
+
+### DropdownMenuContent
+
+```ts
+const DropdownMenuContent: ForwardRefExoticComponent<
+  Omit<DropdownMenuContentProps, "ref"> & RefAttributes<HTMLDivElement>
+>;
+```
+
+The positioned content region for a DropdownMenu.
+
+---
+
+### DropdownMenuItem
+
+```ts
+const DropdownMenuItem: ForwardRefExoticComponent<
+  Omit<DropdownMenuItemProps, "ref"> & RefAttributes<HTMLElement>
+>;
+```
+
+An actionable item in a DropdownMenu.
+
+---
+
+### DropdownMenuCheckboxItem
+
+```ts
+const DropdownMenuCheckboxItem: ForwardRefExoticComponent<
+  Omit<DropdownMenuCheckboxItemProps, "ref"> & RefAttributes<HTMLElement>
+>;
+```
+
+A checkable item in a DropdownMenu.
+
+---
+
+### DropdownMenuSeparator
+
+```ts
+const DropdownMenuSeparator: ForwardRefExoticComponent<
+  Omit<SeparatorProps, "ref"> & RefAttributes<HTMLDivElement>
+>;
+```
+
+A visual separator in a DropdownMenu.
+
+---
+
+### DropdownMenuGroup
+
+```ts
+const DropdownMenuGroup: ForwardRefExoticComponent<
+  Omit<MenuGroupProps, "ref"> & RefAttributes<HTMLDivElement>
+> = BaseMenu.Group;
+```
+
+A named set of related items; pair it with a DropdownMenuLabel.
+
+---
+
+### DropdownMenuLabel
+
+```ts
+const DropdownMenuLabel: ForwardRefExoticComponent<
+  Omit<MenuGroupLabelProps, "ref"> & RefAttributes<HTMLDivElement>
+>;
+```
+
+The visible name of a DropdownMenuGroup, announced with its items.
+
+## Functions
+
+### DropdownMenu()
+
+```ts
+function DropdownMenu<Payload>(__namedParameters): Element;
+```
+
+A menu controller with explicit controlled or uncontrolled open state.
+
+#### Type Parameters
+
+| Type Parameter | Default type |
+| -------------- | ------------ |
+| `Payload`      | `unknown`    |
+
+#### Parameters
+
+| Parameter           | Type                                                   |
+| ------------------- | ------------------------------------------------------ |
+| `__namedParameters` | [`DropdownMenuProps`](#dropdownmenuprops)\<`Payload`\> |
+
+#### Returns
+
+`Element`
+
+---
+
+### useDropdownMenu()
+
+```ts
+function useDropdownMenu(): object;
+```
+
+Access the nearest DropdownMenu close operation.
+
+#### Returns
+
+| Name      | Type                        | Description                               |
+| --------- | --------------------------- | ----------------------------------------- |
+| `close()` | () => `void` \| `undefined` | Close the nearest menu, if it is mounted. |