Hooks
Reference

Hooks

The hooks used by Onset components, importable for building custom components.

Onset components use these hooks internally. They are exported so custom components can use the same behavior.

State

Controlled and uncontrolled prop pairs.

useControllableState

Controlled or internal state with change callbacks.

Overlay behavior

Dismissal, focus, and scroll locking for overlays.

useOverlay

Anchor and panel refs, open state, dismissal, and trigger ARIA attributes.

useDismiss

Outside-click and Escape dismissal, with an allow-list of refs that do not count as outside.

useEscapeKey

Runs a callback on Escape while enabled.

useScrollLock

Freezes background scroll while an overlay is open.

useFocusTrap

Keeps Tab inside a container, with initial focus and restore on close.

SSR

Rendering the same markup on server and first client paint.

useHydrated

False on the server and the first client render, true after hydration.

useIsomorphicLayoutEffect

useLayoutEffect on the client and useEffect on the server.

Refs & navigation

Ref merging and roving keyboard navigation.

useMergedRefs

Combines several refs into one callback ref.

useListNavigation

Arrow-key navigation state for menus and listboxes.

Pointer & layout

Reading pointer gestures, element sizes, and motion preferences.

useDrag

Pointer dragging with capture, cancellation, and listener cleanup.

useElementSize

An element's content-box size, tracked through resizes.

useReducedMotion

Whether the reader has asked for less motion, tracked live.

Forms

Reading the state a form group or field publishes.

useFormGroup

Reads the nearest FormGroup's shared tone, disabled, required, and id prefix.

useFieldInvalid

Tells a custom control whether its enclosing Field is in an error state.

Tiling

Editing a tile layout and reading the enclosing tile cell.

useMosaicLayout

Holds a MosaicGrid's layout, its undo history, and the add / remove / reset operations around it.

useMosaicTile

Cell dimensions of the enclosing MosaicTile.

Flows

Multi-step flow state without built-in UI.

useWizard

Wizard state, values, validation, completion, and navigation.

Virtualisation

Computing which rows to render for a given scroll offset.

useVirtualRange

Computes which rows to render for a given scroll offset.

Theming & portals

Reading and changing the resolved theme.

useTheme

Resolved theme values, configuration, and update functions.

usePortalContainer

Portal container within the current theme.

Toast & command palette

Imperative APIs owned by a provider.

useToast

Pushes and dismisses toasts from anywhere under a ToastProvider.

useCommandK

Binds Cmd/Ctrl+K to open a command palette.