@fungi.computer/caps 0.0.0-stage → 0.0.1

package/docs/api/lib/cn.md

@@ -0,0 +1,46 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / lib/cn
+
+# lib/cn
+
+## Variables
+
+### cn
+
+```ts
+const cn: CnFunction;
+```
+
+Merge conditional classes with Tailwind rules and Stipe's named spacing.
+
+## Functions
+
+### resolveClassName()
+
+```ts
+function resolveClassName<State>(className, state): string | undefined;
+```
+
+Resolve a typed React class-name prop before merging its classes.
+
+#### Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `State`        |
+
+#### Parameters
+
+| Parameter   | Type                                                              |
+| ----------- | ----------------------------------------------------------------- |
+| `className` | `string` \| ((`state`) => `string` \| `undefined`) \| `undefined` |
+| `state`     | `State`                                                           |
+
+#### Returns
+
+`string` \| `undefined`

package/docs/api/lib/format-money.md

@@ -0,0 +1,30 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / lib/format-money
+
+# lib/format-money
+
+## Functions
+
+### formatMoney()
+
+```ts
+function formatMoney(amount): string;
+```
+
+Format USD with cents, preserving sub-cent precision without displaying non-zero
+amounts as zero.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `amount`  | `number` |
+
+#### Returns
+
+`string`

package/docs/api/lib/glide.md

@@ -0,0 +1,36 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / lib/glide
+
+# lib/glide
+
+## Functions
+
+### useGlide()
+
+```ts
+function useGlide(lit): RefCallback<HTMLElement>;
+```
+
+One highlight that glides between a list's rows instead of blinking from row to
+row. `lit` selects the highlighted row (keyboard or pointer). While the
+highlight moves, a single stand-in carrying that row's own resting background
+and radius travels from the previous row and the rows' own highlights are held
+back, so at rest every row looks exactly as it always has. Within one open list
+the glide remembers its last row, so leaving and re-entering glides from where
+it was. Timing and easing are the theme's; reduced motion moves the highlight at
+once.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `lit`     | `string` |
+
+#### Returns
+
+`RefCallback`\<`HTMLElement`\>

package/docs/api/lib/ime.md

@@ -0,0 +1,29 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / lib/ime
+
+# lib/ime
+
+## Functions
+
+### isImeComposing()
+
+```ts
+function isImeComposing(event): boolean;
+```
+
+Native composition, including confirmation events whose flag is already false.
+
+#### Parameters
+
+| Parameter | Type                                       |
+| --------- | ------------------------------------------ |
+| `event`   | `Pick`\<`KeyboardEvent`, `"nativeEvent"`\> |
+
+#### Returns
+
+`boolean`

package/docs/api/lib/motion-spring.md

@@ -0,0 +1,91 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / lib/motion-spring
+
+# lib/motion-spring
+
+## Type Aliases
+
+### MotionTiming
+
+```ts
+type MotionTiming = Readonly<{
+  ease: EasingParam;
+  duration: number;
+}>;
+```
+
+Anime.js timing for one tween or segment.
+
+---
+
+### AuthoredSpring
+
+```ts
+type AuthoredSpring = Readonly<{
+  bounce: number;
+  duration: number;
+}>;
+```
+
+A component's own spring, as authored for today's default feel.
+
+## Variables
+
+### immediateTiming
+
+```ts
+const immediateTiming: MotionTiming;
+```
+
+Timing for a change that must land at once.
+
+## Functions
+
+### themedSpring()
+
+```ts
+function themedSpring(motion, authored): MotionTiming;
+```
+
+Anime.js timing for an authored spring, in the theme's feel: bounce and settle
+time scale with `--stipe-motion-bounce` and `--stipe-motion-spring-duration`,
+and a stepped theme moves in `--stipe-motion-steps` discrete steps instead.
+Today's themes reproduce the authored spring exactly.
+
+#### Parameters
+
+| Parameter  | Type                                |
+| ---------- | ----------------------------------- |
+| `motion`   | [`Motion`](motion.md#motion)        |
+| `authored` | [`AuthoredSpring`](#authoredspring) |
+
+#### Returns
+
+[`MotionTiming`](#motiontiming)
+
+---
+
+### themedEase()
+
+```ts
+function themedEase(motion, authored): MotionTiming;
+```
+
+Anime.js timing for an authored eased segment: the duration scales with the
+theme's tempo, and a stepped theme replaces the curve with steps.
+
+#### Parameters
+
+| Parameter  | Type                            |
+| ---------- | ------------------------------- |
+| `motion`   | [`Motion`](motion.md#motion)    |
+| `authored` | [`MotionTiming`](#motiontiming) |
+
+#### Returns
+
+[`MotionTiming`](#motiontiming)

package/docs/api/lib/motion.md

@@ -0,0 +1,212 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / lib/motion
+
+# lib/motion
+
+## Type Aliases
+
+### Motion
+
+```ts
+type Motion = Readonly<{
+  reduced: boolean;
+  squish: number;
+  fast: number;
+  normal: number;
+  slow: number;
+  springDuration: number;
+  bounce: number;
+  stretch: number;
+  distance: number;
+  stagger: number;
+  blur: number;
+  shake: number;
+  steps: number;
+  fuse: number;
+  pressDepth: number;
+  pressScale: number;
+  ease: string;
+  easeExit: string;
+}>;
+```
+
+Resolved, element-scoped motion. Times are milliseconds and distances pixels.
+
+## Variables
+
+### motionDefaults
+
+```ts
+const motionDefaults: Motion = defaults;
+```
+
+Today's feel: the defaults that components' authored timings are written
+against.
+
+## Functions
+
+### readMotion()
+
+```ts
+function readMotion(element): Motion;
+```
+
+Read at an event boundary; no root-theme lookup, so nested tokens win.
+
+#### Parameters
+
+| Parameter | Type      |
+| --------- | --------- |
+| `element` | `Element` |
+
+#### Returns
+
+[`Motion`](#motion)
+
+---
+
+### useMotion()
+
+```ts
+function useMotion(ref): Motion;
+```
+
+Live motion tokens for a mounted ref, including nested theme and OS changes.
+
+#### Parameters
+
+| Parameter | Type                               |
+| --------- | ---------------------------------- |
+| `ref`     | `RefObject`\<`Element` \| `null`\> |
+
+#### Returns
+
+[`Motion`](#motion)
+
+---
+
+### motionTime()
+
+```ts
+function motionTime(motion, authored): number;
+```
+
+Scale one of a component's authored durations by the theme's tempo
+(`--stipe-motion-normal` against its 180ms default). Today's themes return the
+authored value unchanged; reduced motion returns 0 (nothing travels).
+
+#### Parameters
+
+| Parameter  | Type                |
+| ---------- | ------------------- |
+| `motion`   | [`Motion`](#motion) |
+| `authored` | `number`            |
+
+#### Returns
+
+`number`
+
+---
+
+### motionBounce()
+
+```ts
+function motionBounce(motion, authored): number;
+```
+
+Scale one of a component's authored spring bounces by the theme's bounce
+(`--stipe-motion-bounce` against its 0.3 default), so a lively control stays
+livelier than a calm one inside every theme. A 0 theme is critically damped.
+
+#### Parameters
+
+| Parameter  | Type                |
+| ---------- | ------------------- |
+| `motion`   | [`Motion`](#motion) |
+| `authored` | `number`            |
+
+#### Returns
+
+`number`
+
+---
+
+### motionSpringTime()
+
+```ts
+function motionSpringTime(motion, authored): number;
+```
+
+Scale an authored spring settle time by `--stipe-motion-spring-duration`.
+
+#### Parameters
+
+| Parameter  | Type                |
+| ---------- | ------------------- |
+| `motion`   | [`Motion`](#motion) |
+| `authored` | `number`            |
+
+#### Returns
+
+`number`
+
+---
+
+### motionEasing()
+
+```ts
+function motionEasing(motion, ease): string;
+```
+
+A CSS easing for a Web Animation, stepped when the theme asks for it.
+
+#### Parameters
+
+| Parameter | Type                |
+| --------- | ------------------- |
+| `motion`  | [`Motion`](#motion) |
+| `ease`    | `string`            |
+
+#### Returns
+
+`string`
+
+---
+
+### canAnimate()
+
+```ts
+function canAnimate(element): boolean;
+```
+
+Whether the element can run Web Animations (not in jsdom or old engines).
+
+#### Parameters
+
+| Parameter | Type      |
+| --------- | --------- |
+| `element` | `Element` |
+
+#### Returns
+
+`boolean`
+
+---
+
+### useReducedMotion()
+
+```ts
+function useReducedMotion(): boolean;
+```
+
+The live reduced-motion preference alone, for controls that only need to know
+whether to move (their timing comes from `readMotion` when they do).
+
+#### Returns
+
+`boolean`

package/docs/api/lib/reorder-motion.md

@@ -0,0 +1,46 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / lib/reorder-motion
+
+# lib/reorder-motion
+
+## Variables
+
+### reorderKeyAttribute
+
+```ts
+const reorderKeyAttribute: "data-reorder-key" = "data-reorder-key";
+```
+
+The attribute that names one keyed child of a list with list motion.
+
+## Functions
+
+### useListMotion()
+
+```ts
+function useListMotion(container, order): void;
+```
+
+Motion for a keyed list. Rows that arrive fade in over the theme's travel
+(staggered by `--stipe-motion-stagger`) once the list has unrolled to make room.
+A row that leaves fades where it stood first; then the rest close ranks, gliding
+to their places (FLIP on the Web Animations API) as the list eases to its new
+height. Everything reads the theme's motion tokens; reduced motion keeps only
+short fades and nothing travels. Children opt in with `data-reorder-key`, and
+the first render is still.
+
+#### Parameters
+
+| Parameter   | Type                                   |
+| ----------- | -------------------------------------- |
+| `container` | `RefObject`\<`HTMLElement` \| `null`\> |
+| `order`     | readonly `string`[]                    |
+
+#### Returns
+
+`void`

package/docs/api/lib/seed-hash.md

@@ -0,0 +1,31 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / lib/seed-hash
+
+# lib/seed-hash
+
+## Functions
+
+### seedHash()
+
+```ts
+function seedHash(seed): number;
+```
+
+A stable 32-bit FNV-1a hash: the same seed always lands on the same value, and
+short, similar seeds spread apart. Used to pick a deterministic tone, color, or
+pattern from an identity (a name, an Agent id) without state.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `seed`    | `string` |
+
+#### Returns
+
+`number`

package/docs/api/lib/tanstack-highlight.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) / lib/tanstack-highlight
+
+# lib/tanstack-highlight
+
+## Variables
+
+### highlightMarkdownCode
+
+```ts
+const highlightMarkdownCode: TanStackMarkdownHighlighter;
+```
+
+Highlights Markdown fences with the shared chat and document language set.
+
+## Functions
+
+### highlightToHtml()
+
+```ts
+function highlightToHtml(code, lang?): string;
+```
+
+Converts source code to escaped token spans for a code display.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `code`    | `string` |
+| `lang?`   | `string` |
+
+#### Returns
+
+`string`