Skip to content

@nhtio/lucid-resourceful-vue-components

Main Navigation Home Quick Start API

Appearance

Sidebar Navigation

Quick Start

IoC Container

Normalized HTTP Request / Response classes

Public Components

Public Composables

Public Exceptions

Public Factories

Public Guards

Public Helpers

Public Icons

Public Symbols

Public Types

I18n Terms

Playground

API

@nhtio/lucid-resourceful-vue-components

Package Exports

Classes

IoC

Interfaces

IoCServices

Resolver

Type Aliases

InjectionKey

IocEventMap

IocService

IocServiceResolver

ScopedDisplayInstance

ScopedDisplayOrientation

Variables

IoCSymbol

ResourcefulIndexScopedDisplaySymbol

ResourcefulRecordFormScopedBusConsumerSymbol

ResourcefulRecordFormScopedDisplaySymbol

ResourcefulRecordScopedBusConsumerSymbol

ResourcefulRecordScopedDisplaySymbol

version

Functions

setIocService

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

Package Exports

Namespaces

OpenAPIV3

Enumerations

HttpMethods

Interfaces

ApiKeySecurityScheme

ArraySchemaObject

BaseSchemaObject

CallbackObject

ComponentsObject

ContactObject

DiscriminatorObject

Document

EncodingObject

ExampleObject

ExternalDocumentationObject

HeaderObject

HttpSecurityScheme

InfoObject

LicenseObject

LinkObject

MediaTypeObject

NonArraySchemaObject

OAuth2SecurityScheme

OpenIdSecurityScheme

ParameterBaseObject

ParameterObject

PathsObject

ReferenceObject

RequestBodyObject

ResponseObject

ResponsesObject

SecurityRequirementObject

ServerObject

ServerVariableObject

TagObject

XMLObject

Type Aliases

ArraySchemaObjectType

NonArraySchemaObjectType

OperationObject

PathItemObject

SchemaObject

SecuritySchemeObject

Interfaces

AlertOptions

AlertResult

AsyncValidationOptions

Big

ComputedRef

ControlButtonBadgeProps

ControlButtonState

FormFieldsSchema

Hooks

ObjectSchema

Ref

ResourcefulHttpProgress

ResourcefulHttpResponse

ResourcefulIndexAggregateOptions

ResourcefulIndexAggregateResults

ResourcefulIndexExposed

ResourcefulIndexFunctionAction

ResourcefulIndexRequest

ResourcefulIndexUrlAction

ResourcefulRecordAction

ResourcefulRecordBusConsumer

ResourcefulRecordFunctionAction

ResourcefulRecordUrlAction

ResourcefulSchemaDefinition

ResourcefulSortPayload

RouteLocationAsPathGeneric

RouteLocationAsRelativeGeneric

SortableItemSlotBindings

SortableSlotBindings

ValidationError

VNode

Type Aliases

ActionableRecord

AlertIcon

BaseResourcefulRecordProps

BulkActionResults

ColorValue

CommonResourcefulFieldPublicProps

ComponentPublicInstance

ComputedColumnDefinition

ComputedColumnDefinitions

ControlButton

ControlButtonBar

ControlButtonBarJustification

ControlButtonBarOptionsProps

ControlButtonBarOverflowMenuButtonProps

ControlButtonBarProps

ControlButtonBarSlots

ControlButtonOverrideProps

ControlButtonProps

ControlMenu

ControlMenuControlButtonProps

ControlMenuProps

DataTypeOf

DefinedField

Exporter

ExportFormat

ExportOptions

ExportScope

FetchViaAsyncIteratorFn

FieldOverrideProps

FieldSpecificOverrideOptions

FieldValueFormatter

FieldValueFormatters

FilterGroup

FireAlertFn

FormWithValidation

FormWithValidationDefaultSlotProps

FormWithValidationProps

FormWithValidationSlots

GeneralFieldOverrideOptions

HookHandler

JoiSchemaPropType

MaybePromise

PropType

RawSortableOptions

RBigIntField

RBigIntFieldProps

RBigIntFieldValue

RBooleanField

RBooleanFieldProps

RBooleanFieldRenderable

RBooleanFieldValue

RCustomField

RCustomFieldBusEventMap

RCustomFieldDefaultSlotProps

RCustomFieldInputSlotArg

RCustomFieldProps

RCustomFieldSlots

RDateField

RDateFieldProps

RDateTimeField

RDateTimeFieldDisplayFormat

RDateTimeFieldProps

Renderable

RenderableProps

REnumField

REnumFieldLoadedChoice

REnumFieldProps

REnumFieldRenderable

REnumFieldValue

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

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

RFieldStringifier

RIntegerField

RIntegerFieldProps

RNumberField

RNumberFieldProps

RNumberFieldValue

RRenderMode

RStringColorFieldMode

RStringField

RStringFieldFormat

RStringFieldProps

RUnsignedIntegerField

RUnsignedIntegerFieldProps

Schema

ScopedDisplayProps

SearchFieldProps

SlotsType

SortableComponentSlots

SortableCtor

SortableEvent

SortableInstance

SortableMoveEvent

SortableOptions

SortableProps

StyleValue

SvgIcon

TernaryOperator

TimezonePickerProps

ValidationError

ValidationFieldBindings

ValidationMessageKey

ValidationProps

VeeValidateStateVInputProps

VFieldPublicProps

VImgPublicProps

VInputPublicProps

Variables

ControlButton

ControlButtonBar

ControllerButtonBarJustification

ControlMenu

defaultControlButtonBarOptionsProps

defaultControlButtonProps

Exporter

ExportFormat

ExportScope

FormWithValidation

RBigIntField

RBooleanField

RBooleanFieldRenderable

RBooleanFieldValue

RCustomField

RDateField

RDateTimeField

RDateTimeFieldDisplayFormat

REnumField

REnumFieldRenderable

ResourcefulAggregateMethods

ResourcefulAlerter

ResourcefulIndex

ResourcefulRecord

ResourcefulRecordDefaultForm

ResourcefulRecordForm

ResourcefulRecordViewMode

RIntegerField

RNumberField

RStringColorFieldMode

RStringField

RStringFieldFormat

RUnsignedIntegerField

Sortable

SvgIcon

TimezonePicker

Functions

svgPathToIconValue

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

Package Exports

Variables

AutoRefeshController

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

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

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

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

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

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

@nhtio/lucid-resourceful-vue-components/components/fields/bigint

@nhtio/lucid-resourceful-vue-components/components/fields/boolean

@nhtio/lucid-resourceful-vue-components/components/fields/date

@nhtio/lucid-resourceful-vue-components/components/fields/date_time

@nhtio/lucid-resourceful-vue-components/components/fields/enum

@nhtio/lucid-resourceful-vue-components/components/fields/integer

@nhtio/lucid-resourceful-vue-components/components/fields/number

@nhtio/lucid-resourceful-vue-components/components/fields/string

@nhtio/lucid-resourceful-vue-components/components/fields/unsigned_integer

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

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

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

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

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

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

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

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

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

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

Package Exports

Interfaces

BigNumberFormatter

BrowserService

EmitWithUpdateModelValue

I18nTranslator

ResourcefulHttpHeaders

ResourcefulHttpRequestOptions

ResourcefulHttpService

ResourcefulMemoryCache

ResourcefulTimezone

ResourcefulTimezoneInformation

ResourcefulTimezoneOption

ValidationRoot

Type Aliases

ClipboardComposableOptions

LocalStateModelValue

MaybePromised

MaybeRef

ReferencedContainer

ResourcefulHttpMethod

SingleFieldRenderer

SingleVariantPropBindings

SingleVariantSlotArgs

UsePassthroughHookOptions

VSnackbarPublicProps

Functions

useAlert

useBigNumberFormatter

useBrowser

useCache

useClipboard

useCron

useCronTab

useCurrentTimezone

useFieldComposer

useFocus

useHttp

useHttpElements

useI18n

useIoC

useLocalState

useMountedInBrowser

usePassthroughHook

useProxiedModel

useScopedDisplay

useSlot

useSortableProps

useTimezoneOptions

useTimezones

useTimezoneZones

useValidation

useValidator

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

Package Exports

Classes

BaseException

Variables

E_DECODED_STATE_MODEL_INCOMPATIBLE

E_FAILED_TO_COMPARE_STATE_MODEL_VALUES

E_FAILED_TO_DECODE_STATE_MODEL

E_FORM_NOT_RENDERED

E_UNDECODABLE_RESPONSE

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

Package Exports

Type Aliases

CastToEmitValidators

EmitHandlerProps

ExtractPublicPropTypesFromFactory

ExtractPublicPropTypesFromUnknownFactory

ExtractSlotDefinitions

HookableEvents

PropFactory

Functions

emitsFactory

getCamelAndMaybeKebabPropKeysFor

omit

pick

propsAndDefaultsFactory

propsAndEmitsFactory

propsFactory

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

Package Exports

Functions

isHTMLElement

isObject

isResourcefulHttpProgress

isResourcefulHttpResponse

isResourcefulIndexFunctionAction

isResourcefulIndexUrlAction

isResourcefulRecordFailureEvent

isResourcefulRecordPreventedEvent

isResourcefulRecordProcessingEvent

isResourcefulRecordSubmittedEvent

isResourcefulRecordSuccessEvent

isResourceResourcefulRecordResponse

isValidationError

isValues

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

Package Exports

Namespaces

numeral

Classes

Numeral

Interfaces

NumeralJSFormat

NumeralJSFormats

NumeralJSLocale

NumeralJSLocales

NumeralJSOptions

NumeralJSUtils

Type Aliases

RegisterType

RoundingFunction

Variables

_

fn

formats

locales

options

version

Functions

defaultFormat

isNumeral

locale

localeData

nullFormat

register

reset

validate

zeroFormat

qs

Interfaces

IParseBaseOptions

IStringifyBaseOptions

ParsedQs

Type Aliases

BooleanOptional

defaultDecoder

defaultEncoder

IParseDynamicOptions

IParseOptions

IStringifyDynamicOptions

IStringifyOptions

Functions

parse

stringify

Interfaces

BigNumber

CustomEncodable

FocusProps

Type Aliases

_ToObjectOutput

_ToObjectUnit

CallbackFnResponse

CreatedException

Encodable

EncodablePrimitive

EncodableTypedArray

EventProp

ExtractPublicDefaultPropTypes

FactoryPropFactory

MaybeRefOrGetter

NamedSlotParameters

ObjectStrippedOfUndefinedValues

ResourcefulFieldType

RGB

Slot

SlotParameters

ThemeDefinition

Variables

decode

DECODE_METHOD

decodeValidator

dot

encode

ENCODE_METHOD

encodeValidator

format

IN_BROWSER

ordinal

registerClass

ResourcefulFieldType

SUPPORTS_INTERSECTION

SUPPORTS_RESIZE_OBSERVATION

SUPPORTS_VISUAL_VIEWPORT

version

Functions

asAbsInt

copyToClipboard

createError

debounce

extractErrorCode

formatBigNumber

getDefaultsForPropFactory

getNormalizedBackgroundColor

getNormalizedForegroundColor

getOxfordizedListParts

getStringOrVNodeAsString

isNotEmpty

makeIdentifier

mergeClasses

numeral

renderDefaultResourcefulRecordForm

renderResourcefulRecordModelPropertyField

stripUndefinedValuesFromObject

throttle

toUnreactive

typeAndFormatToResourcefulFieldType

useNormalizedColor

useNormalizedColors

useNormalizedOpacities

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

Package Exports

Classes

ResourcefulAxiosHttpService

ResourcefulFetchHttpService

Interfaces

Axios

AxiosProgressEvent

AxiosRequestConfig

AxiosResponse

KyRequestOptions

Middleware

Type Aliases

KyInstance

KyResponse

NextFn

ResourcefulHttpMiddlewareProxy

ResourcefulHttpRequestMiddlewareFn

ResourcefulHttpResponseMiddlewareFn

ResourcefulHttpResponseType

Variables

ResourcefulHttpResponseType

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

Package Exports

Variables

errorIconRaw

errorIconUrl

infoIconRaw

infoIconUrl

questionIconRaw

questionIconUrl

successIconRaw

successIconUrl

warningIconRaw

warningIconUrl

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

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

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

On this page

Function: useHttp()

ts

function useHttp(): ResourcefulHttpService;

Returns

ResourcefulHttpService

Pager

Previous pageuseFocus

Next pageuseHttpElements

OpenAPIV3

Enumerations

Interfaces

Type Aliases

numeral

Classes

Interfaces

Type Aliases

Variables

Functions

qs

Interfaces

Type Aliases

Functions

Function: useHttp() ​

Returns ​

Function: useHttp()

Returns