@venizia/ardor-react 0.4.8-1 → 0.4.8-2

package/README.md

@@ -15,15 +15,14 @@ which re-exports this package.
 | Area | Exports |
 |---|---|
 | Context | `ApplicationContext`, `useApplicationContext`, `useApplicationLogger` |
-| Injection | `useInjectable` - resolve a binding by key or by class |
+| Injection | `useInjectable` - resolve a binding by key or by class; the artifact hooks `useApplicationContainer`, `useService`, `useProvider`, `useComponent`, `useConfiguration`, `useRepository` |
 | Redux | `DispatchHooks.create`, `SelectorHooks.create` - factories that bind your `RootState` and `AppDispatch` (the old `createAppDispatch` and `createAppSelectors` are removed; `bun run ardor codemod namespace` moves your code) |
-| UI hooks | `useDebounce`, `useAutosave`, `useConfirm`, `useBeforeUnload`, `useCopyToClipboard`, `useWindowDimensions` |
+| UI hooks | `useDebounce`, `useAutosave`, `useConfirm`, `useBeforeUnload`, `useCopyToClipboard`, `useWindowDimensions`, `useElementSize`, `useResizeEffect`, `useIntersection`, `useStoredState`, `useMediaQuery`, `useDocumentVisibility`, `useOnlineStatus` |
 | Types | `TUseInjectableKeys` |
 
 ## Typing your own binding keys
 
-`IUseInjectableKeysOverrides` is declared here, so augment this package - an interface merges only
-into the module that declares it, never through a re-export:
+`IUseInjectableKeysOverrides` is declared here, so augment this package when it is the one you depend on:
 
 ```typescript
 declare module '@venizia/ardor-react' {
@@ -33,6 +32,8 @@ declare module '@venizia/ardor-react' {
 }
 ```
 
+With `@venizia/ardor`, write `declare module '@venizia/ardor'` instead.
+
 ## License
 
 MIT - see [LICENSE.md](./LICENSE.md).

package/dist/contexts/application.d.ts

@@ -1,9 +1,13 @@
 import React from 'react';
 import type { Container } from '@venizia/ignis-inversion';
 import type { ILogger } from '@venizia/ignis-helpers/core';
+/** What `ApplicationContext` carries; both are `null` outside a provider. */
 export interface IApplicationContextValue {
+    /** The application's container. */
     container: Container | null;
+    /** The application's logger. */
     logger: ILogger | null;
 }
+/** Read through `useApplicationContext` and `useApplicationLogger`; the default value holds `null`s. */
 export declare const ApplicationContext: React.Context<IApplicationContextValue>;
 //# sourceMappingURL=application.d.ts.map

package/dist/contexts/application.js

@@ -1,4 +1,5 @@
 import React from 'react';
+/** Read through `useApplicationContext` and `useApplicationLogger`; the default value holds `null`s. */
 export const ApplicationContext = React.createContext({
     container: null,
     logger: null,

package/dist/hooks/redux/use-app-dispatch.d.ts

@@ -1,6 +1,10 @@
 import type { Dispatch, UnknownAction } from '@reduxjs/toolkit';
+/** Builds the typed dispatch hooks of a store. */
 export declare class DispatchHooks {
-    /** The typed dispatch hooks of a store: bind your `AppDispatch` once, and export what comes back. */
+    /**
+     * The typed dispatch hooks of a store: bind your `AppDispatch` once, and export what comes back.
+     * `useMultipleAppDispatch` returns a function that dispatches each action in order and skips falsy ones.
+     */
     static create<TDispatch extends Dispatch<UnknownAction> = Dispatch<UnknownAction>>(): {
         useAppDispatch: import("react-redux").UseDispatch<TDispatch>;
         useMultipleAppDispatch: () => (...actions: Parameters<TDispatch>[0][]) => void;

package/dist/hooks/redux/use-app-dispatch.js

@@ -1,7 +1,11 @@
 import React from 'react';
 import { useDispatch } from 'react-redux';
+/** Builds the typed dispatch hooks of a store. */
 export class DispatchHooks {
-    /** The typed dispatch hooks of a store: bind your `AppDispatch` once, and export what comes back. */
+    /**
+     * The typed dispatch hooks of a store: bind your `AppDispatch` once, and export what comes back.
+     * `useMultipleAppDispatch` returns a function that dispatches each action in order and skips falsy ones.
+     */
     static create() {
         const useAppDispatch = useDispatch.withTypes();
         const useMultipleAppDispatch = () => {

package/dist/hooks/resize-observation.d.ts

@@ -2,7 +2,7 @@
 export type TResizeBox = Exclude<ResizeObserverBoxOptions, 'device-pixel-content-box'>;
 export interface IResizeObservationOptions {
     box: TResizeBox;
-    /** Also observe the direct children of each target, and again whenever they change. */
+    /** Also observe the direct children of each target, and again whenever they change. @default false */
     children?: boolean;
     /** Called at most once per animation frame, with the latest entry of each element that resized. */
     onFrame: (entries: ResizeObserverEntry[]) => void;

package/dist/hooks/use-application-context.d.ts

@@ -1,3 +1,5 @@
+/** The application's `Container`. Throws when there is no `ApplicationContext` provider above. */
 export declare const useApplicationContext: () => import("@venizia/ignis-inversion").Container;
+/** The application's logger. Throws when there is no `ApplicationContext` provider above. */
 export declare const useApplicationLogger: () => import("@venizia/ignis-helpers/core").ILogger;
 //# sourceMappingURL=use-application-context.d.ts.map

package/dist/hooks/use-application-context.js

@@ -1,6 +1,7 @@
 import React from 'react';
 import { getError } from '@venizia/ignis-inversion';
 import { ApplicationContext } from '../contexts/application.js';
+/** The application's `Container`. Throws when there is no `ApplicationContext` provider above. */
 export const useApplicationContext = () => {
     const context = React.useContext(ApplicationContext);
     if (!context?.container) {
@@ -10,6 +11,7 @@ export const useApplicationContext = () => {
     }
     return context.container;
 };
+/** The application's logger. Throws when there is no `ApplicationContext` provider above. */
 export const useApplicationLogger = () => {
     const context = React.useContext(ApplicationContext);
     if (!context?.logger) {

package/dist/hooks/use-artifact.d.ts

@@ -2,19 +2,45 @@ import { type Container, type TClass } from '@venizia/ignis-inversion';
 import { type TUseInjectableKeys } from './use-injectable.js';
 /** By class: the return type is inferred from the target. */
 export interface IUseArtifactByTarget<TInstance> {
+    /** The container to resolve from. @default The application's container (`ApplicationContext`) */
     container?: Container;
+    /** The class to resolve; its recorded binding key is used. */
     target: TClass<TInstance>;
     key?: never;
 }
 /** By key: the caller supplies the type. */
 export interface IUseArtifactByKey {
+    /** The container to resolve from. @default The application's container (`ApplicationContext`) */
     container?: Container;
+    /** The binding key to resolve. */
     key: TUseInjectableKeys;
     target?: never;
 }
+/** Resolves the instance bound under the `service` namespace by `target` or `key`. A `target` bound under another namespace throws. */
 export declare const useService: <TInstance = unknown>(opts: IUseArtifactByTarget<TInstance> | IUseArtifactByKey) => TInstance;
+/** Resolves the instance bound under the `provider` namespace by `target` or `key`. A `target` bound under another namespace throws. */
 export declare const useProvider: <TInstance = unknown>(opts: IUseArtifactByTarget<TInstance> | IUseArtifactByKey) => TInstance;
+/** Resolves the instance bound under the `component` namespace by `target` or `key`. A `target` bound under another namespace throws. */
 export declare const useComponent: <TInstance = unknown>(opts: IUseArtifactByTarget<TInstance> | IUseArtifactByKey) => TInstance;
+/** Resolves the instance bound under the `configuration` namespace by `target` or `key`. A `target` bound under another namespace throws. */
 export declare const useConfiguration: <TInstance = unknown>(opts: IUseArtifactByTarget<TInstance> | IUseArtifactByKey) => TInstance;
+/**
+ * Resolves the instance bound under the `repository` namespace by `target` or `key`. A `target` bound under another namespace throws.
+ *
+ * @example
+ * ```tsx
+ * import { repository, useRepository } from '@venizia/ardor';
+ *
+ * @repository()
+ * class ProductRepository {
+ *   findStock(productId: string) { return productId ? 42 : 0; }
+ * }
+ *
+ * export function StockDisplay() {
+ *   const productRepository = useRepository({ target: ProductRepository });
+ *   return <span>Stock: {productRepository.findStock('p1')}</span>;
+ * }
+ * ```
+ */
 export declare const useRepository: <TInstance = unknown>(opts: IUseArtifactByTarget<TInstance> | IUseArtifactByKey) => TInstance;
 //# sourceMappingURL=use-artifact.d.ts.map

package/dist/hooks/use-artifact.js

@@ -22,26 +22,48 @@ const useArtifactInNamespace = (opts) => {
     }
     return useInjectable(options);
 };
+/** Resolves the instance bound under the `service` namespace by `target` or `key`. A `target` bound under another namespace throws. */
 export const useService = (opts) => useArtifactInNamespace({
     options: opts,
     namespace: BindingNamespaces.SERVICE,
     hook: 'useService',
 });
+/** Resolves the instance bound under the `provider` namespace by `target` or `key`. A `target` bound under another namespace throws. */
 export const useProvider = (opts) => useArtifactInNamespace({
     options: opts,
     namespace: BindingNamespaces.PROVIDER,
     hook: 'useProvider',
 });
+/** Resolves the instance bound under the `component` namespace by `target` or `key`. A `target` bound under another namespace throws. */
 export const useComponent = (opts) => useArtifactInNamespace({
     options: opts,
     namespace: BindingNamespaces.COMPONENT,
     hook: 'useComponent',
 });
+/** Resolves the instance bound under the `configuration` namespace by `target` or `key`. A `target` bound under another namespace throws. */
 export const useConfiguration = (opts) => useArtifactInNamespace({
     options: opts,
     namespace: BindingNamespaces.CONFIGURATION,
     hook: 'useConfiguration',
 });
+/**
+ * Resolves the instance bound under the `repository` namespace by `target` or `key`. A `target` bound under another namespace throws.
+ *
+ * @example
+ * ```tsx
+ * import { repository, useRepository } from '@venizia/ardor';
+ *
+ * @repository()
+ * class ProductRepository {
+ *   findStock(productId: string) { return productId ? 42 : 0; }
+ * }
+ *
+ * export function StockDisplay() {
+ *   const productRepository = useRepository({ target: ProductRepository });
+ *   return <span>Stock: {productRepository.findStock('p1')}</span>;
+ * }
+ * ```
+ */
 export const useRepository = (opts) => useArtifactInNamespace({
     options: opts,
     namespace: BindingNamespaces.REPOSITORY,

package/dist/hooks/use-autosave.d.ts

@@ -1,11 +1,18 @@
 export interface IUseAutosaveOptions<TData, TReturn> {
+    /** The value to save; a change starts the `interval` wait. */
     data: TData;
+    /** Called with the latest `data` once it has been still for `interval`. A rejection is logged, not thrown. */
     onSave: (data: TData) => Promise<TReturn> | TReturn | void;
     /** @default 2000 */
     interval?: number;
+    /** Save the latest `data` on unmount. */
     enableSaveOnUnmount?: boolean;
     /** @default true */
     enabled?: boolean;
 }
+/**
+ * Calls `onSave` with `data` after it has stopped changing for `interval` milliseconds. The first
+ * render does not save. The latest `onSave` is always the one called.
+ */
 export declare const useAutosave: <TData, TReturn>(opts: IUseAutosaveOptions<TData, TReturn>) => void;
 //# sourceMappingURL=use-autosave.d.ts.map

package/dist/hooks/use-autosave.js

@@ -2,6 +2,10 @@ import React from 'react';
 import { LoggerFactory } from '@venizia/ignis-helpers/core';
 import { useDebounce } from './use-debounce.js';
 const logger = LoggerFactory.getLogger(['useAutosave']);
+/**
+ * Calls `onSave` with `data` after it has stopped changing for `interval` milliseconds. The first
+ * render does not save. The latest `onSave` is always the one called.
+ */
 export const useAutosave = (opts) => {
     const { data, onSave, interval = 2000, enableSaveOnUnmount, enabled = true } = opts;
     const valueOnCleanup = React.useRef(data);

package/dist/hooks/use-before-unload.d.ts

@@ -1,7 +1,9 @@
 export interface IUseBeforeUnloadOptions {
     /** @default true */
     enabled?: boolean;
+    /** Set as the `returnValue` of the event; browsers may show their own text instead. */
     message?: string;
 }
+/** While `enabled`, asks the browser to confirm before the page is left or reloaded. */
 export declare const useBeforeUnload: (opts: IUseBeforeUnloadOptions) => void;
 //# sourceMappingURL=use-before-unload.d.ts.map

package/dist/hooks/use-before-unload.js

@@ -1,4 +1,5 @@
 import React from 'react';
+/** While `enabled`, asks the browser to confirm before the page is left or reloaded. */
 export const useBeforeUnload = (opts) => {
     const { enabled = true, message } = opts;
     const handleBeforeUnload = React.useCallback((event) => {

package/dist/hooks/use-confirm.d.ts

@@ -1,11 +1,17 @@
 export interface IUseConfirmReturn {
+    /** The pending prompt text; `undefined` when none is open. */
     message?: string;
+    /** Opens a prompt. Resolves `true` on `handleConfirm`, `false` on `handleAbort` or when another `confirm` replaces it. */
     confirm: (opts: {
         message: string;
     }) => Promise<boolean>;
+    /** Closes the prompt without settling it. */
     handleClose: () => void;
+    /** Resolves the pending `confirm` with `true` and closes. */
     handleConfirm: () => void;
+    /** Resolves the pending `confirm` with `false` and closes. */
     handleAbort: () => void;
 }
+/** State for a confirmation prompt: `confirm` returns a promise that the prompt's buttons settle. */
 export declare const useConfirm: () => IUseConfirmReturn;
 //# sourceMappingURL=use-confirm.d.ts.map

package/dist/hooks/use-confirm.js

@@ -1,4 +1,5 @@
 import React from 'react';
+/** State for a confirmation prompt: `confirm` returns a promise that the prompt's buttons settle. */
 export const useConfirm = () => {
     const settle = React.useRef(undefined);
     const [message, setMessage] = React.useState();

package/dist/hooks/use-copy-to-clipboard.d.ts

@@ -10,5 +10,18 @@ export interface IUseCopyToClipboardReturn {
     /** The result of the last copy, until `resetMs` has passed. */
     isCopied: boolean;
 }
+/**
+ * Copies text with `BrowserClipboard`; `isCopied` is the result of the last copy.
+ *
+ * @example
+ * ```tsx
+ * import { useCopyToClipboard } from '@venizia/ardor';
+ *
+ * export function CopyButton() {
+ *   const { copy, isCopied } = useCopyToClipboard({ resetMs: 2000 });
+ *   return <button onClick={() => copy({ value: 'hello' })}>{isCopied ? 'Copied' : 'Copy'}</button>;
+ * }
+ * ```
+ */
 export declare const useCopyToClipboard: (opts?: IUseCopyToClipboardOptions) => IUseCopyToClipboardReturn;
 //# sourceMappingURL=use-copy-to-clipboard.d.ts.map

package/dist/hooks/use-copy-to-clipboard.js

@@ -10,6 +10,19 @@ const copyToClipboard = async (opts) => {
     }
     return isCopied;
 };
+/**
+ * Copies text with `BrowserClipboard`; `isCopied` is the result of the last copy.
+ *
+ * @example
+ * ```tsx
+ * import { useCopyToClipboard } from '@venizia/ardor';
+ *
+ * export function CopyButton() {
+ *   const { copy, isCopied } = useCopyToClipboard({ resetMs: 2000 });
+ *   return <button onClick={() => copy({ value: 'hello' })}>{isCopied ? 'Copied' : 'Copy'}</button>;
+ * }
+ * ```
+ */
 export const useCopyToClipboard = (opts = {}) => {
     const { resetMs = 0 } = opts;
     const [isCopied, setCopied] = React.useState(false);

package/dist/hooks/use-debounce.d.ts

@@ -1,11 +1,15 @@
 export interface IUseDebounceOptions<TValue> {
+    /** The value to follow; the output changes once it has been still for `delay`. */
     value: TValue;
+    /** Milliseconds to wait after the last change. @default 500 */
     delay?: number;
     /** @default true */
     enabled?: boolean;
 }
 export interface IUseDebounceReturn<TValue> {
+    /** The last `value` that stayed unchanged for `delay`; the first `value` until then. */
     debouncedValue: TValue;
 }
+/** Follows `value` after it has stopped changing for `delay`. Outside a browser, or when not `enabled`, it never updates. */
 export declare const useDebounce: <TValue>(opts: IUseDebounceOptions<TValue>) => IUseDebounceReturn<TValue>;
 //# sourceMappingURL=use-debounce.d.ts.map

package/dist/hooks/use-debounce.js

@@ -1,5 +1,6 @@
 import React from 'react';
 import { App, BrowserUtility } from '@venizia/ardor-kernel';
+/** Follows `value` after it has stopped changing for `delay`. Outside a browser, or when not `enabled`, it never updates. */
 export const useDebounce = (opts) => {
     const { value, delay, enabled = true } = opts;
     const [debouncedValue, setDebouncedValue] = React.useState(value);

package/dist/hooks/use-element-size.d.ts

@@ -15,6 +15,7 @@ export interface IUseElementSizeReturn {
     measured: boolean;
 }
 export interface IUseElementSizeRefReturn extends IUseElementSizeReturn {
+    /** Give it to the element to measure. */
     ref: React.RefCallback<Element>;
 }
 /**
@@ -24,6 +25,16 @@ export interface IUseElementSizeRefReturn extends IUseElementSizeReturn {
  * is read when the effect runs, so it follows a new `ref`, `box` or `round`, not a `ref.current`
  * that is replaced later; pass a stable `ref`. A new element, `box` or `round` starts again from
  * 0 by 0 with `measured` false.
+ *
+ * @example
+ * ```tsx
+ * import { useElementSize } from '@venizia/ardor';
+ *
+ * export function Panel() {
+ *   const { ref, width, height, measured } = useElementSize();
+ *   return <div ref={ref}>{measured ? `${width} x ${height}` : '...'}</div>;
+ * }
+ * ```
  */
 export declare function useElementSize(opts: IUseElementSizeOptions & {
     ref: React.RefObject<Element | null>;

package/dist/hooks/use-injectable.d.ts

@@ -1,14 +1,31 @@
 import { type Container, type TClass } from '@venizia/ignis-inversion';
 import type { CoreBindings, ValueOf } from '@venizia/ardor-kernel';
+/** Declaration-merge string keys into this interface to make them valid `key` values of the injectable hooks. */
 export interface IUseInjectableKeysOverrides {
 }
+/** The binding keys the kernel defines (the string values of `CoreBindings`). */
 export type TUseInjectableKeysDefault = Extract<ValueOf<typeof CoreBindings>, string>;
+/** A key the injectable hooks accept: a kernel binding key or one added to `IUseInjectableKeysOverrides`. */
 export type TUseInjectableKeys = TUseInjectableKeysDefault | keyof IUseInjectableKeysOverrides;
+/**
+ * Resolve by `key` or by `target` class, never both.
+ *
+ * @example
+ * ```ts
+ * import { CoreBindings, type TUseInjectableOptions } from '@venizia/ardor';
+ *
+ * const byKey: TUseInjectableOptions = { key: CoreBindings.DEFAULT_REST_DATA_PROVIDER };
+ * class Greeter {}
+ * const byTarget: TUseInjectableOptions = { target: Greeter };
+ * ```
+ */
 export type TUseInjectableOptions = {
+    /** The container to resolve from. @default The application's container (`ApplicationContext`) */
     container?: Container;
     key: TUseInjectableKeys;
     target?: never;
 } | {
+    /** The container to resolve from. @default The application's container (`ApplicationContext`) */
     container?: Container;
     key?: never;
     target: TClass<unknown>;
@@ -16,9 +33,23 @@ export type TUseInjectableOptions = {
 /**
  * The container an injectable hook resolves from: the one passed in, else the application's. Shared,
  * so a hook never checks one container and resolves from another.
+ *
+ * @example
+ * ```tsx
+ * import { CoreBindings, useApplicationContainer } from '@venizia/ardor';
+ *
+ * export function BindingCheck() {
+ *   const container = useApplicationContainer();
+ *   return <span>{container.isBound({ key: CoreBindings.DEFAULT_REST_DATA_PROVIDER }) ? 'bound' : 'unbound'}</span>;
+ * }
+ * ```
  */
 export declare const useApplicationContainer: (opts?: {
     container?: Container;
 }) => Container;
+/**
+ * Resolves an instance from the container by `key` or by `target` class. Throws when the key is not
+ * bound, when the class has no recorded binding key, or when neither `key` nor `target` is given.
+ */
 export declare const useInjectable: <TInstance>(opts: TUseInjectableOptions) => TInstance;
 //# sourceMappingURL=use-injectable.d.ts.map

package/dist/hooks/use-injectable.js

@@ -4,6 +4,16 @@ import { ApplicationContext } from '../contexts/application.js';
 /**
  * The container an injectable hook resolves from: the one passed in, else the application's. Shared,
  * so a hook never checks one container and resolves from another.
+ *
+ * @example
+ * ```tsx
+ * import { CoreBindings, useApplicationContainer } from '@venizia/ardor';
+ *
+ * export function BindingCheck() {
+ *   const container = useApplicationContainer();
+ *   return <span>{container.isBound({ key: CoreBindings.DEFAULT_REST_DATA_PROVIDER }) ? 'bound' : 'unbound'}</span>;
+ * }
+ * ```
  */
 export const useApplicationContainer = (opts) => {
     const applicationContext = React.useContext(ApplicationContext);
@@ -15,6 +25,10 @@ export const useApplicationContainer = (opts) => {
     }
     return container;
 };
+/**
+ * Resolves an instance from the container by `key` or by `target` class. Throws when the key is not
+ * bound, when the class has no recorded binding key, or when neither `key` nor `target` is given.
+ */
 export const useInjectable = (opts) => {
     const container = useApplicationContainer({ container: opts?.container });
     const { key, target } = opts;

package/dist/hooks/use-intersection.d.ts

@@ -4,13 +4,25 @@ export interface IUseIntersectionOptions {
     target: TElementTarget;
     /** @default '0px' */
     rootMargin?: string;
-    /** The ratio of the element in view at which an entry is delivered. @default 0 */
+    /** The ratio of the element in view at which an entry is delivered; a single number, not an array. @default 0 */
     threshold?: number;
 }
 /**
  * The latest `IntersectionObserverEntry` of the target, or `undefined` before the first one and
  * where there is no `IntersectionObserver`. The state changes only when `isIntersecting` or the
  * ratio changed. A new element, `rootMargin` or `threshold` starts again from `undefined`.
+ *
+ * @example
+ * ```tsx
+ * import React from 'react';
+ * import { useIntersection } from '@venizia/ardor';
+ *
+ * export function Lazy() {
+ *   const ref = React.useRef<HTMLDivElement>(null);
+ *   const entry = useIntersection({ target: ref, threshold: 0.5 });
+ *   return <div ref={ref}>{entry?.isIntersecting ? 'visible' : 'hidden'}</div>;
+ * }
+ * ```
  */
 export declare const useIntersection: (opts: IUseIntersectionOptions) => IntersectionObserverEntry | undefined;
 //# sourceMappingURL=use-intersection.d.ts.map

package/dist/hooks/use-intersection.js

@@ -4,6 +4,18 @@ import { ElementTargets } from './element-target.js';
  * The latest `IntersectionObserverEntry` of the target, or `undefined` before the first one and
  * where there is no `IntersectionObserver`. The state changes only when `isIntersecting` or the
  * ratio changed. A new element, `rootMargin` or `threshold` starts again from `undefined`.
+ *
+ * @example
+ * ```tsx
+ * import React from 'react';
+ * import { useIntersection } from '@venizia/ardor';
+ *
+ * export function Lazy() {
+ *   const ref = React.useRef<HTMLDivElement>(null);
+ *   const entry = useIntersection({ target: ref, threshold: 0.5 });
+ *   return <div ref={ref}>{entry?.isIntersecting ? 'visible' : 'hidden'}</div>;
+ * }
+ * ```
  */
 export const useIntersection = (opts) => {
     const { target, rootMargin, threshold } = opts;

package/dist/hooks/use-resize-effect.d.ts

@@ -14,6 +14,18 @@ export interface IUseResizeEffectOptions {
  * Calls `onResize` at most once per animation frame when any of the targets resizes. A new
  * `onResize` is used without observing again, and the targets are read after every render, so an
  * element held in state, a ref whose element changed and a list that grows or shrinks are followed.
+ *
+ * @example
+ * ```tsx
+ * import React from 'react';
+ * import { useResizeEffect } from '@venizia/ardor';
+ *
+ * export function Panel() {
+ *   const ref = React.useRef<HTMLDivElement>(null);
+ *   useResizeEffect({ targets: [ref], onResize: (entries) => console.log(entries.length) });
+ *   return <div ref={ref} />;
+ * }
+ * ```
  */
 export declare const useResizeEffect: (opts: IUseResizeEffectOptions) => void;
 //# sourceMappingURL=use-resize-effect.d.ts.map

package/dist/hooks/use-resize-effect.js

@@ -5,6 +5,18 @@ import { ResizeObservation } from './resize-observation.js';
  * Calls `onResize` at most once per animation frame when any of the targets resizes. A new
  * `onResize` is used without observing again, and the targets are read after every render, so an
  * element held in state, a ref whose element changed and a list that grows or shrinks are followed.
+ *
+ * @example
+ * ```tsx
+ * import React from 'react';
+ * import { useResizeEffect } from '@venizia/ardor';
+ *
+ * export function Panel() {
+ *   const ref = React.useRef<HTMLDivElement>(null);
+ *   useResizeEffect({ targets: [ref], onResize: (entries) => console.log(entries.length) });
+ *   return <div ref={ref} />;
+ * }
+ * ```
  */
 export const useResizeEffect = (opts) => {
     const { targets, onResize, box = 'content-box', children = false } = opts;

package/dist/hooks/use-stored-state.d.ts

@@ -1,17 +1,22 @@
 import { type IStorageCodec, type TStorageArea } from '@venizia/ardor-kernel';
 export interface IUseStoredStateOptions<TValue> {
+    /** The storage key. */
     key: string;
+    /** The value while the key holds nothing. */
     defaultValue: TValue;
     /** @default 'local' */
     storage?: TStorageArea;
     /** @default JSON */
     codec?: IStorageCodec<TValue>;
-    /** Write storage once, this many milliseconds after the last `setValue`; `value` changes at once. @default 0 */
+    /** Write storage once, this many milliseconds after the last `setValue`; `value` changes at once. Above 0, also pass a stable `codec`. @default 0 */
     writeDelayMs?: number;
 }
 export interface IUseStoredStateReturn<TValue> {
+    /** The stored value, or `defaultValue` when the key holds nothing. */
     value: TValue;
+    /** Stores a value, or the result of an updater called with the current one. */
     setValue: (next: TValue | ((current: TValue) => TValue)) => void;
+    /** Removes the key, so `value` is `defaultValue` again. */
     remove: () => void;
 }
 export interface IUseStoredState {
@@ -28,6 +33,16 @@ export interface IUseStoredState {
  * A write or a removal that the storage refuses is kept in this hook until the storage next changes.
  * With `writeDelayMs` the value waits in the same place for the delay: a change of the storage from
  * outside drops it, and an unmount or a new key or storage writes it at once.
+ *
+ * @example
+ * ```tsx
+ * import { useStoredState } from '@venizia/ardor';
+ *
+ * export function ThemeToggle() {
+ *   const { value, setValue } = useStoredState({ key: 'theme', defaultValue: 'light' });
+ *   return <button onClick={() => setValue(value === 'light' ? 'dark' : 'light')}>{value}</button>;
+ * }
+ * ```
  */
 export declare const useStoredState: IUseStoredState;
 //# sourceMappingURL=use-stored-state.d.ts.map

package/dist/hooks/use-stored-state.js

@@ -8,6 +8,16 @@ const isUpdater = (next) => typeof next === 'function';
  * A write or a removal that the storage refuses is kept in this hook until the storage next changes.
  * With `writeDelayMs` the value waits in the same place for the delay: a change of the storage from
  * outside drops it, and an unmount or a new key or storage writes it at once.
+ *
+ * @example
+ * ```tsx
+ * import { useStoredState } from '@venizia/ardor';
+ *
+ * export function ThemeToggle() {
+ *   const { value, setValue } = useStoredState({ key: 'theme', defaultValue: 'light' });
+ *   return <button onClick={() => setValue(value === 'light' ? 'dark' : 'light')}>{value}</button>;
+ * }
+ * ```
  */
 export const useStoredState = (opts) => {
     const { key, defaultValue, storage, codec, writeDelayMs = 0 } = opts;

package/dist/hooks/use-window-dimensions.d.ts

@@ -1,3 +1,4 @@
+/** The window's `innerWidth` and `innerHeight`, updated on resize; 0 x 0 where there is no window. */
 export declare const useWindowDimensions: () => {
     width: number;
     height: number;

package/dist/hooks/use-window-dimensions.js

@@ -6,6 +6,7 @@ const readWindowDimensions = () => {
         ? { width: window.innerWidth, height: window.innerHeight }
         : { width: 0, height: 0 };
 };
+/** The window's `innerWidth` and `innerHeight`, updated on resize; 0 x 0 where there is no window. */
 export const useWindowDimensions = () => {
     const [windowDimensions, setWindowDimensions] = React.useState(readWindowDimensions);
     React.useEffect(() => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@venizia/ardor-react",
-  "version": "0.4.8-1",
-  "description": "ARDOR React bindings - the application context, the injectable and logger hooks that read it, typed Redux hook factories, and the framework-agnostic UI hooks (debounce, autosave, confirm, clipboard, sizer, window dimensions). No react-admin.",
+  "version": "0.4.8-2",
+  "description": "ARDOR React bindings - the application context, the injectable and logger hooks that read it, typed Redux hook factories, and the framework-agnostic UI hooks (debounce, autosave, confirm, clipboard, element size, window dimensions). No react-admin.",
   "keywords": [
     "ardor",
     "ardor-react",
@@ -59,7 +59,7 @@
     "prepublishOnly": "make rebuild"
   },
   "dependencies": {
-    "@venizia/ardor-kernel": "0.4.8-1"
+    "@venizia/ardor-kernel": "0.4.8-2"
   },
   "devDependencies": {
     "@happy-dom/global-registrator": "^21.0.4",
@@ -69,11 +69,11 @@
     "@types/bun": "^1.4.3",
     "@types/react": "^19",
     "@types/react-dom": "^19",
-    "@venizia/dev-configs": "^0.4.8-0",
-    "@venizia/ignis-filter": "^0.4.7-0",
-    "@venizia/ignis-helpers": "^0.4.8-0",
-    "@venizia/ignis-inversion": "^0.4.7-0",
-    "@venizia/ignis-kernel": "^0.4.8-0",
+    "@venizia/dev-configs": "^0.4.8-1",
+    "@venizia/ignis-filter": "^0.4.7-1",
+    "@venizia/ignis-helpers": "^0.4.8-1",
+    "@venizia/ignis-inversion": "^0.4.7-1",
+    "@venizia/ignis-kernel": "^0.4.8-1",
     "eslint": "^10.13.0",
     "oxlint": "1.89.0",
     "oxlint-tsgolint": "7.0.2004",
@@ -87,10 +87,10 @@
   },
   "peerDependencies": {
     "@reduxjs/toolkit": ">=2.13.0",
-    "@venizia/ignis-filter": "^0.4.7-0",
-    "@venizia/ignis-helpers": "^0.4.8-0",
-    "@venizia/ignis-inversion": "^0.4.7-0",
-    "@venizia/ignis-kernel": "^0.4.8-0",
+    "@venizia/ignis-filter": "^0.4.7-1",
+    "@venizia/ignis-helpers": "^0.4.8-1",
+    "@venizia/ignis-inversion": "^0.4.7-1",
+    "@venizia/ignis-kernel": "^0.4.8-1",
     "react": ">=19.3.1",
     "react-redux": ">=9.3.0",
     "reflect-metadata": ">=0.2.2"