@nhtio/lucid-resourceful-vue-components/composables
Composables provided by the @nhtio/lucid-resourceful-vue-components package.
Interfaces
| Interface | Description |
|---|---|
| AlertOptions | - |
| AlertResult | - |
| BigNumberFormatter | Numeral.js-compatible formatter for Big.js numbers Supports common numeral.js format patterns for arbitrarily large numbers |
| BrowserService | TypeScript interface defining the complete structure and capabilities of the browser detection service. |
| EmitWithUpdateModelValue | - |
| I18nTranslator | - |
| ResourcefulHttpHeaders | - |
| ResourcefulHttpProgress | - |
| ResourcefulHttpRequestOptions | - |
| ResourcefulHttpResponse | - |
| ResourcefulHttpService | - |
| ResourcefulMemoryCache | - |
| ResourcefulTimezone | - |
| ResourcefulTimezoneInformation | - |
| ResourcefulTimezoneOption | - |
| ValidationRoot | Extended Joi root interface that includes custom schema types for additional validation scenarios. |
| VNode | - |
Type Aliases
| Type Alias | Description |
|---|---|
| AlertIcon | - |
| ClipboardComposableOptions | - |
| CommonResourcefulFieldPublicProps | - |
| ComponentPublicInstance | - |
| FireAlertFn | - |
| LocalStateModelValue | - |
| MaybePromised | - |
| MaybeRef | - |
| RawSortableOptions | Type alias for the raw, unmodified SortableJS options interface. This represents the complete SortableJS options as provided by the library, including all event handlers and internal options that may conflict with Vue. |
| ReferencedContainer | - |
| Renderable | Valid Vue render function component types (string, component, or function). |
| RenderableProps | Props that can be passed to the rendered component element. |
| ResourcefulHttpMethod | - |
| ResourcefulHttpMethod | - |
| RFieldStringifier | A function type that converts any value into a string or VNode representation for display purposes. This is the core abstraction that makes all Resourceful field components generic and reusable across different data types. |
| SingleFieldRenderer | - |
| SingleVariantPropBindings | Prop bindings passed to the single-variant slot for adding individual items. These props provide v-model functionality to the slot content, allowing it to manage the temporary state of a new item being added. |
| SingleVariantSlotArgs | Arguments passed to the single-variant slot function. The slot receives an object with props for v-model binding and an add function to commit the current value to the multiple selection. |
| SortableCtor | Type alias for the SortableJS constructor. Useful for type annotations when working with the SortableJS instance directly. |
| SortableEvent | - |
| SortableInstance | Type representing an instance of a SortableJS sortable list. This type provides access to all SortableJS instance methods and properties for programmatic control of the sortable behavior. |
| SortableMoveEvent | - |
| SortableOptions | Combined SortableJS options from the core library, excluding Vue-incompatible options. This type ensures type safety while maintaining compatibility with Vue's prop system by removing event handlers and internal options that would conflict with Vue's reactivity. |
| TernaryOperator | - |
| UsePassthroughHookOptions | Options for usePassthroughHook that control when and how a fallback is executed and how the produced handler is scheduled. |
| ValidationProps | - |
| VImgPublicProps | - |
| VSnackbarPublicProps | - |
Functions
| Function | Description |
|---|---|
| useAlert | - |
| useBigNumberFormatter | Vue composable for BigNumberFormatter |
| useBrowser | - |
| useCache | - |
| useClipboard | Vue composable for clipboard operations with integrated visual feedback via Vuetify snackbars. |
| useCron | - |
| useCronTab | - |
| useCurrentTimezone | - |
| useFieldComposer | A sophisticated composable that unifies field rendering across three operational modes: single field editing, multiple selection management, and read-only display. |
| useFocus | - |
| useHttp | - |
| useHttpElements | - |
| useI18n | - |
| useIoC | - |
| useLocalState | - |
| useMountedInBrowser | - |
| usePassthroughHook | Builds an event invoker that respects component-bound handlers and hook arrays before calling a fallback. |
| useProxiedModel | - |
| useScopedDisplay | - |
| useSlot | - |
| useSortableProps | - |
| useTimezoneOptions | - |
| useTimezones | - |
| useTimezoneZones | - |
| useValidation | Enterprise-grade form validation composable that bridges Joi schemas with VeeValidate and Vuetify. Provides comprehensive form state management, validation, and field binding generation. |
| useValidator | - |