@orvain/utils

Small shared helpers and types used across the Orvain Design System packages.

Commercial software. See LICENSE — use is governed by your agreement with Orvain Labs.

This is an internal support package, published because @orvain/react and @orvain/vue depend on it. It is not a general-purpose utility library and its surface may change between minors. Prefer a dedicated library for anything you need in application code.

Install

npm install @orvain/utils

Exports

import { clamp, cx, omit, typedEntries, generateId, announce, trapFocus } from '@orvain/utils';

| Export | Signature | Notes | |---|---|---| | clamp | (value, min, max) => number | inclusive | | cx | (...classes) => string | joins truthy class strings | | omit | (obj, keys) => Omit<T, K> | for prop forwarding | | typedEntries | (obj) => [keyof T, T[keyof T]][] | Object.entries with inferred keys | | generateId | (prefix?) => string | module-scoped counter — see Caveats | | getFocusableElements | (container) => HTMLElement[] | | | trapFocus | (container) => cleanup | cycles Tab within container | | announce | (message, politeness?) => void | writes to a shared aria-live region | | Size, Variant, Intent, ColorScheme | type aliases | shared prop vocabularies |

Caveats

• generateId is not SSR-safe. It increments a module-level counter, so server and client can disagree and hydration will mismatch. Use React's useId or Vue's useId instead; generateId is for non-component code.
• trapFocus does not restore focus when it tears down, and does not move focus into the container on setup. You need to handle both yourself.
• announce and trapFocus touch document and must only run in the browser.

Related packages

• @orvain/react, @orvain/vue — the component libraries