@hybridly/vue
Advanced tools
Comparing version 0.7.7 to 0.7.8
import * as vue from 'vue'; | ||
import { App, Plugin as Plugin$1, h, PropType, ComputedRef, DeepReadonly, Ref, MaybeRefOrGetter } from 'vue'; | ||
import { ComputedRef, DeepReadonly, Ref, MaybeRefOrGetter, App, Plugin as Plugin$1, h, PropType } from 'vue'; | ||
import * as _hybridly_core from '@hybridly/core'; | ||
import { RouterContextOptions, Plugin, RouterContext, Method, HybridRequestOptions, UrlResolvable, registerHook as registerHook$1, RouteParameters } from '@hybridly/core'; | ||
import { HybridRequestOptions, UrlResolvable, RouterContext, registerHook as registerHook$1, RouteParameters, RouterContextOptions, Plugin, Method } from '@hybridly/core'; | ||
export { can, route, router } from '@hybridly/core'; | ||
import { Axios } from 'axios'; | ||
import { SearchableObject, Path, PathValue } from '@clickbar/dot-diver'; | ||
import { FormDataConvertible, RequestData } from '@hybridly/utils'; | ||
import * as _vue_shared from '@vue/shared'; | ||
import { RequestData, FormDataConvertible } from '@hybridly/utils'; | ||
import { SearchableObject, Path, PathValue } from '@clickbar/dot-diver'; | ||
@@ -39,172 +39,2 @@ interface ProgressOptions { | ||
/** | ||
* Initializes Hybridly's router and context. | ||
*/ | ||
declare function initializeHybridly(options?: InitializeOptions): Promise<any>; | ||
interface InitializeOptions { | ||
/** Callback that gets executed before Vue is mounted. */ | ||
enhanceVue?: (vue: App<Element>) => any; | ||
/** ID of the app element. */ | ||
id?: string; | ||
/** Clean up the host element's payload dataset after loading. */ | ||
cleanup?: boolean; | ||
/** Whether to set up the devtools plugin. */ | ||
devtools?: boolean; | ||
/** Whether to display response error modals. */ | ||
responseErrorModals?: boolean; | ||
/** Custom history state serialization functions. */ | ||
serializer?: RouterContextOptions['serializer']; | ||
/** Progressbar options. */ | ||
progress?: false | Partial<ProgressOptions>; | ||
/** Sets up the hybridly router. */ | ||
setup?: (options: SetupArguments) => any; | ||
/** List of Hybridly plugins. */ | ||
plugins?: Plugin[]; | ||
/** Custom Axios instance. */ | ||
axios?: Axios; | ||
/** | ||
* Enables the View Transition API, if supported. | ||
* @see https://developer.mozilla.org/en-US/docs/Web/API/ViewTransition | ||
*/ | ||
viewTransition?: boolean; | ||
} | ||
interface SetupArguments { | ||
/** DOM element to mount Vue on. */ | ||
element: Element; | ||
/** Hybridly wrapper component. */ | ||
wrapper: any; | ||
/** Hybridly wrapper component properties. */ | ||
props: { | ||
context: RouterContext; | ||
}; | ||
/** Vue plugin that registers the devtools. */ | ||
hybridly: Plugin$1; | ||
/** Renders the wrapper. */ | ||
render: () => ReturnType<typeof h>; | ||
/** Initial payload. */ | ||
payload: Record<string, any>; | ||
} | ||
declare const RouterLink: vue.DefineComponent<{ | ||
href: { | ||
type: StringConstructor; | ||
required: false; | ||
default: undefined; | ||
}; | ||
as: { | ||
type: (ObjectConstructor | StringConstructor)[]; | ||
default: string; | ||
}; | ||
method: { | ||
type: PropType<"delete" | Method | "get" | "post" | "put" | "patch">; | ||
default: string; | ||
}; | ||
data: { | ||
type: PropType<RequestData>; | ||
default: () => {}; | ||
}; | ||
external: { | ||
type: BooleanConstructor; | ||
default: boolean; | ||
}; | ||
disabled: { | ||
type: BooleanConstructor; | ||
default: boolean; | ||
}; | ||
options: { | ||
type: PropType<Omit<HybridRequestOptions, "data" | "url" | "method">>; | ||
default: () => {}; | ||
}; | ||
text: { | ||
type: StringConstructor; | ||
required: false; | ||
default: undefined; | ||
}; | ||
preload: { | ||
type: PropType<boolean | "hover" | "mount">; | ||
default: boolean; | ||
}; | ||
preserveScroll: { | ||
type: BooleanConstructor; | ||
default: undefined; | ||
}; | ||
preserveState: { | ||
type: BooleanConstructor; | ||
default: undefined; | ||
}; | ||
}, (props: _vue_shared.LooseRequired<{ | ||
readonly data: RequestData; | ||
readonly method: "delete" | Method | "get" | "post" | "put" | "patch"; | ||
readonly options: Omit<HybridRequestOptions, "data" | "url" | "method">; | ||
readonly as: string | Record<string, any>; | ||
readonly external: boolean; | ||
readonly disabled: boolean; | ||
readonly preload: boolean | "hover" | "mount"; | ||
readonly text?: string | undefined; | ||
readonly preserveScroll?: boolean | undefined; | ||
readonly preserveState?: boolean | undefined; | ||
readonly href?: string | undefined; | ||
} & {}>) => vue.VNode<vue.RendererNode, vue.RendererElement, { | ||
[key: string]: any; | ||
}>, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{ | ||
href: { | ||
type: StringConstructor; | ||
required: false; | ||
default: undefined; | ||
}; | ||
as: { | ||
type: (ObjectConstructor | StringConstructor)[]; | ||
default: string; | ||
}; | ||
method: { | ||
type: PropType<"delete" | Method | "get" | "post" | "put" | "patch">; | ||
default: string; | ||
}; | ||
data: { | ||
type: PropType<RequestData>; | ||
default: () => {}; | ||
}; | ||
external: { | ||
type: BooleanConstructor; | ||
default: boolean; | ||
}; | ||
disabled: { | ||
type: BooleanConstructor; | ||
default: boolean; | ||
}; | ||
options: { | ||
type: PropType<Omit<HybridRequestOptions, "data" | "url" | "method">>; | ||
default: () => {}; | ||
}; | ||
text: { | ||
type: StringConstructor; | ||
required: false; | ||
default: undefined; | ||
}; | ||
preload: { | ||
type: PropType<boolean | "hover" | "mount">; | ||
default: boolean; | ||
}; | ||
preserveScroll: { | ||
type: BooleanConstructor; | ||
default: undefined; | ||
}; | ||
preserveState: { | ||
type: BooleanConstructor; | ||
default: undefined; | ||
}; | ||
}>>, { | ||
data: RequestData; | ||
text: string; | ||
preserveScroll: boolean; | ||
preserveState: boolean; | ||
method: "delete" | Method | "get" | "post" | "put" | "patch"; | ||
href: string; | ||
options: Omit<HybridRequestOptions, "data" | "url" | "method">; | ||
as: string | Record<string, any>; | ||
external: boolean; | ||
disabled: boolean; | ||
preload: boolean | "hover" | "mount"; | ||
}, {}>; | ||
/** Accesses all current properties. */ | ||
@@ -223,2 +53,3 @@ declare function useProperties<T extends object, Global extends GlobalHybridlyProperties = GlobalHybridlyProperties>(): vue.DeepReadonly<vue.UnwrapNestedRefs<T & Global>>; | ||
}; | ||
type DefaultFormOptions = Pick<FormOptions<object>, 'timeout' | 'reset' | 'updateInitials' | 'progress' | 'preserveScroll' | 'preserveState' | 'preserveUrl' | 'headers' | 'errorBag' | 'spoof' | 'transformUrl' | 'updateHistoryState' | 'useFormData'>; | ||
interface FormOptions<T extends SearchableObject> extends Omit<HybridRequestOptions, 'data' | 'url'> { | ||
@@ -932,2 +763,174 @@ fields: T; | ||
export { type Action, type AvailableHybridRequestOptions, type BindFilterOptions, type BulkAction, type BulkSelection, type Column, type InlineAction, type RecordIdentifier, RouterLink, type SortDirection, type ToggleSortOptions, initializeHybridly, registerHook, setProperty, useBackForward, useBulkSelect, useDialog, useForm, useHistoryState, useProperties, useProperty, useQueryParameters, useRefinements, useRoute, useTable }; | ||
/** | ||
* Initializes Hybridly's router and context. | ||
*/ | ||
declare function initializeHybridly(options?: InitializeOptions): Promise<any>; | ||
interface InitializeOptions { | ||
/** Callback that gets executed before Vue is mounted. */ | ||
enhanceVue?: (vue: App<Element>) => any; | ||
/** ID of the app element. */ | ||
id?: string; | ||
/** Clean up the host element's payload dataset after loading. */ | ||
cleanup?: boolean; | ||
/** Whether to set up the devtools plugin. */ | ||
devtools?: boolean; | ||
/** Whether to display response error modals. */ | ||
responseErrorModals?: boolean; | ||
/** Custom history state serialization functions. */ | ||
serializer?: RouterContextOptions['serializer']; | ||
/** Progressbar options. */ | ||
progress?: false | Partial<ProgressOptions>; | ||
/** Sets up the hybridly router. */ | ||
setup?: (options: SetupArguments) => any; | ||
/** List of Hybridly plugins. */ | ||
plugins?: Plugin[]; | ||
/** Custom Axios instance. */ | ||
axios?: Axios; | ||
/** | ||
* Enables the View Transition API, if supported. | ||
* @see https://developer.mozilla.org/en-US/docs/Web/API/ViewTransition | ||
*/ | ||
viewTransition?: boolean; | ||
/** Options that will apply to all forms by default. Specific forms' options will override them. */ | ||
defaultFormOptions?: DefaultFormOptions; | ||
} | ||
interface SetupArguments { | ||
/** DOM element to mount Vue on. */ | ||
element: Element; | ||
/** Hybridly wrapper component. */ | ||
wrapper: any; | ||
/** Hybridly wrapper component properties. */ | ||
props: { | ||
context: RouterContext; | ||
}; | ||
/** Vue plugin that registers the devtools. */ | ||
hybridly: Plugin$1; | ||
/** Renders the wrapper. */ | ||
render: () => ReturnType<typeof h>; | ||
/** Initial payload. */ | ||
payload: Record<string, any>; | ||
} | ||
declare const RouterLink: vue.DefineComponent<{ | ||
href: { | ||
type: StringConstructor; | ||
required: false; | ||
default: undefined; | ||
}; | ||
as: { | ||
type: (ObjectConstructor | StringConstructor)[]; | ||
default: string; | ||
}; | ||
method: { | ||
type: PropType<"delete" | Method | "get" | "post" | "put" | "patch">; | ||
default: string; | ||
}; | ||
data: { | ||
type: PropType<RequestData>; | ||
default: () => {}; | ||
}; | ||
external: { | ||
type: BooleanConstructor; | ||
default: boolean; | ||
}; | ||
disabled: { | ||
type: BooleanConstructor; | ||
default: boolean; | ||
}; | ||
options: { | ||
type: PropType<Omit<HybridRequestOptions, "data" | "url" | "method">>; | ||
default: () => {}; | ||
}; | ||
text: { | ||
type: StringConstructor; | ||
required: false; | ||
default: undefined; | ||
}; | ||
preload: { | ||
type: PropType<boolean | "hover" | "mount">; | ||
default: boolean; | ||
}; | ||
preserveScroll: { | ||
type: BooleanConstructor; | ||
default: undefined; | ||
}; | ||
preserveState: { | ||
type: BooleanConstructor; | ||
default: undefined; | ||
}; | ||
}, (props: _vue_shared.LooseRequired<{ | ||
readonly data: RequestData; | ||
readonly method: "delete" | Method | "get" | "post" | "put" | "patch"; | ||
readonly options: Omit<HybridRequestOptions, "data" | "url" | "method">; | ||
readonly as: string | Record<string, any>; | ||
readonly external: boolean; | ||
readonly disabled: boolean; | ||
readonly preload: boolean | "hover" | "mount"; | ||
readonly text?: string | undefined; | ||
readonly preserveScroll?: boolean | undefined; | ||
readonly preserveState?: boolean | undefined; | ||
readonly href?: string | undefined; | ||
} & {}>) => vue.VNode<vue.RendererNode, vue.RendererElement, { | ||
[key: string]: any; | ||
}>, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{ | ||
href: { | ||
type: StringConstructor; | ||
required: false; | ||
default: undefined; | ||
}; | ||
as: { | ||
type: (ObjectConstructor | StringConstructor)[]; | ||
default: string; | ||
}; | ||
method: { | ||
type: PropType<"delete" | Method | "get" | "post" | "put" | "patch">; | ||
default: string; | ||
}; | ||
data: { | ||
type: PropType<RequestData>; | ||
default: () => {}; | ||
}; | ||
external: { | ||
type: BooleanConstructor; | ||
default: boolean; | ||
}; | ||
disabled: { | ||
type: BooleanConstructor; | ||
default: boolean; | ||
}; | ||
options: { | ||
type: PropType<Omit<HybridRequestOptions, "data" | "url" | "method">>; | ||
default: () => {}; | ||
}; | ||
text: { | ||
type: StringConstructor; | ||
required: false; | ||
default: undefined; | ||
}; | ||
preload: { | ||
type: PropType<boolean | "hover" | "mount">; | ||
default: boolean; | ||
}; | ||
preserveScroll: { | ||
type: BooleanConstructor; | ||
default: undefined; | ||
}; | ||
preserveState: { | ||
type: BooleanConstructor; | ||
default: undefined; | ||
}; | ||
}>>, { | ||
data: RequestData; | ||
text: string; | ||
preserveScroll: boolean; | ||
preserveState: boolean; | ||
method: "delete" | Method | "get" | "post" | "put" | "patch"; | ||
href: string; | ||
options: Omit<HybridRequestOptions, "data" | "url" | "method">; | ||
as: string | Record<string, any>; | ||
external: boolean; | ||
disabled: boolean; | ||
preload: boolean | "hover" | "mount"; | ||
}, {}>; | ||
export { type Action, type AvailableHybridRequestOptions, type BindFilterOptions, type BulkAction, type BulkSelection, type Column, type DefaultFormOptions, type InitializeOptions, type InlineAction, type RecordIdentifier, RouterLink, type SortDirection, type ToggleSortOptions, initializeHybridly, registerHook, setProperty, useBackForward, useBulkSelect, useDialog, useForm, useHistoryState, useProperties, useProperty, useQueryParameters, useRefinements, useRoute, useTable }; |
{ | ||
"name": "@hybridly/vue", | ||
"version": "0.7.7", | ||
"version": "0.7.8", | ||
"description": "Vue adapter for Hybridly", | ||
@@ -52,4 +52,4 @@ "keywords": [ | ||
"qs": "^6.12.1", | ||
"@hybridly/core": "0.7.7", | ||
"@hybridly/utils": "0.7.7" | ||
"@hybridly/core": "0.7.8", | ||
"@hybridly/utils": "0.7.8" | ||
}, | ||
@@ -56,0 +56,0 @@ "devDependencies": { |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
184478
3681
+ Added@hybridly/core@0.7.8(transitive)
+ Added@hybridly/utils@0.7.8(transitive)
- Removed@hybridly/core@0.7.7(transitive)
- Removed@hybridly/utils@0.7.7(transitive)
Updated@hybridly/core@0.7.8
Updated@hybridly/utils@0.7.8