@nhtio/lucid-resourceful-vue-components/components
All components provided by the @nhtio/lucid-resourceful-vue-components package.
Namespaces
| Namespace | Description |
|---|---|
| OpenAPIV3 | - |
Interfaces
Type Aliases
| Type Alias | Description |
|---|---|
| ActionableRecord | - |
| BaseResourcefulRecordProps | - |
| BulkActionResults | - |
| ColorValue | - |
| ComputedColumnDefinition | - |
| ComputedColumnDefinitions | - |
| ControlButton | - |
| ControlButtonBar | Component instance type for ControlButtonBar. |
| ControlButtonBarJustification | Type for button justification alignment. |
| ControlButtonBarOptionsProps | - |
| ControlButtonBarOverflowMenuButtonProps | Props interface for customizing the overflow menu button appearance and behavior. |
| ControlButtonBarProps | Props interface for the ControlButtonBar component. |
| ControlButtonBarSlots | Slot types for the ControlButtonBar component. |
| ControlButtonOverrideProps | - |
| ControlButtonProps | - |
| ControlMenu | - |
| ControlMenuControlButtonProps | - |
| ControlMenuProps | - |
| DataTypeOf | Utility type that extracts the TypeScript type from a Joi schema. Used to ensure type safety between schema definitions and form values. |
| DefinedField | Type definition for VeeValidate defined fields |
| Exporter | - |
| ExportFormat | - |
| ExportOptions | - |
| ExportScope | - |
| FetchViaAsyncIteratorFn | - |
| FieldOverrideProps | - |
| FieldSpecificOverrideOptions | - |
| FieldValueFormatter | - |
| FieldValueFormatters | - |
| FilterGroup | - |
| FormWithValidation | Type definition for FormWithValidation component instance. Combines the component instance with Vue's ComponentPublicInstance for full type safety. |
| FormWithValidationDefaultSlotProps | Props provided to the default slot of FormWithValidation component. Contains all validation state and field binding utilities except form-level bindings. |
| FormWithValidationProps | Props interface for the FormWithValidation component. Extracted from the component's prop factory for type safety. |
| FormWithValidationSlots | Slot definitions for the FormWithValidation component. Default slot receives validation props and scoped display utilities. |
| GeneralFieldOverrideOptions | - |
| HookHandler | Shape of the hook handler function. |
| JoiSchemaPropType | - |
| MaybePromise | Utility type for values that can be synchronous or asynchronous |
| PropType | - |
| RBigIntField | - |
| RBigIntFieldProps | Type definition for RBigIntField component props. |
| RBigIntFieldValue | Represents the value types that can be handled by RBigIntField. |
| RBooleanField | Component type for the RBooleanField. Represents the complete boolean/ternary field component with configurable logic support, multiple rendering variants, and unified field architecture integration. Use this type for component references, template refs, and programmatic component manipulation. |
| RBooleanFieldProps | Public props interface for the RBooleanField component. Includes all VInput props plus boolean/ternary field-specific options for configurable logic, rendering variants, icon customization, and unified field architecture features. |
| RBooleanFieldRenderable | Union type for boolean field rendering variants. Used for the renderAs prop to specify which UI control should be used for boolean or ternary value interaction. |
| RBooleanFieldValue | Union type of all supported boolean/ternary field values. Use this type for props, function parameters, or conditional logic based on boolean or ternary state. |
| RCustomField | Type definition for the RCustomField component constructor. |
| RCustomFieldBusEventMap | Event map type for the RCustomField event bus system. |
| RCustomFieldDefaultSlotProps | Props object passed to custom field implementations via the default slot. |
| RCustomFieldInputSlotArg | Complete argument object passed to the default slot of RCustomField. |
| RCustomFieldProps | Type definition for RCustomField component props. |
| RCustomFieldSlots | Slot definitions for RCustomField component. |
| RDateField | - |
| RDateFieldProps | Type definition for RDateField component props. |
| RDateTimeField | Type definition for the RDateTimeField component constructor. |
| RDateTimeFieldDisplayFormat | Type representing the available display format options for datetime rendering. |
| RDateTimeFieldProps | Type definition for RDateTimeField component props. |
| REnumField | Component type for the REnumField. Represents the complete enum field component with dynamic choice loading support, multiple rendering variants, and unified field architecture integration. Use this type for component references, template refs, and programmatic component manipulation. |
| REnumFieldLoadedChoice | - |
| REnumFieldProps | Public props interface for the REnumField component. Includes all VInput props plus enum field-specific options for dynamic choice loading, rendering variants, icon customization, and unified field architecture features. |
| REnumFieldRenderable | Union type for enum field rendering variants. Used for the renderAs prop to specify which UI control should be used for enum value interaction. |
| REnumFieldValue | Supported enum field values representing any enumerable type. Includes string for text-based enums (most common), number for numeric status codes or identifiers, and bigint for high-precision scenarios requiring large integer enum values. |
| ResourcefulAggregateMethods | - |
| ResourcefulAlerter | - |
| ResourcefulIndex | - |
| ResourcefulIndexActionCallback | - |
| ResourcefulIndexActionIsActionableValidator | - |
| ResourcefulIndexBulkActionCallback | - |
| ResourcefulIndexCompleteCallback | - |
| ResourcefulIndexFailureCallback | - |
| ResourcefulIndexProgressCallback | - |
| ResourcefulIndexProps | - |
| ResourcefulIndexSlots | - |
| ResourcefulIndexSuccessCallback | - |
| ResourcefulIndexTableSlots | - |
| ResourcefulIndexTernaryOperator | - |
| ResourcefulIndexUndeterminedCallback | - |
| ResourcefulRecord | - |
| ResourcefulRecordActionCallback | - |
| ResourcefulRecordActionIsActionableValidator | - |
| ResourcefulRecordAdvancedOptions | - |
| ResourcefulRecordBusEventMap | - |
| ResourcefulRecordChangeStateDirtyHookHandler | - |
| ResourcefulRecordChangeStateErrorBagHookHandler | - |
| ResourcefulRecordChangeStateErrorsHookHandler | - |
| ResourcefulRecordChangeStatePendingHookHandler | - |
| ResourcefulRecordChangeStateSubmitCountHookHandler | - |
| ResourcefulRecordChangeStateSubmittingHookHandler | - |
| ResourcefulRecordChangeStateTouchedHookHandler | - |
| ResourcefulRecordChangeStateValidatingHookHandler | - |
| ResourcefulRecordChangeStateValidHookHandler | - |
| ResourcefulRecordCommonFieldProps | - |
| ResourcefulRecordCompleteCallback | - |
| ResourcefulRecordControlsBarButtonProps | - |
| ResourcefulRecordCrudActionCallback | - |
| ResourcefulRecordCrudInstanceActionCallback | - |
| ResourcefulRecordDefaultForm | - |
| ResourcefulRecordDispositionCallback | - |
| ResourcefulRecordEmits | - |
| ResourcefulRecordEvents | - |
| ResourcefulRecordExceptionCallback | - |
| ResourcefulRecordExceptionHookHandler | NOTE: Exception hooks are specifically for errors that occur during the processing of the submission middleware chain, whereas general 'error' hooks handle caught errors throughout the component lifecycle. |
| ResourcefulRecordFailureCallback | - |
| ResourcefulRecordFailureHookHandler | - |
| ResourcefulRecordFilterableControlsBarButtonProps | - |
| ResourcefulRecordForm | - |
| ResourcefulRecordFormDefaultSlotArgs | - |
| ResourcefulRecordFormSlots | - |
| ResourcefulRecordFormWithValidationDefaultSlotProps | - |
| ResourcefulRecordHookableEvents | - |
| ResourcefulRecordHookHandler | - |
| ResourcefulRecordHooks | - |
| ResourcefulRecordModelPropertySchema | - |
| ResourcefulRecordModelSchema | - |
| ResourcefulRecordNavOptions | - |
| ResourcefulRecordPreventedHookHandler | - |
| ResourcefulRecordProcessingHookHandler | - |
| ResourcefulRecordProps | - |
| ResourcefulRecordRouteOptions | - |
| ResourcefulRecordSlots | - |
| ResourcefulRecordSubmissionMiddlewareFn | - |
| ResourcefulRecordSubmittedHookHandler | - |
| ResourcefulRecordSuccessCallback | - |
| ResourcefulRecordSuccessHookHandler | - |
| ResourcefulRecordTernaryOperator | - |
| ResourcefulRecordViewMode | - |
| ResourcefulSubmissionHandler | - |
| ResourceResourcefulRecordResponse | - |
| RIntegerField | Type definition for the RIntegerField component instance. |
| RIntegerFieldProps | Public props interface for RIntegerField components. |
| RNumberField | Type definition for the RNumberField component instance. |
| RNumberFieldProps | Public props interface for RNumberField components. |
| RNumberFieldValue | Valid value types for RNumberField components. |
| RRenderMode | - |
| RRenderMode | - |
| RStringColorFieldMode | Union type for color picker modes. Used internally by the color picker dialog to determine input format and validation rules. |
| RStringField | Component type for the RStringField. Represents the complete string field component with all format support, unified field architecture integration, and comprehensive slot handling. Use this type for component references, template refs, and programmatic component manipulation. |
| RStringFieldFormat | Union type of all supported string field formats. Use this type for props, function parameters, or conditional logic based on field format. |
| RStringFieldProps | Public props interface for the RStringField component. Includes all VTextField props plus string field-specific options for format handling, auto-linking, icon customization, and unified field architecture features. |
| RUnsignedIntegerField | Type definition for the RUnsignedIntegerField component instance. |
| RUnsignedIntegerFieldProps | Public props interface for RUnsignedIntegerField components. |
| Schema | A union type that includes all schema types. |
| ScopedDisplayProps | - |
| SearchFieldProps | - |
| SlotsType | - |
| SortableComponentSlots | - |
| SortableProps | Type representing the public props interface for the Sortable component. This type extracts only the publicly available props from the props factory, excluding any internal or private props marked with special flags. |
| StyleValue | - |
| SvgIcon | - |
| TimezonePickerProps | - |
| ValidationError | Represents a validation error encountered during the validation of a payload. When using syncronous validation, this error is returned along an undefined value. When using asynchronous validation, this error is thrown. |
| ValidationFieldBindings | Complete field binding object for Vuetify form components with validation support. Contains all necessary props for two-way data binding, validation state, and event handling. |
| ValidationMessageKey | Complete list of all Joi validation message keys. Used for type-safe validation message customization and i18n integration. |
| ValidationMessageKey | Union type of all valid Joi validation message keys. Ensures type safety when customizing validation messages. |
| VeeValidateStateVInputProps | Props extracted from VeeValidate field state for Vuetify input compatibility. Provides validation state properties required by Vuetify input components. |
| VFieldPublicProps | Extracted public props from Vuetify VField component |
| VInputPublicProps | Extracted public props from Vuetify VInput component |
Variables
| Variable | Description |
|---|---|
| ControlButton | - |
| ControlButtonBar | A responsive toolbar component that automatically handles button overflow with dropdown menus. |
| ControllerButtonBarJustification | Available justification options for button alignment within the toolbar. |
| ControlMenu | - |
| defaultControlButtonBarOptionsProps | - |
| defaultControlButtonProps | - |
| Exporter | - |
| ExportFormat | - |
| ExportScope | - |
| FormWithValidation | Enterprise-grade form validation component that provides a complete form wrapper with validation state management, field binding generation, and event emission. |
| RBigIntField | RBigIntField - A sophisticated Vue component for handling unlimited precision integers. |
| RBooleanField | Comprehensive boolean/ternary field component with configurable logic support and multiple rendering variants. Can operate as either a strict boolean field (true/false) or ternary field (true/false/null) based on choices configuration. Automatically adapts between single field editing, multiple selection management, and read-only display through the unified field composer architecture. |
| RBooleanFieldRenderable | Rendering variants for boolean/ternary fields that determine the UI control type. Each variant provides different user interaction patterns while maintaining consistent boolean or ternary logic support based on configured choices. |
| RBooleanFieldValue | Supported boolean field values representing ternary logic when null is included. Includes true/false for standard boolean states plus optional null for indeterminate/unknown/mixed state. Can be configured as strict boolean field (true/false only) or ternary field (true/false/null) depending on use case. |
| RCustomField | RCustomField - A sophisticated wrapper component for building custom field implementations. |
| RDateField | RDateField - A sophisticated Vue component for ISO 8601 date input and selection. |
| RDateTimeField | RDateTimeField - A sophisticated Vue component for ISO 8601 datetime input with full timezone support. |
| RDateTimeFieldDisplayFormat | Available display format options for RDateTimeField. |
| REnumField | Comprehensive enum field component with dynamic choice loading support and multiple rendering variants. Automatically adapts between single field editing, multiple selection management, and read-only display through the unified field composer architecture. |
| REnumFieldRenderable | Rendering variants for enum fields that determine the UI control type. Each variant provides different user interaction patterns while maintaining consistent enum value selection logic. |
| ResourcefulAggregateMethods | - |
| ResourcefulAlerter | - |
| ResourcefulIndex | - |
| ResourcefulRecord | - |
| ResourcefulRecordDefaultForm | - |
| ResourcefulRecordForm | - |
| ResourcefulRecordViewMode | - |
| RIntegerField | Specialized integer input field component with advanced formatting and validation. |
| RNumberField | Professional numeric input field component with advanced formatting and validation. |
| RStringColorFieldMode | Color picker mode options for the color format. Determines the color representation and input format in the color picker interface. |
| RStringField | Comprehensive string field component with extensive format support and professional UX features. Automatically adapts between single field editing, multiple selection management, and read-only display through the unified field composer architecture. |
| RStringFieldFormat | Supported string field format types that determine input behavior, validation, and visual presentation. Each format provides specialized functionality while maintaining consistent behavior across all operational modes. |
| RUnsignedIntegerField | Specialized unsigned integer input field component with automatic constraint normalization. |
| Sortable | - |
| SvgIcon | - |
| TimezonePicker | - |
Functions
| Function | Description |
|---|---|
| svgPathToIconValue | - |
References
AlertIcon
Re-exports AlertIcon
AlertOptions
Re-exports AlertOptions
AlertResult
Re-exports AlertResult
CommonResourcefulFieldPublicProps
Re-exports CommonResourcefulFieldPublicProps
ComponentPublicInstance
Re-exports ComponentPublicInstance
ExportFormatType
Renames and re-exports ExportFormat
ExportScopeType
Renames and re-exports ExportScope
FireAlertFn
Re-exports FireAlertFn
RawSortableOptions
Re-exports RawSortableOptions
Renderable
Re-exports Renderable
RenderableProps
Re-exports RenderableProps
ResourcefulHttpProgress
Re-exports ResourcefulHttpProgress
ResourcefulHttpResponse
Re-exports ResourcefulHttpResponse
RFieldStringifier
Re-exports RFieldStringifier
SortableCtor
Re-exports SortableCtor
SortableEvent
Re-exports SortableEvent
SortableInstance
Re-exports SortableInstance
SortableMoveEvent
Re-exports SortableMoveEvent
SortableOptions
Re-exports SortableOptions
TernaryOperator
Re-exports TernaryOperator
ValidationProps
Re-exports ValidationProps
VImgPublicProps
Re-exports VImgPublicProps
VNode
Re-exports VNode