Skip to content

Public Composables

@nhtio/lucid-resourceful-vue-components/composables

Utility hooks used across the library and available for your app. Many wrap IoC services (i18n, http, cache, scheduling, timezones); others are UI helpers for forms, slots, and fields.

Tip

Install the IoC plugin first (see Quickstart) so service-backed composables like useHttp, useI18n, useCache, useCron, and timezone utilities are available.

IoC and service accessors

  • useIoC — Access the IoC container (read/replace/mutate services).
  • useI18n — Get the translator service for localized messages.
  • useValidator — IoC-provided validation root. Note: different from useValidation below (UI helper).
  • useHttp — Normalized HTTP service (Resourceful encoding, adapters, middleware).
  • useCache — In-memory cache service for transient data.
  • useBrowser — Browser/environment introspection (platforms, features).

Scheduling (MilliCron)

  • useCron — Programmatic job scheduling.
  • useCronTab — Declarative cron tab registration & controls.

Timezone utilities

  • useTimezones — Timezone service access (zones/current/helpers).
  • useTimezoneZones — List of IANA zone identifiers.
  • useCurrentTimezone — Read/update active timezone.
  • useTimezoneOptions — Prebuilt select options (labels & offsets).

UX utilities

  • useAlert — Global alert / confirm / toast with icons & variants.
  • useClipboard — Clipboard copy with optional snackbar feedback.
  • useScopedDisplay — Container-scoped display/breakpoint helpers.
  • useHttpElements — UI building blocks for HTTP state (progress/error).
  • useValidation — UI-level validation utilities for forms/fields.
  • useBigNumberFormatter — Formatting for large / precise numbers.
  • useMountedInBrowser - A computed getter which returns true when the component has been mounted in a browser environment.

Field and slot helpers

  • useFieldComposer — Unified rendering logic (single/multiple/read).
  • useLocalState — Local field state helpers.
  • useSortableProps — Sortable props + drag/drop ordering helpers.
  • useFocus — Programmatic focus utilities.
  • useSlot — Safe slot handling & merging.
  • useProxiedModel — Computed v-model proxy (sync wrapper).

Event & hook helpers

  • usePassthroughHook — Build an event invoker that prefers bound handlers (onEvent props/attrs) and registered callOn<Event> hook arrays, and only then runs your fallback; supports debounce/throttle and immediate scheduling options. lucid-resourceful-vue-components/composables/type-aliases/UsePassthroughHookOptions)