vuetify
Version:
Vue Material Component Framework
1,159 lines (1,142 loc) • 754 kB
text/typescript
import * as vue from 'vue';
import { ComponentPropsOptions, ExtractPropTypes, Ref, EffectScope, JSXComponent, PropType, UnwrapRef, CSSProperties, nextTick, VNode } from 'vue';
declare const block: readonly ["top", "bottom"];
declare const inline: readonly ["start", "end", "left", "right"];
type Tblock = typeof block[number];
type Tinline = typeof inline[number];
type Anchor = Tblock | Tinline | 'center' | 'center center' | `${Tblock} ${Tinline | 'center'}` | `${Tinline} ${Tblock | 'center'}`;
declare class Box {
x: number;
y: number;
width: number;
height: number;
constructor({ x, y, width, height }: {
x: number;
y: number;
width: number;
height: number;
});
get top(): number;
get bottom(): number;
get left(): number;
get right(): number;
}
interface FilterPropsOptions<PropsOptions extends Readonly<ComponentPropsOptions>, Props = ExtractPropTypes<PropsOptions>> {
filterProps<T extends Partial<Props>, U extends Exclude<keyof Props, Exclude<keyof Props, keyof T>>>(props: T): [yes: Partial<Pick<T, U>>, no: Omit<T, U>];
}
type SelectItemKey = boolean | string | (string | number)[] | ((item: Record<string, any>, fallback?: any) => any);
interface LocationStrategyData {
contentEl: Ref<HTMLElement | undefined>;
activatorEl: Ref<HTMLElement | undefined>;
isActive: Ref<boolean>;
isRtl: Ref<boolean>;
}
type LocationStrategyFn = (data: LocationStrategyData, props: StrategyProps$1, contentStyles: Ref<Record<string, string>>) => undefined | {
updateLocation: (e: Event) => void;
};
declare const locationStrategies: {
static: typeof staticLocationStrategy;
connected: typeof connectedLocationStrategy;
};
interface StrategyProps$1 {
locationStrategy: keyof typeof locationStrategies | LocationStrategyFn;
location: Anchor;
origin: Anchor | 'auto' | 'overlap';
offset?: number | string | number[];
maxHeight?: number | string;
maxWidth?: number | string;
minHeight?: number | string;
minWidth?: number | string;
}
declare function staticLocationStrategy(): void;
declare function connectedLocationStrategy(data: LocationStrategyData, props: StrategyProps$1, contentStyles: Ref<Record<string, string>>): {
updateLocation: () => {
available: {
x: number;
y: number;
};
contentBox: Box;
} | undefined;
};
interface ScrollStrategyData {
root: Ref<HTMLElement | undefined>;
contentEl: Ref<HTMLElement | undefined>;
activatorEl: Ref<HTMLElement | undefined>;
isActive: Ref<boolean>;
updateLocation: Ref<((e: Event) => void) | undefined>;
}
type ScrollStrategyFn = (data: ScrollStrategyData, props: StrategyProps, scope: EffectScope) => void;
declare const scrollStrategies: {
none: null;
close: typeof closeScrollStrategy;
block: typeof blockScrollStrategy;
reposition: typeof repositionScrollStrategy;
};
interface StrategyProps {
scrollStrategy: keyof typeof scrollStrategies | ScrollStrategyFn;
contained: boolean | undefined;
}
declare function closeScrollStrategy(data: ScrollStrategyData): void;
declare function blockScrollStrategy(data: ScrollStrategyData, props: StrategyProps): void;
declare function repositionScrollStrategy(data: ScrollStrategyData, props: StrategyProps, scope: EffectScope): void;
declare const VBottomSheet: {
new (...args: any[]): {
$: vue.ComponentInternalInstance;
$data: {};
$props: {
absolute?: boolean | undefined;
location?: Anchor | undefined;
origin?: NonNullable<"auto" | Anchor | "overlap"> | undefined;
inset?: boolean | undefined;
transition?: NonNullable<NonNullable<string | boolean | (vue.TransitionProps & {
component?: vue.Component | undefined;
})> | {
component: vue.Component;
}> | undefined;
zIndex?: NonNullable<string | number> | undefined;
style?: vue.StyleValue | undefined;
eager?: boolean | undefined;
disabled?: boolean | undefined;
contentClass?: any;
modelValue?: boolean | undefined;
locationStrategy?: "connected" | "static" | ((data: LocationStrategyData, props: StrategyProps$1, contentStyles: vue.Ref<Record<string, string>>) => {
updateLocation: (e: Event) => void;
} | undefined) | undefined;
scrollStrategy?: NonNullable<"none" | "block" | "close" | ((data: ScrollStrategyData, props: StrategyProps, scope: vue.EffectScope) => void) | "reposition"> | undefined;
activatorProps?: Record<string, any> | undefined;
openOnClick?: boolean | undefined;
openOnHover?: boolean | undefined;
openOnFocus?: boolean | undefined;
closeOnContentClick?: boolean | undefined;
closeOnBack?: boolean | undefined;
contained?: boolean | undefined;
noClickAnimation?: boolean | undefined;
persistent?: boolean | undefined;
scrim?: string | boolean | undefined;
fullscreen?: boolean | undefined;
retainFocus?: boolean | undefined;
scrollable?: boolean | undefined;
offset?: string | number | number[] | undefined;
key?: string | number | symbol | undefined;
height?: string | number | undefined;
width?: string | number | undefined;
maxHeight?: string | number | undefined;
maxWidth?: string | number | undefined;
minHeight?: string | number | undefined;
minWidth?: string | number | undefined;
class?: any;
$children?: vue.VNodeChild | {
default?: ((arg: {
isActive: vue.Ref<boolean>;
}) => vue.VNodeChild) | undefined;
activator?: ((arg: {
isActive: boolean;
props: Record<string, any>;
}) => vue.VNodeChild) | undefined;
} | ((arg: {
isActive: vue.Ref<boolean>;
}) => vue.VNodeChild);
ref?: vue.VNodeRef | undefined;
ref_for?: boolean | undefined;
ref_key?: string | undefined;
theme?: string | undefined;
"v-slot:default"?: false | ((arg: {
isActive: vue.Ref<boolean>;
}) => vue.VNodeChild) | undefined;
'v-slots'?: {
default?: false | ((arg: {
isActive: vue.Ref<boolean>;
}) => vue.VNodeChild) | undefined;
activator?: false | ((arg: {
isActive: boolean;
props: Record<string, any>;
}) => vue.VNodeChild) | undefined;
} | undefined;
onVnodeBeforeMount?: ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void) | ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void)[] | undefined;
onVnodeMounted?: ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void) | ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void)[] | undefined;
onVnodeBeforeUpdate?: ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, oldVNode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void) | ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, oldVNode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void)[] | undefined;
onVnodeUpdated?: ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, oldVNode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void) | ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, oldVNode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void)[] | undefined;
onVnodeBeforeUnmount?: ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void) | ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void)[] | undefined;
onVnodeUnmounted?: ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void) | ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void)[] | undefined;
"onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
activator?: string | Element | vue.ComponentPublicInstance | undefined;
"v-slot:activator"?: false | ((arg: {
isActive: boolean;
props: Record<string, any>;
}) => vue.VNodeChild) | undefined;
closeDelay?: string | number | undefined;
openDelay?: string | number | undefined;
contentProps?: any;
attach?: string | boolean | Element | undefined;
};
$attrs: {
[x: string]: unknown;
};
$refs: {
[x: string]: unknown;
};
$slots: Readonly<{
default?: ((arg: {
isActive: vue.Ref<boolean>;
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[]) | undefined;
activator?: ((arg: {
isActive: boolean;
props: Record<string, any>;
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[]) | undefined;
}>;
$root: vue.ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, vue.ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null;
$parent: vue.ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, vue.ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null;
$emit: (event: "update:modelValue", value: boolean) => void;
$el: any;
$options: vue.ComponentOptionsBase<{
absolute: boolean;
location: Anchor;
origin: NonNullable<"auto" | Anchor | "overlap">;
inset: boolean;
transition: NonNullable<NonNullable<string | boolean | (vue.TransitionProps & {
component?: vue.Component | undefined;
})> | {
component: vue.Component;
}>;
zIndex: NonNullable<string | number>;
style: vue.StyleValue;
eager: boolean;
disabled: boolean;
modelValue: boolean;
locationStrategy: "connected" | "static" | ((data: LocationStrategyData, props: StrategyProps$1, contentStyles: vue.Ref<Record<string, string>>) => {
updateLocation: (e: Event) => void;
} | undefined);
scrollStrategy: NonNullable<"none" | "block" | "close" | ((data: ScrollStrategyData, props: StrategyProps, scope: vue.EffectScope) => void) | "reposition">;
activatorProps: Record<string, any>;
openOnHover: boolean;
closeOnContentClick: boolean;
closeOnBack: boolean;
contained: boolean;
noClickAnimation: boolean;
persistent: boolean;
scrim: string | boolean;
fullscreen: boolean;
retainFocus: boolean;
scrollable: boolean;
} & {
offset?: string | number | number[] | undefined;
height?: string | number | undefined;
width?: string | number | undefined;
maxHeight?: string | number | undefined;
maxWidth?: string | number | undefined;
minHeight?: string | number | undefined;
minWidth?: string | number | undefined;
class?: any;
theme?: string | undefined;
contentClass?: any;
activator?: string | Element | vue.ComponentPublicInstance | undefined;
closeDelay?: string | number | undefined;
openDelay?: string | number | undefined;
openOnClick?: boolean | undefined;
openOnFocus?: boolean | undefined;
contentProps?: any;
attach?: string | boolean | Element | undefined;
} & {
$children?: vue.VNodeChild | {
default?: ((arg: {
isActive: vue.Ref<boolean>;
}) => vue.VNodeChild) | undefined;
activator?: ((arg: {
isActive: boolean;
props: Record<string, any>;
}) => vue.VNodeChild) | undefined;
} | ((arg: {
isActive: vue.Ref<boolean>;
}) => vue.VNodeChild);
'v-slots'?: {
default?: false | ((arg: {
isActive: vue.Ref<boolean>;
}) => vue.VNodeChild) | undefined;
activator?: false | ((arg: {
isActive: boolean;
props: Record<string, any>;
}) => vue.VNodeChild) | undefined;
} | undefined;
} & {
"v-slot:default"?: false | ((arg: {
isActive: vue.Ref<boolean>;
}) => vue.VNodeChild) | undefined;
"v-slot:activator"?: false | ((arg: {
isActive: boolean;
props: Record<string, any>;
}) => vue.VNodeChild) | undefined;
} & {
"onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
}, {}, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
'update:modelValue': (value: boolean) => boolean;
}, string, {
absolute: boolean;
location: Anchor;
origin: NonNullable<"auto" | Anchor | "overlap">;
inset: boolean;
transition: NonNullable<NonNullable<string | boolean | (vue.TransitionProps & {
component?: vue.Component | undefined;
})> | {
component: vue.Component;
}>;
zIndex: NonNullable<string | number>;
style: vue.StyleValue;
eager: boolean;
disabled: boolean;
contentClass: any;
modelValue: boolean;
locationStrategy: "connected" | "static" | ((data: LocationStrategyData, props: StrategyProps$1, contentStyles: vue.Ref<Record<string, string>>) => {
updateLocation: (e: Event) => void;
} | undefined);
scrollStrategy: NonNullable<"none" | "block" | "close" | ((data: ScrollStrategyData, props: StrategyProps, scope: vue.EffectScope) => void) | "reposition">;
activatorProps: Record<string, any>;
openOnClick: boolean;
openOnHover: boolean;
openOnFocus: boolean;
closeOnContentClick: boolean;
closeOnBack: boolean;
contained: boolean;
noClickAnimation: boolean;
persistent: boolean;
scrim: string | boolean;
fullscreen: boolean;
retainFocus: boolean;
scrollable: boolean;
}, {}, string, vue.SlotsType<Partial<{
default: (arg: {
isActive: vue.Ref<boolean>;
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
activator: (arg: {
isActive: boolean;
props: Record<string, any>;
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
}>>> & {
beforeCreate?: ((() => void) | (() => void)[]) | undefined;
created?: ((() => void) | (() => void)[]) | undefined;
beforeMount?: ((() => void) | (() => void)[]) | undefined;
mounted?: ((() => void) | (() => void)[]) | undefined;
beforeUpdate?: ((() => void) | (() => void)[]) | undefined;
updated?: ((() => void) | (() => void)[]) | undefined;
activated?: ((() => void) | (() => void)[]) | undefined;
deactivated?: ((() => void) | (() => void)[]) | undefined;
beforeDestroy?: ((() => void) | (() => void)[]) | undefined;
beforeUnmount?: ((() => void) | (() => void)[]) | undefined;
destroyed?: ((() => void) | (() => void)[]) | undefined;
unmounted?: ((() => void) | (() => void)[]) | undefined;
renderTracked?: (((e: vue.DebuggerEvent) => void) | ((e: vue.DebuggerEvent) => void)[]) | undefined;
renderTriggered?: (((e: vue.DebuggerEvent) => void) | ((e: vue.DebuggerEvent) => void)[]) | undefined;
errorCaptured?: (((err: unknown, instance: vue.ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, vue.ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null, info: string) => boolean | void) | ((err: unknown, instance: vue.ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, vue.ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null, info: string) => boolean | void)[]) | undefined;
};
$forceUpdate: () => void;
$nextTick: typeof vue.nextTick;
$watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (args_0: R, args_1: R) => any : (...args: any) => any, options?: vue.WatchOptions<boolean> | undefined): vue.WatchStopHandle;
} & {
absolute: boolean;
location: Anchor;
origin: NonNullable<"auto" | Anchor | "overlap">;
inset: boolean;
transition: NonNullable<NonNullable<string | boolean | (vue.TransitionProps & {
component?: vue.Component | undefined;
})> | {
component: vue.Component;
}>;
zIndex: NonNullable<string | number>;
style: vue.StyleValue;
eager: boolean;
disabled: boolean;
modelValue: boolean;
locationStrategy: "connected" | "static" | ((data: LocationStrategyData, props: StrategyProps$1, contentStyles: vue.Ref<Record<string, string>>) => {
updateLocation: (e: Event) => void;
} | undefined);
scrollStrategy: NonNullable<"none" | "block" | "close" | ((data: ScrollStrategyData, props: StrategyProps, scope: vue.EffectScope) => void) | "reposition">;
activatorProps: Record<string, any>;
openOnHover: boolean;
closeOnContentClick: boolean;
closeOnBack: boolean;
contained: boolean;
noClickAnimation: boolean;
persistent: boolean;
scrim: string | boolean;
fullscreen: boolean;
retainFocus: boolean;
scrollable: boolean;
} & {
offset?: string | number | number[] | undefined;
height?: string | number | undefined;
width?: string | number | undefined;
maxHeight?: string | number | undefined;
maxWidth?: string | number | undefined;
minHeight?: string | number | undefined;
minWidth?: string | number | undefined;
class?: any;
theme?: string | undefined;
contentClass?: any;
activator?: string | Element | vue.ComponentPublicInstance | undefined;
closeDelay?: string | number | undefined;
openDelay?: string | number | undefined;
openOnClick?: boolean | undefined;
openOnFocus?: boolean | undefined;
contentProps?: any;
attach?: string | boolean | Element | undefined;
} & {
$children?: vue.VNodeChild | {
default?: ((arg: {
isActive: vue.Ref<boolean>;
}) => vue.VNodeChild) | undefined;
activator?: ((arg: {
isActive: boolean;
props: Record<string, any>;
}) => vue.VNodeChild) | undefined;
} | ((arg: {
isActive: vue.Ref<boolean>;
}) => vue.VNodeChild);
'v-slots'?: {
default?: false | ((arg: {
isActive: vue.Ref<boolean>;
}) => vue.VNodeChild) | undefined;
activator?: false | ((arg: {
isActive: boolean;
props: Record<string, any>;
}) => vue.VNodeChild) | undefined;
} | undefined;
} & {
"v-slot:default"?: false | ((arg: {
isActive: vue.Ref<boolean>;
}) => vue.VNodeChild) | undefined;
"v-slot:activator"?: false | ((arg: {
isActive: boolean;
props: Record<string, any>;
}) => vue.VNodeChild) | undefined;
} & {
"onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
} & vue.ShallowUnwrapRef<{}> & {} & vue.ComponentCustomProperties & {};
__isFragment?: undefined;
__isTeleport?: undefined;
__isSuspense?: undefined;
} & vue.ComponentOptionsBase<{
absolute: boolean;
location: Anchor;
origin: NonNullable<"auto" | Anchor | "overlap">;
inset: boolean;
transition: NonNullable<NonNullable<string | boolean | (vue.TransitionProps & {
component?: vue.Component | undefined;
})> | {
component: vue.Component;
}>;
zIndex: NonNullable<string | number>;
style: vue.StyleValue;
eager: boolean;
disabled: boolean;
modelValue: boolean;
locationStrategy: "connected" | "static" | ((data: LocationStrategyData, props: StrategyProps$1, contentStyles: vue.Ref<Record<string, string>>) => {
updateLocation: (e: Event) => void;
} | undefined);
scrollStrategy: NonNullable<"none" | "block" | "close" | ((data: ScrollStrategyData, props: StrategyProps, scope: vue.EffectScope) => void) | "reposition">;
activatorProps: Record<string, any>;
openOnHover: boolean;
closeOnContentClick: boolean;
closeOnBack: boolean;
contained: boolean;
noClickAnimation: boolean;
persistent: boolean;
scrim: string | boolean;
fullscreen: boolean;
retainFocus: boolean;
scrollable: boolean;
} & {
offset?: string | number | number[] | undefined;
height?: string | number | undefined;
width?: string | number | undefined;
maxHeight?: string | number | undefined;
maxWidth?: string | number | undefined;
minHeight?: string | number | undefined;
minWidth?: string | number | undefined;
class?: any;
theme?: string | undefined;
contentClass?: any;
activator?: string | Element | vue.ComponentPublicInstance | undefined;
closeDelay?: string | number | undefined;
openDelay?: string | number | undefined;
openOnClick?: boolean | undefined;
openOnFocus?: boolean | undefined;
contentProps?: any;
attach?: string | boolean | Element | undefined;
} & {
$children?: vue.VNodeChild | {
default?: ((arg: {
isActive: vue.Ref<boolean>;
}) => vue.VNodeChild) | undefined;
activator?: ((arg: {
isActive: boolean;
props: Record<string, any>;
}) => vue.VNodeChild) | undefined;
} | ((arg: {
isActive: vue.Ref<boolean>;
}) => vue.VNodeChild);
'v-slots'?: {
default?: false | ((arg: {
isActive: vue.Ref<boolean>;
}) => vue.VNodeChild) | undefined;
activator?: false | ((arg: {
isActive: boolean;
props: Record<string, any>;
}) => vue.VNodeChild) | undefined;
} | undefined;
} & {
"v-slot:default"?: false | ((arg: {
isActive: vue.Ref<boolean>;
}) => vue.VNodeChild) | undefined;
"v-slot:activator"?: false | ((arg: {
isActive: boolean;
props: Record<string, any>;
}) => vue.VNodeChild) | undefined;
} & {
"onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
}, {}, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
'update:modelValue': (value: boolean) => boolean;
}, string, {
absolute: boolean;
location: Anchor;
origin: NonNullable<"auto" | Anchor | "overlap">;
inset: boolean;
transition: NonNullable<NonNullable<string | boolean | (vue.TransitionProps & {
component?: vue.Component | undefined;
})> | {
component: vue.Component;
}>;
zIndex: NonNullable<string | number>;
style: vue.StyleValue;
eager: boolean;
disabled: boolean;
contentClass: any;
modelValue: boolean;
locationStrategy: "connected" | "static" | ((data: LocationStrategyData, props: StrategyProps$1, contentStyles: vue.Ref<Record<string, string>>) => {
updateLocation: (e: Event) => void;
} | undefined);
scrollStrategy: NonNullable<"none" | "block" | "close" | ((data: ScrollStrategyData, props: StrategyProps, scope: vue.EffectScope) => void) | "reposition">;
activatorProps: Record<string, any>;
openOnClick: boolean;
openOnHover: boolean;
openOnFocus: boolean;
closeOnContentClick: boolean;
closeOnBack: boolean;
contained: boolean;
noClickAnimation: boolean;
persistent: boolean;
scrim: string | boolean;
fullscreen: boolean;
retainFocus: boolean;
scrollable: boolean;
}, {}, string, vue.SlotsType<Partial<{
default: (arg: {
isActive: vue.Ref<boolean>;
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
activator: (arg: {
isActive: boolean;
props: Record<string, any>;
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
}>>> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & FilterPropsOptions<{
transition: Omit<Omit<{
type: vue.PropType<string | boolean | (vue.TransitionProps & {
component?: vue.Component | undefined;
})>;
default: string;
validator: (val: unknown) => boolean;
}, "type" | "default"> & {
type: vue.PropType<NonNullable<string | boolean | (vue.TransitionProps & {
component?: vue.Component | undefined;
})> | {
component: vue.Component;
}>;
default: NonNullable<string | boolean | (vue.TransitionProps & {
component?: vue.Component | undefined;
})> | {
component: vue.Component;
};
}, "type" | "default"> & {
type: vue.PropType<NonNullable<NonNullable<string | boolean | (vue.TransitionProps & {
component?: vue.Component | undefined;
})> | {
component: vue.Component;
}>>;
default: NonNullable<NonNullable<string | boolean | (vue.TransitionProps & {
component?: vue.Component | undefined;
})> | {
component: vue.Component;
}>;
};
theme: StringConstructor;
scrollStrategy: Omit<{
type: vue.PropType<"none" | "block" | "close" | ((data: ScrollStrategyData, props: StrategyProps, scope: vue.EffectScope) => void) | "reposition">;
default: string;
validator: (val: any) => boolean;
}, "type" | "default"> & {
type: vue.PropType<NonNullable<"none" | "block" | "close" | ((data: ScrollStrategyData, props: StrategyProps, scope: vue.EffectScope) => void) | "reposition">>;
default: NonNullable<"none" | "block" | "close" | ((data: ScrollStrategyData, props: StrategyProps, scope: vue.EffectScope) => void) | "reposition">;
};
locationStrategy: {
type: vue.PropType<"connected" | "static" | ((data: LocationStrategyData, props: StrategyProps$1, contentStyles: vue.Ref<Record<string, string>>) => {
updateLocation: (e: Event) => void;
} | undefined)>;
default: string;
validator: (val: any) => boolean;
};
location: {
type: vue.PropType<Anchor>;
default: string;
};
origin: Omit<{
type: vue.PropType<"auto" | Anchor | "overlap">;
default: string;
}, "type" | "default"> & {
type: vue.PropType<NonNullable<"auto" | Anchor | "overlap">>;
default: NonNullable<"auto" | Anchor | "overlap">;
};
offset: vue.PropType<string | number | number[] | undefined>;
eager: BooleanConstructor;
height: (StringConstructor | NumberConstructor)[];
maxHeight: (StringConstructor | NumberConstructor)[];
maxWidth: (StringConstructor | NumberConstructor)[];
minHeight: (StringConstructor | NumberConstructor)[];
minWidth: (StringConstructor | NumberConstructor)[];
width: (StringConstructor | NumberConstructor)[];
class: vue.PropType<any>;
style: {
type: vue.PropType<vue.StyleValue>;
default: null;
};
closeDelay: (StringConstructor | NumberConstructor)[];
openDelay: (StringConstructor | NumberConstructor)[];
activator: vue.PropType<string | Element | vue.ComponentPublicInstance | undefined>;
activatorProps: {
type: vue.PropType<Record<string, any>>;
default: () => {};
};
openOnClick: {
type: BooleanConstructor;
default: undefined;
};
openOnHover: BooleanConstructor;
openOnFocus: {
type: BooleanConstructor;
default: undefined;
};
closeOnContentClick: BooleanConstructor;
absolute: BooleanConstructor;
attach: vue.PropType<string | boolean | Element>;
closeOnBack: {
type: BooleanConstructor;
default: boolean;
};
contained: BooleanConstructor;
contentClass: {
type: vue.PropType<any>;
default: any;
};
contentProps: null;
disabled: BooleanConstructor;
noClickAnimation: BooleanConstructor;
modelValue: BooleanConstructor;
persistent: BooleanConstructor;
scrim: {
type: (StringConstructor | BooleanConstructor)[];
default: boolean;
};
zIndex: Omit<{
type: (StringConstructor | NumberConstructor)[];
default: number;
}, "type" | "default"> & {
type: vue.PropType<NonNullable<string | number>>;
default: NonNullable<string | number>;
};
fullscreen: BooleanConstructor;
retainFocus: {
type: BooleanConstructor;
default: boolean;
};
scrollable: BooleanConstructor;
inset: BooleanConstructor;
}, vue.ExtractPropTypes<{
transition: Omit<Omit<{
type: vue.PropType<string | boolean | (vue.TransitionProps & {
component?: vue.Component | undefined;
})>;
default: string;
validator: (val: unknown) => boolean;
}, "type" | "default"> & {
type: vue.PropType<NonNullable<string | boolean | (vue.TransitionProps & {
component?: vue.Component | undefined;
})> | {
component: vue.Component;
}>;
default: NonNullable<string | boolean | (vue.TransitionProps & {
component?: vue.Component | undefined;
})> | {
component: vue.Component;
};
}, "type" | "default"> & {
type: vue.PropType<NonNullable<NonNullable<string | boolean | (vue.TransitionProps & {
component?: vue.Component | undefined;
})> | {
component: vue.Component;
}>>;
default: NonNullable<NonNullable<string | boolean | (vue.TransitionProps & {
component?: vue.Component | undefined;
})> | {
component: vue.Component;
}>;
};
theme: StringConstructor;
scrollStrategy: Omit<{
type: vue.PropType<"none" | "block" | "close" | ((data: ScrollStrategyData, props: StrategyProps, scope: vue.EffectScope) => void) | "reposition">;
default: string;
validator: (val: any) => boolean;
}, "type" | "default"> & {
type: vue.PropType<NonNullable<"none" | "block" | "close" | ((data: ScrollStrategyData, props: StrategyProps, scope: vue.EffectScope) => void) | "reposition">>;
default: NonNullable<"none" | "block" | "close" | ((data: ScrollStrategyData, props: StrategyProps, scope: vue.EffectScope) => void) | "reposition">;
};
locationStrategy: {
type: vue.PropType<"connected" | "static" | ((data: LocationStrategyData, props: StrategyProps$1, contentStyles: vue.Ref<Record<string, string>>) => {
updateLocation: (e: Event) => void;
} | undefined)>;
default: string;
validator: (val: any) => boolean;
};
location: {
type: vue.PropType<Anchor>;
default: string;
};
origin: Omit<{
type: vue.PropType<"auto" | Anchor | "overlap">;
default: string;
}, "type" | "default"> & {
type: vue.PropType<NonNullable<"auto" | Anchor | "overlap">>;
default: NonNullable<"auto" | Anchor | "overlap">;
};
offset: vue.PropType<string | number | number[] | undefined>;
eager: BooleanConstructor;
height: (StringConstructor | NumberConstructor)[];
maxHeight: (StringConstructor | NumberConstructor)[];
maxWidth: (StringConstructor | NumberConstructor)[];
minHeight: (StringConstructor | NumberConstructor)[];
minWidth: (StringConstructor | NumberConstructor)[];
width: (StringConstructor | NumberConstructor)[];
class: vue.PropType<any>;
style: {
type: vue.PropType<vue.StyleValue>;
default: null;
};
closeDelay: (StringConstructor | NumberConstructor)[];
openDelay: (StringConstructor | NumberConstructor)[];
activator: vue.PropType<string | Element | vue.ComponentPublicInstance | undefined>;
activatorProps: {
type: vue.PropType<Record<string, any>>;
default: () => {};
};
openOnClick: {
type: BooleanConstructor;
default: undefined;
};
openOnHover: BooleanConstructor;
openOnFocus: {
type: BooleanConstructor;
default: undefined;
};
closeOnContentClick: BooleanConstructor;
absolute: BooleanConstructor;
attach: vue.PropType<string | boolean | Element>;
closeOnBack: {
type: BooleanConstructor;
default: boolean;
};
contained: BooleanConstructor;
contentClass: {
type: vue.PropType<any>;
default: any;
};
contentProps: null;
disabled: BooleanConstructor;
noClickAnimation: BooleanConstructor;
modelValue: BooleanConstructor;
persistent: BooleanConstructor;
scrim: {
type: (StringConstructor | BooleanConstructor)[];
default: boolean;
};
zIndex: Omit<{
type: (StringConstructor | NumberConstructor)[];
default: number;
}, "type" | "default"> & {
type: vue.PropType<NonNullable<string | number>>;
default: NonNullable<string | number>;
};
fullscreen: BooleanConstructor;
retainFocus: {
type: BooleanConstructor;
default: boolean;
};
scrollable: BooleanConstructor;
inset: BooleanConstructor;
}>>;
type VBottomSheet = InstanceType<typeof VBottomSheet>;
type SortItem = {
key: string;
order?: boolean | 'asc' | 'desc';
};
declare function provideSort(options: {
sortBy: Ref<readonly SortItem[]>;
mustSort: Ref<boolean>;
multiSort: Ref<boolean>;
page?: Ref<number>;
}): {
sortBy: Ref<readonly SortItem[]>;
toggleSort: (column: InternalDataTableHeader) => void;
isSorted: (column: InternalDataTableHeader) => boolean;
};
interface GroupableItem<T = any> {
type: 'item';
raw: T;
}
interface Group<T = any> {
type: 'group';
depth: number;
id: string;
key: string;
value: any;
items: readonly (T | Group<T>)[];
}
declare function provideGroupBy(options: {
groupBy: Ref<readonly SortItem[]>;
sortBy: Ref<readonly SortItem[]>;
}): {
sortByWithGroups: vue.ComputedRef<SortItem[]>;
toggleGroup: (group: Group) => void;
opened: Ref<Set<string>>;
groupBy: Ref<readonly SortItem[]>;
extractRows: <T extends GroupableItem<any>>(items: readonly (T | Group<T>)[]) => T[];
isGroupOpen: (group: Group) => boolean;
};
interface DataTableItemProps {
items: any[];
itemValue: SelectItemKey;
itemSelectable: SelectItemKey;
returnObject: boolean;
}
interface SelectableItem {
value: any;
selectable: boolean;
}
type SelectionProps = Pick<DataTableItemProps, 'itemValue'> & {
modelValue: readonly any[];
selectStrategy: 'single' | 'page' | 'all';
'onUpdate:modelValue': ((value: any[]) => void) | undefined;
};
declare function provideSelection(props: SelectionProps, { allItems, currentPage }: {
allItems: Ref<SelectableItem[]>;
currentPage: Ref<SelectableItem[]>;
}): {
toggleSelect: (item: SelectableItem) => void;
select: (items: SelectableItem[], value: boolean) => void;
selectAll: (value: boolean) => void;
isSelected: (items: SelectableItem | SelectableItem[]) => boolean;
isSomeSelected: (items: SelectableItem | SelectableItem[]) => boolean;
someSelected: vue.ComputedRef<boolean>;
allSelected: vue.ComputedRef<boolean>;
showSelectAll: boolean;
};
type DataTableCompareFunction<T = any> = (a: T, b: T) => number;
type DataTableHeader = {
key: string;
value?: SelectItemKey;
title: string;
colspan?: number;
rowspan?: number;
fixed?: boolean;
align?: 'start' | 'end' | 'center';
width?: number | string;
minWidth?: string;
maxWidth?: string;
sortable?: boolean;
sort?: DataTableCompareFunction;
};
type InternalDataTableHeader = DataTableHeader & {
sortable: boolean;
fixedOffset?: number;
lastFixed?: boolean;
};
interface DataTableItem<T = any> extends GroupableItem<T>, SelectableItem {
index: number;
columns: {
[key: string]: any;
};
}
/**
* - match without highlight
* - single match (index), length already known
* - single match (start, end)
* - multiple matches (start, end), probably shouldn't overlap
*/
type FilterMatch = boolean | number | [number, number] | [number, number][];
type FilterFunction = (value: string, query: string, item?: any) => FilterMatch;
type FilterKeyFunctions = Record<string, FilterFunction>;
type FilterKeys = string | string[];
type FilterMode = 'some' | 'every' | 'union' | 'intersection';
type ExpandProps = {
expandOnClick: boolean;
expanded: readonly string[];
'onUpdate:expanded': ((value: any[]) => void) | undefined;
};
declare function provideExpanded(props: ExpandProps): {
expand: (item: DataTableItem, value: boolean) => void;
expanded: Ref<Set<string>> & {
readonly externalValue: readonly string[];
};
expandOnClick: Ref<boolean>;
isExpanded: (item: DataTableItem) => boolean;
toggleExpand: (item: DataTableItem) => void;
};
declare function providePagination(options: {
page: Ref<number>;
itemsPerPage: Ref<number>;
itemsLength: Ref<number>;
}): {
page: Ref<number>;
itemsPerPage: Ref<number>;
startIndex: vue.ComputedRef<number>;
stopIndex: vue.ComputedRef<number>;
pageCount: vue.ComputedRef<number>;
itemsLength: Ref<number>;
nextPage: () => void;
prevPage: () => void;
setPage: (value: number) => void;
setItemsPerPage: (value: number) => void;
};
interface DataIteratorItem<T = any> extends GroupableItem<T>, SelectableItem {
value: unknown;
}
type VDataIteratorSlotProps = {
page: number;
itemsPerPage: number;
sortBy: readonly SortItem[];
pageCount: number;
toggleSort: ReturnType<typeof provideSort>['toggleSort'];
prevPage: ReturnType<typeof providePagination>['prevPage'];
nextPage: ReturnType<typeof providePagination>['nextPage'];
setPage: ReturnType<typeof providePagination>['setPage'];
setItemsPerPage: ReturnType<typeof providePagination>['setItemsPerPage'];
isSelected: ReturnType<typeof provideSelection>['isSelected'];
select: ReturnType<typeof provideSelection>['select'];
selectAll: ReturnType<typeof provideSelection>['selectAll'];
toggleSelect: ReturnType<typeof provideSelection>['toggleSelect'];
isExpanded: ReturnType<typeof provideExpanded>['isExpanded'];
toggleExpand: ReturnType<typeof provideExpanded>['toggleExpand'];
isGroupOpen: ReturnType<typeof provideGroupBy>['isGroupOpen'];
toggleGroup: ReturnType<typeof provideGroupBy>['toggleGroup'];
items: readonly DataIteratorItem[];
groupedItems: readonly (DataIteratorItem | Group<DataIteratorItem>)[];
};
declare const VDataIterator: {
new (...args: any[]): {
$: vue.ComponentInternalInstance;
$data: {};
$props: {
loading?: boolean | undefined;
style?: vue.StyleValue | undefined;
expanded?: readonly string[] | undefined;
tag?: string | undefined;
page?: string | number | undefined;
sortBy?: readonly SortItem[] | undefined;
items?: any[] | undefined;
modelValue?: readonly any[] | undefined;
selectStrategy?: "all" | "page" | "single" | undefined;
itemValue?: SelectItemKey | undefined;
returnObject?: boolean | undefined;
filterMode?: FilterMode | undefined;
noFilter?: boolean | undefined;
itemSelectable?: SelectItemKey | undefined;
showSelect?: boolean | undefined;
multiSort?: boolean | undefined;
mustSort?: boolean | undefined;
groupBy?: readonly SortItem[] | undefined;
expandOnClick?: boolean | undefined;
showExpand?: boolean | undefined;
itemsPerPage?: NonNullable<string | number> | undefined;
search?: string | undefined;
key?: string | number | symbol | undefined;
class?: any;
$children?: vue.VNodeChild | {
default?: ((arg: VDataIteratorSlotProps) => vue.VNodeChild) | undefined;
header?: ((arg: VDataIteratorSlotProps) => vue.VNodeChild) | undefined;
footer?: ((arg: VDataIteratorSlotProps) => vue.VNodeChild) | undefined;
'no-data'?: (() => vue.VNodeChild) | undefined;
} | ((arg: VDataIteratorSlotProps) => vue.VNodeChild);
ref?: vue.VNodeRef | undefined;
ref_for?: boolean | undefined;
ref_key?: string | undefined;
"v-slot:default"?: false | ((arg: VDataIteratorSlotProps) => vue.VNodeChild) | undefined;
'v-slots'?: {
default?: false | ((arg: VDataIteratorSlotProps) => vue.VNodeChild) | undefined;
header?: false | ((arg: VDataIteratorSlotProps) => vue.VNodeChild) | undefined;
footer?: false | ((arg: VDataIteratorSlotProps) => vue.VNodeChild) | undefined;
'no-data'?: false | (() => vue.VNodeChild) | undefined;
} | undefined;
onVnodeBeforeMount?: ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void) | ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void)[] | undefined;
onVnodeMounted?: ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void) | ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void)[] | undefined;
onVnodeBeforeUpdate?: ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, oldVNode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void) | ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, oldVNode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void)[] | undefined;
onVnodeUpdated?: ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, oldVNode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void) | ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>, oldVNode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void)[] | undefined;
onVnodeBeforeUnmount?: ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void) | ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void)[] | undefined;
onVnodeUnmounted?: ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void) | ((vnode: vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>) => void)[] | undefined;
"onUpdate:modelValue"?: ((value: any[]) => any) | undefined;
"v-slot:header"?: false | ((arg: VDataIteratorSlotProps) => vue.VNodeChild) | undefined;
"v-slot:no-data"?: false | (() => vue.VNodeChild) | undefined;
customFilter?: FilterFunction | undefined;
customKeyFilter?: FilterKeyFunctions | undefined;
filterKeys?: FilterKeys | undefined;
customKeySort?: Record<string, DataTableCompareFunction> | undefined;
"onUpdate:sortBy"?: ((value: any) => any) | undefined;
"onUpdate:groupBy"?: ((value: any) => any) | undefined;
"onUpdate:expanded"?: ((value: any) => any) | undefined;
"onUpdate:page"?: ((value: number) => any) | undefined;
"onUpdate:itemsPerPage"?: ((value: number) => any) | undefined;
"onUpdate:options"?: ((value: any) => any) | undefined;
"v-slot:footer"?: false | ((arg: VDataIteratorSlotProps) => vue.VNodeChild) | undefined;
};
$attrs: {
[x: string]: unknown;
};
$refs: {
[x: string]: unknown;
};
$slots: Readonly<{
default?: ((arg: VDataIteratorSlotProps) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[]) | undefined;
header?: ((arg: VDataIteratorSlotProps) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[]) | undefined;
footer?: ((arg: VDataIteratorSlotProps) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[]) | undefined;
'no-data'?: (() => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[]) | undefined;
}>;
$root: vue.ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, vue.ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null;
$parent: vue.ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, vue.ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null;
$emit: ((event: "update:modelValue", value: any[]) => void) & ((event: "update:options", value: any) => void) & ((event: "update:groupBy", value: any) => void) & ((event: "update:page", value: number) => void) & ((event: "update:itemsPerPage", value: number) => void) & ((event: "update:sortBy", value: any) => void) & ((event: "update:expanded", value: any) => void);
$el: any;
$options: vue.ComponentOptionsBase<{
loading: boolean;
style: vue.StyleValue;
expanded: readonly string[];
tag: string;
page: string | number;
sortBy: readonly SortItem[];
items: any[];
modelValue: readonly any[];
selectStrategy: "all" | "page" | "single";
itemValue: SelectItemKey;
returnObject: boolean;
filterMode: FilterMode;
noFilter: boolean;
itemSelectable: SelectItemKey;
showSelect: boolean;
multiSort: boolean;
mustSort: boolean;
groupBy: readonly SortItem[];
expandOnClick: boolean;
showExpand: boolean;
itemsPerPage: NonNullable<string | number>;
} & {
search?: string | undefined;
class?: any;
customFilter?: FilterFunction | undefined;
customKeyFilter?: FilterKeyFunctions | undefined;
filterKeys?: FilterKeys | undefined;
customKeySort?: Record<string, DataTableCompareFunction> | undefined;
} & {
$children?: vue.VNodeChild | {
default?: ((arg: VDataIteratorSlotProps) => vue.VNodeChild) | undefined;
header?: ((arg: VDataIteratorSlotProps) => vue.VNodeChild) | undefined;
footer?: ((arg: VDataIteratorSlotProps) => vue.VNodeChild) | undefined;
'no-data'?: (() => vue.VNodeChild) | undefined;
} | ((arg: VDataIteratorSlotProps) => vue.VNodeChild);
'v-slots'?: {
default?: false | ((arg: VDataIteratorSlotProps) => vue.VNodeChild) | undefined;
header?: false | ((arg: VDataIteratorSlotProps) => vue.VNodeChild)