vuetify
Version:
Vue Material Component Framework
1,346 lines (1,333 loc) • 83 kB
text/typescript
import * as vue from 'vue';
import { ComponentPropsOptions, ExtractPropTypes, VNodeChild, VNode, JSXComponent, PropType } from 'vue';
// @ts-ignore
import * as vue_router from 'vue-router';
type SlotsToProps<U extends RawSlots, T = MakeInternalSlots<U>> = {
$children?: (VNodeChild | (T extends {
default: infer V;
} ? V : {}) | {
[K in keyof T]?: T[K];
});
'v-slots'?: {
[K in keyof T]?: T[K] | false;
};
} & {
[K in keyof T as `v-slot:${K & string}`]?: T[K] | false;
};
type RawSlots = Record<string, unknown>;
type Slot<T> = [T] extends [never] ? () => VNodeChild : (arg: T) => VNodeChild;
type VueSlot<T> = [T] extends [never] ? () => VNode[] : (arg: T) => VNode[];
type MakeInternalSlots<T extends RawSlots> = {
[K in keyof T]: Slot<T[K]>;
};
type MakeSlots<T extends RawSlots> = {
[K in keyof T]: VueSlot<T[K]>;
};
type GenericProps<Props, Slots extends Record<string, unknown>> = {
$props: Props & SlotsToProps<Slots>;
$slots: MakeSlots<Slots>;
};
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): Partial<Pick<T, U>>;
}
declare function deepEqual(a: any, b: any): boolean;
type SelectItemKey<T = Record<string, any>> = boolean | null | undefined | string | readonly (string | number)[] | ((item: T, fallback?: any) => any);
type Density = null | 'default' | 'comfortable' | 'compact';
type IconValue = string | (string | [path: string, opacity: number])[] | JSXComponent;
declare const IconValue: PropType<IconValue>;
type ListItemSlot = {
isActive: boolean;
isSelected: boolean;
isIndeterminate: boolean;
select: (value: boolean) => void;
};
type ListItemTitleSlot = {
title?: string | number;
};
type ListItemSubtitleSlot = {
subtitle?: string | number;
};
type VListItemSlots = {
prepend: ListItemSlot;
append: ListItemSlot;
default: ListItemSlot;
title: ListItemTitleSlot;
subtitle: ListItemSubtitleSlot;
};
declare const VListItem: {
new (...args: any[]): vue.CreateComponentPublicInstance<{
replace: boolean;
style: vue.StyleValue;
nav: boolean;
disabled: boolean;
tag: string;
variant: NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
exact: boolean;
tile: boolean;
density: Density;
slim: boolean;
ripple: boolean | {
class: string;
} | undefined;
} & {
link?: boolean | undefined;
onClick?: ((args_0: MouseEvent) => void) | undefined;
class?: any;
title?: string | number | undefined;
value?: any;
width?: string | number | undefined;
height?: string | number | undefined;
active?: boolean | undefined;
theme?: string | undefined;
href?: string | undefined;
color?: string | undefined;
to?: vue_router.RouteLocationRaw | undefined;
border?: string | number | boolean | undefined;
rounded?: string | number | boolean | undefined;
onClickOnce?: ((args_0: MouseEvent) => void) | undefined;
maxHeight?: string | number | undefined;
maxWidth?: string | number | undefined;
minHeight?: string | number | undefined;
minWidth?: string | number | undefined;
elevation?: string | number | undefined;
baseColor?: string | undefined;
prependIcon?: IconValue | undefined;
appendIcon?: IconValue | undefined;
activeClass?: string | undefined;
appendAvatar?: string | undefined;
prependAvatar?: string | undefined;
activeColor?: string | undefined;
subtitle?: string | number | undefined;
lines?: false | "one" | "two" | "three" | undefined;
} & {
$children?: vue.VNodeChild | {
prepend?: ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
append?: ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
default?: ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
title?: ((arg: ListItemTitleSlot) => vue.VNodeChild) | undefined;
subtitle?: ((arg: ListItemSubtitleSlot) => vue.VNodeChild) | undefined;
} | ((arg: ListItemSlot) => vue.VNodeChild);
'v-slots'?: {
prepend?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
append?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
default?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
title?: false | ((arg: ListItemTitleSlot) => vue.VNodeChild) | undefined;
subtitle?: false | ((arg: ListItemSubtitleSlot) => vue.VNodeChild) | undefined;
} | undefined;
} & {
"v-slot:prepend"?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
"v-slot:append"?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
"v-slot:default"?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
"v-slot:title"?: false | ((arg: ListItemTitleSlot) => vue.VNodeChild) | undefined;
"v-slot:subtitle"?: false | ((arg: ListItemSubtitleSlot) => vue.VNodeChild) | undefined;
} & {
onClick?: ((e: KeyboardEvent | MouseEvent) => any) | undefined;
}, {
isGroupActivator: boolean | undefined;
isSelected: vue.ComputedRef<boolean>;
list: {
hasPrepend: vue.Ref<boolean>;
updateHasPrepend: (value: boolean) => void;
} | null;
select: (selected: boolean, e?: Event | undefined) => void;
}, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
click: (e: MouseEvent | KeyboardEvent) => true;
}, vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
replace: boolean;
style: vue.StyleValue;
nav: boolean;
disabled: boolean;
tag: string;
variant: NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
exact: boolean;
tile: boolean;
density: Density;
slim: boolean;
ripple: boolean | {
class: string;
} | undefined;
} & {
link?: boolean | undefined;
onClick?: ((args_0: MouseEvent) => void) | undefined;
class?: any;
title?: string | number | undefined;
value?: any;
width?: string | number | undefined;
height?: string | number | undefined;
active?: boolean | undefined;
theme?: string | undefined;
href?: string | undefined;
color?: string | undefined;
to?: vue_router.RouteLocationRaw | undefined;
border?: string | number | boolean | undefined;
rounded?: string | number | boolean | undefined;
onClickOnce?: ((args_0: MouseEvent) => void) | undefined;
maxHeight?: string | number | undefined;
maxWidth?: string | number | undefined;
minHeight?: string | number | undefined;
minWidth?: string | number | undefined;
elevation?: string | number | undefined;
baseColor?: string | undefined;
prependIcon?: IconValue | undefined;
appendIcon?: IconValue | undefined;
activeClass?: string | undefined;
appendAvatar?: string | undefined;
prependAvatar?: string | undefined;
activeColor?: string | undefined;
subtitle?: string | number | undefined;
lines?: false | "one" | "two" | "three" | undefined;
} & {
$children?: vue.VNodeChild | {
prepend?: ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
append?: ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
default?: ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
title?: ((arg: ListItemTitleSlot) => vue.VNodeChild) | undefined;
subtitle?: ((arg: ListItemSubtitleSlot) => vue.VNodeChild) | undefined;
} | ((arg: ListItemSlot) => vue.VNodeChild);
'v-slots'?: {
prepend?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
append?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
default?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
title?: false | ((arg: ListItemTitleSlot) => vue.VNodeChild) | undefined;
subtitle?: false | ((arg: ListItemSubtitleSlot) => vue.VNodeChild) | undefined;
} | undefined;
} & {
"v-slot:prepend"?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
"v-slot:append"?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
"v-slot:default"?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
"v-slot:title"?: false | ((arg: ListItemTitleSlot) => vue.VNodeChild) | undefined;
"v-slot:subtitle"?: false | ((arg: ListItemSubtitleSlot) => vue.VNodeChild) | undefined;
} & {
onClick?: ((e: KeyboardEvent | MouseEvent) => any) | undefined;
}, {
replace: boolean;
link: boolean;
style: vue.StyleValue;
nav: boolean;
active: boolean;
disabled: boolean;
tag: string;
rounded: string | number | boolean;
variant: NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
exact: boolean;
tile: boolean;
density: Density;
slim: boolean;
ripple: boolean | {
class: string;
} | undefined;
}, true, {}, vue.SlotsType<Partial<{
prepend: (arg: ListItemSlot) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
append: (arg: ListItemSlot) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
default: (arg: ListItemSlot) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
title: (arg: ListItemTitleSlot) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
subtitle: (arg: ListItemSubtitleSlot) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
}>>, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, {
replace: boolean;
style: vue.StyleValue;
nav: boolean;
disabled: boolean;
tag: string;
variant: NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
exact: boolean;
tile: boolean;
density: Density;
slim: boolean;
ripple: boolean | {
class: string;
} | undefined;
} & {
link?: boolean | undefined;
onClick?: ((args_0: MouseEvent) => void) | undefined;
class?: any;
title?: string | number | undefined;
value?: any;
width?: string | number | undefined;
height?: string | number | undefined;
active?: boolean | undefined;
theme?: string | undefined;
href?: string | undefined;
color?: string | undefined;
to?: vue_router.RouteLocationRaw | undefined;
border?: string | number | boolean | undefined;
rounded?: string | number | boolean | undefined;
onClickOnce?: ((args_0: MouseEvent) => void) | undefined;
maxHeight?: string | number | undefined;
maxWidth?: string | number | undefined;
minHeight?: string | number | undefined;
minWidth?: string | number | undefined;
elevation?: string | number | undefined;
baseColor?: string | undefined;
prependIcon?: IconValue | undefined;
appendIcon?: IconValue | undefined;
activeClass?: string | undefined;
appendAvatar?: string | undefined;
prependAvatar?: string | undefined;
activeColor?: string | undefined;
subtitle?: string | number | undefined;
lines?: false | "one" | "two" | "three" | undefined;
} & {
$children?: vue.VNodeChild | {
prepend?: ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
append?: ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
default?: ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
title?: ((arg: ListItemTitleSlot) => vue.VNodeChild) | undefined;
subtitle?: ((arg: ListItemSubtitleSlot) => vue.VNodeChild) | undefined;
} | ((arg: ListItemSlot) => vue.VNodeChild);
'v-slots'?: {
prepend?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
append?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
default?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
title?: false | ((arg: ListItemTitleSlot) => vue.VNodeChild) | undefined;
subtitle?: false | ((arg: ListItemSubtitleSlot) => vue.VNodeChild) | undefined;
} | undefined;
} & {
"v-slot:prepend"?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
"v-slot:append"?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
"v-slot:default"?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
"v-slot:title"?: false | ((arg: ListItemTitleSlot) => vue.VNodeChild) | undefined;
"v-slot:subtitle"?: false | ((arg: ListItemSubtitleSlot) => vue.VNodeChild) | undefined;
} & {
onClick?: ((e: KeyboardEvent | MouseEvent) => any) | undefined;
}, {
isGroupActivator: boolean | undefined;
isSelected: vue.ComputedRef<boolean>;
list: {
hasPrepend: vue.Ref<boolean>;
updateHasPrepend: (value: boolean) => void;
} | null;
select: (selected: boolean, e?: Event | undefined) => void;
}, {}, {}, {}, {
replace: boolean;
link: boolean;
style: vue.StyleValue;
nav: boolean;
active: boolean;
disabled: boolean;
tag: string;
rounded: string | number | boolean;
variant: NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
exact: boolean;
tile: boolean;
density: Density;
slim: boolean;
ripple: boolean | {
class: string;
} | undefined;
}>;
__isFragment?: undefined;
__isTeleport?: undefined;
__isSuspense?: undefined;
} & vue.ComponentOptionsBase<{
replace: boolean;
style: vue.StyleValue;
nav: boolean;
disabled: boolean;
tag: string;
variant: NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
exact: boolean;
tile: boolean;
density: Density;
slim: boolean;
ripple: boolean | {
class: string;
} | undefined;
} & {
link?: boolean | undefined;
onClick?: ((args_0: MouseEvent) => void) | undefined;
class?: any;
title?: string | number | undefined;
value?: any;
width?: string | number | undefined;
height?: string | number | undefined;
active?: boolean | undefined;
theme?: string | undefined;
href?: string | undefined;
color?: string | undefined;
to?: vue_router.RouteLocationRaw | undefined;
border?: string | number | boolean | undefined;
rounded?: string | number | boolean | undefined;
onClickOnce?: ((args_0: MouseEvent) => void) | undefined;
maxHeight?: string | number | undefined;
maxWidth?: string | number | undefined;
minHeight?: string | number | undefined;
minWidth?: string | number | undefined;
elevation?: string | number | undefined;
baseColor?: string | undefined;
prependIcon?: IconValue | undefined;
appendIcon?: IconValue | undefined;
activeClass?: string | undefined;
appendAvatar?: string | undefined;
prependAvatar?: string | undefined;
activeColor?: string | undefined;
subtitle?: string | number | undefined;
lines?: false | "one" | "two" | "three" | undefined;
} & {
$children?: vue.VNodeChild | {
prepend?: ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
append?: ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
default?: ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
title?: ((arg: ListItemTitleSlot) => vue.VNodeChild) | undefined;
subtitle?: ((arg: ListItemSubtitleSlot) => vue.VNodeChild) | undefined;
} | ((arg: ListItemSlot) => vue.VNodeChild);
'v-slots'?: {
prepend?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
append?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
default?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
title?: false | ((arg: ListItemTitleSlot) => vue.VNodeChild) | undefined;
subtitle?: false | ((arg: ListItemSubtitleSlot) => vue.VNodeChild) | undefined;
} | undefined;
} & {
"v-slot:prepend"?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
"v-slot:append"?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
"v-slot:default"?: false | ((arg: ListItemSlot) => vue.VNodeChild) | undefined;
"v-slot:title"?: false | ((arg: ListItemTitleSlot) => vue.VNodeChild) | undefined;
"v-slot:subtitle"?: false | ((arg: ListItemSubtitleSlot) => vue.VNodeChild) | undefined;
} & {
onClick?: ((e: KeyboardEvent | MouseEvent) => any) | undefined;
}, {
isGroupActivator: boolean | undefined;
isSelected: vue.ComputedRef<boolean>;
list: {
hasPrepend: vue.Ref<boolean>;
updateHasPrepend: (value: boolean) => void;
} | null;
select: (selected: boolean, e?: Event | undefined) => void;
}, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
click: (e: MouseEvent | KeyboardEvent) => true;
}, string, {
replace: boolean;
link: boolean;
style: vue.StyleValue;
nav: boolean;
active: boolean;
disabled: boolean;
tag: string;
rounded: string | number | boolean;
variant: NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
exact: boolean;
tile: boolean;
density: Density;
slim: boolean;
ripple: boolean | {
class: string;
} | undefined;
}, {}, string, vue.SlotsType<Partial<{
prepend: (arg: ListItemSlot) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
append: (arg: ListItemSlot) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
default: (arg: ListItemSlot) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
title: (arg: ListItemTitleSlot) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
subtitle: (arg: ListItemSubtitleSlot) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
}>>> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & FilterPropsOptions<{
color: StringConstructor;
variant: Omit<{
type: PropType<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
default: string;
validator: (v: any) => boolean;
}, "default" | "type"> & {
type: PropType<NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">>;
default: NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
};
theme: StringConstructor;
tag: {
type: StringConstructor;
default: string;
};
href: StringConstructor;
replace: BooleanConstructor;
to: PropType<vue_router.RouteLocationRaw>;
exact: BooleanConstructor;
rounded: {
type: (StringConstructor | NumberConstructor | BooleanConstructor)[];
default: undefined;
};
tile: BooleanConstructor;
elevation: {
type: (StringConstructor | NumberConstructor)[];
validator(v: any): boolean;
};
height: (StringConstructor | NumberConstructor)[];
maxHeight: (StringConstructor | NumberConstructor)[];
maxWidth: (StringConstructor | NumberConstructor)[];
minHeight: (StringConstructor | NumberConstructor)[];
minWidth: (StringConstructor | NumberConstructor)[];
width: (StringConstructor | NumberConstructor)[];
density: {
type: PropType<Density>;
default: string;
validator: (v: any) => boolean;
};
class: PropType<any>;
style: {
type: PropType<vue.StyleValue>;
default: null;
};
border: (StringConstructor | NumberConstructor | BooleanConstructor)[];
active: {
type: BooleanConstructor;
default: undefined;
};
activeClass: StringConstructor;
activeColor: StringConstructor;
appendAvatar: StringConstructor;
appendIcon: PropType<IconValue>;
baseColor: StringConstructor;
disabled: BooleanConstructor;
lines: PropType<false | "one" | "two" | "three">;
link: {
type: BooleanConstructor;
default: undefined;
};
nav: BooleanConstructor;
prependAvatar: StringConstructor;
prependIcon: PropType<IconValue>;
ripple: {
type: PropType<boolean | {
class: string;
} | undefined>;
default: boolean;
};
slim: BooleanConstructor;
subtitle: (StringConstructor | NumberConstructor)[];
title: (StringConstructor | NumberConstructor)[];
value: null;
onClick: PropType<(args_0: MouseEvent) => void>;
onClickOnce: PropType<(args_0: MouseEvent) => void>;
}, vue.ExtractPropTypes<{
color: StringConstructor;
variant: Omit<{
type: PropType<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
default: string;
validator: (v: any) => boolean;
}, "default" | "type"> & {
type: PropType<NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">>;
default: NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
};
theme: StringConstructor;
tag: {
type: StringConstructor;
default: string;
};
href: StringConstructor;
replace: BooleanConstructor;
to: PropType<vue_router.RouteLocationRaw>;
exact: BooleanConstructor;
rounded: {
type: (StringConstructor | NumberConstructor | BooleanConstructor)[];
default: undefined;
};
tile: BooleanConstructor;
elevation: {
type: (StringConstructor | NumberConstructor)[];
validator(v: any): boolean;
};
height: (StringConstructor | NumberConstructor)[];
maxHeight: (StringConstructor | NumberConstructor)[];
maxWidth: (StringConstructor | NumberConstructor)[];
minHeight: (StringConstructor | NumberConstructor)[];
minWidth: (StringConstructor | NumberConstructor)[];
width: (StringConstructor | NumberConstructor)[];
density: {
type: PropType<Density>;
default: string;
validator: (v: any) => boolean;
};
class: PropType<any>;
style: {
type: PropType<vue.StyleValue>;
default: null;
};
border: (StringConstructor | NumberConstructor | BooleanConstructor)[];
active: {
type: BooleanConstructor;
default: undefined;
};
activeClass: StringConstructor;
activeColor: StringConstructor;
appendAvatar: StringConstructor;
appendIcon: PropType<IconValue>;
baseColor: StringConstructor;
disabled: BooleanConstructor;
lines: PropType<false | "one" | "two" | "three">;
link: {
type: BooleanConstructor;
default: undefined;
};
nav: BooleanConstructor;
prependAvatar: StringConstructor;
prependIcon: PropType<IconValue>;
ripple: {
type: PropType<boolean | {
class: string;
} | undefined>;
default: boolean;
};
slim: BooleanConstructor;
subtitle: (StringConstructor | NumberConstructor)[];
title: (StringConstructor | NumberConstructor)[];
value: null;
onClick: PropType<(args_0: MouseEvent) => void>;
onClickOnce: PropType<(args_0: MouseEvent) => void>;
}>>;
type VListItem = InstanceType<typeof VListItem>;
type ActiveStrategyFn = (data: {
id: unknown;
value: boolean;
activated: Set<unknown>;
children: Map<unknown, unknown[]>;
parents: Map<unknown, unknown>;
event?: Event;
}) => Set<unknown>;
type ActiveStrategyTransformInFn = (v: unknown | undefined, children: Map<unknown, unknown[]>, parents: Map<unknown, unknown>) => Set<unknown>;
type ActiveStrategyTransformOutFn = (v: Set<unknown>, children: Map<unknown, unknown[]>, parents: Map<unknown, unknown>) => unknown;
type ActiveStrategy = {
activate: ActiveStrategyFn;
in: ActiveStrategyTransformInFn;
out: ActiveStrategyTransformOutFn;
};
type OpenStrategyFn = (data: {
id: unknown;
value: boolean;
opened: Set<unknown>;
children: Map<unknown, unknown[]>;
parents: Map<unknown, unknown>;
event?: Event;
}) => Set<unknown>;
type OpenSelectStrategyFn = (data: {
id: unknown;
value: boolean;
opened: Set<unknown>;
selected: Map<unknown, 'on' | 'off' | 'indeterminate'>;
children: Map<unknown, unknown[]>;
parents: Map<unknown, unknown>;
event?: Event;
}) => Set<unknown> | null;
type OpenStrategy = {
open: OpenStrategyFn;
select: OpenSelectStrategyFn;
};
type SelectStrategyFn = (data: {
id: unknown;
value: boolean;
selected: Map<unknown, 'on' | 'off' | 'indeterminate'>;
children: Map<unknown, unknown[]>;
parents: Map<unknown, unknown>;
event?: Event;
}) => Map<unknown, 'on' | 'off' | 'indeterminate'>;
type SelectStrategyTransformInFn = (v: readonly unknown[] | undefined, children: Map<unknown, unknown[]>, parents: Map<unknown, unknown>) => Map<unknown, 'on' | 'off' | 'indeterminate'>;
type SelectStrategyTransformOutFn = (v: Map<unknown, 'on' | 'off' | 'indeterminate'>, children: Map<unknown, unknown[]>, parents: Map<unknown, unknown>) => unknown[];
type SelectStrategy = {
select: SelectStrategyFn;
in: SelectStrategyTransformInFn;
out: SelectStrategyTransformOutFn;
};
type ActiveStrategyProp = 'single-leaf' | 'leaf' | 'independent' | 'single-independent' | ActiveStrategy | ((mandatory: boolean) => ActiveStrategy);
type SelectStrategyProp = 'single-leaf' | 'leaf' | 'independent' | 'single-independent' | 'classic' | SelectStrategy | ((mandatory: boolean) => SelectStrategy);
type OpenStrategyProp = 'single' | 'multiple' | 'list' | OpenStrategy;
type VListChildrenSlots<T> = {
[K in keyof Omit<VListItemSlots, 'default'>]: VListItemSlots[K] & {
item: T;
};
} & {
default: never;
item: {
props: InternalListItem['props'];
};
divider: {
props: InternalListItem['props'];
};
subheader: {
props: InternalListItem['props'];
};
header: {
props: InternalListItem['props'];
};
};
interface InternalItem<T = any> {
value: any;
raw: T;
}
interface ListItem<T = any> extends InternalItem<T> {
title: string;
props: {
[key: string]: any;
title: string;
value: any;
};
children?: ListItem<T>[];
}
interface InternalListItem<T = any> extends ListItem<T> {
type?: 'item' | 'subheader' | 'divider';
}
type ItemType<T> = T extends readonly (infer U)[] ? U : never;
declare const VList: {
new (...args: any[]): vue.CreateComponentPublicInstance<{
style: vue.StyleValue;
nav: boolean;
disabled: boolean;
tag: string;
variant: NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
mandatory: boolean;
tile: boolean;
density: Density;
slim: boolean;
valueComparator: typeof deepEqual;
activatable: boolean;
selectable: boolean;
selectStrategy: NonNullable<SelectStrategyProp>;
openStrategy: NonNullable<OpenStrategyProp>;
lines: false | "one" | "two" | "three";
returnObject: boolean;
itemType: string;
} & {
class?: any;
width?: string | number | undefined;
height?: string | number | undefined;
theme?: string | undefined;
color?: string | undefined;
activated?: any;
border?: string | number | boolean | undefined;
rounded?: string | number | boolean | undefined;
maxHeight?: string | number | undefined;
maxWidth?: string | number | undefined;
minHeight?: string | number | undefined;
minWidth?: string | number | undefined;
elevation?: string | number | undefined;
baseColor?: string | undefined;
bgColor?: string | undefined;
activeClass?: string | undefined;
activeStrategy?: ActiveStrategyProp | undefined;
activeColor?: string | undefined;
collapseIcon?: string | undefined;
expandIcon?: string | undefined;
} & {
"onUpdate:activated"?: ((value: unknown) => any) | undefined;
"onClick:open"?: ((value: {
id: unknown;
value: boolean;
path: unknown[];
}) => any) | undefined;
"onClick:select"?: ((value: {
id: unknown;
value: boolean;
path: unknown[];
}) => any) | undefined;
"onClick:activate"?: ((value: {
id: unknown;
value: boolean;
path: unknown[];
}) => any) | undefined;
}, {
open: (id: unknown, value: boolean, event?: Event | undefined) => void;
select: (id: unknown, value: boolean, event?: Event | undefined) => void;
focus: (location?: 'next' | 'prev' | 'first' | 'last') => void;
children: vue.Ref<Map<unknown, unknown[]>>;
parents: vue.Ref<Map<unknown, unknown>>;
}, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, Omit<{
'update:selected': (value: unknown) => boolean;
'update:activated': (value: unknown) => boolean;
'update:opened': (value: unknown) => boolean;
'click:open': (value: {
id: unknown;
value: boolean;
path: unknown[];
}) => boolean;
'click:activate': (value: {
id: unknown;
value: boolean;
path: unknown[];
}) => boolean;
'click:select': (value: {
id: unknown;
value: boolean;
path: unknown[];
}) => boolean;
}, "v-slot:default" | "$children" | "v-slots" | "items" | "v-slot:title" | "v-slot:prepend" | "v-slot:append" | "selected" | "opened" | "v-slot:subtitle" | "v-slot:header" | "v-slot:divider" | "v-slot:item" | "v-slot:subheader" | "itemTitle" | "itemValue" | "itemChildren" | "itemProps" | "update:selected" | "update:opened">, vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
style: vue.StyleValue;
nav: boolean;
disabled: boolean;
tag: string;
variant: NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
mandatory: boolean;
tile: boolean;
density: Density;
slim: boolean;
valueComparator: typeof deepEqual;
activatable: boolean;
selectable: boolean;
selectStrategy: NonNullable<SelectStrategyProp>;
openStrategy: NonNullable<OpenStrategyProp>;
lines: false | "one" | "two" | "three";
returnObject: boolean;
itemType: string;
} & {
class?: any;
width?: string | number | undefined;
height?: string | number | undefined;
theme?: string | undefined;
color?: string | undefined;
activated?: any;
border?: string | number | boolean | undefined;
rounded?: string | number | boolean | undefined;
maxHeight?: string | number | undefined;
maxWidth?: string | number | undefined;
minHeight?: string | number | undefined;
minWidth?: string | number | undefined;
elevation?: string | number | undefined;
baseColor?: string | undefined;
bgColor?: string | undefined;
activeClass?: string | undefined;
activeStrategy?: ActiveStrategyProp | undefined;
activeColor?: string | undefined;
collapseIcon?: string | undefined;
expandIcon?: string | undefined;
} & {
"onUpdate:activated"?: ((value: unknown) => any) | undefined;
"onClick:open"?: ((value: {
id: unknown;
value: boolean;
path: unknown[];
}) => any) | undefined;
"onClick:select"?: ((value: {
id: unknown;
value: boolean;
path: unknown[];
}) => any) | undefined;
"onClick:activate"?: ((value: {
id: unknown;
value: boolean;
path: unknown[];
}) => any) | undefined;
}, {
style: vue.StyleValue;
nav: boolean;
disabled: boolean;
tag: string;
rounded: string | number | boolean;
variant: NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
mandatory: boolean;
tile: boolean;
density: Density;
slim: boolean;
valueComparator: typeof deepEqual;
activatable: boolean;
selectable: boolean;
selectStrategy: NonNullable<SelectStrategyProp>;
openStrategy: NonNullable<OpenStrategyProp>;
lines: false | "one" | "two" | "three";
returnObject: boolean;
itemType: string;
}, true, {}, vue.SlotsType<Partial<{
title: (arg: ListItemTitleSlot & {
item: any;
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
prepend: (arg: {
isActive: boolean;
isSelected: boolean;
isIndeterminate: boolean;
select: (value: boolean) => void;
} & {
item: any;
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
append: (arg: {
isActive: boolean;
isSelected: boolean;
isIndeterminate: boolean;
select: (value: boolean) => void;
} & {
item: any;
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
subtitle: (arg: ListItemSubtitleSlot & {
item: any;
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
default: () => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
item: (arg: {
props: {
[key: string]: any;
title: string;
value: any;
};
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
divider: (arg: {
props: {
[key: string]: any;
title: string;
value: any;
};
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
subheader: (arg: {
props: {
[key: string]: any;
title: string;
value: any;
};
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
header: (arg: {
props: {
[key: string]: any;
title: string;
value: any;
};
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
}>>, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, {
style: vue.StyleValue;
nav: boolean;
disabled: boolean;
tag: string;
variant: NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
mandatory: boolean;
tile: boolean;
density: Density;
slim: boolean;
valueComparator: typeof deepEqual;
activatable: boolean;
selectable: boolean;
selectStrategy: NonNullable<SelectStrategyProp>;
openStrategy: NonNullable<OpenStrategyProp>;
lines: false | "one" | "two" | "three";
returnObject: boolean;
itemType: string;
} & {
class?: any;
width?: string | number | undefined;
height?: string | number | undefined;
theme?: string | undefined;
color?: string | undefined;
activated?: any;
border?: string | number | boolean | undefined;
rounded?: string | number | boolean | undefined;
maxHeight?: string | number | undefined;
maxWidth?: string | number | undefined;
minHeight?: string | number | undefined;
minWidth?: string | number | undefined;
elevation?: string | number | undefined;
baseColor?: string | undefined;
bgColor?: string | undefined;
activeClass?: string | undefined;
activeStrategy?: ActiveStrategyProp | undefined;
activeColor?: string | undefined;
collapseIcon?: string | undefined;
expandIcon?: string | undefined;
} & {
"onUpdate:activated"?: ((value: unknown) => any) | undefined;
"onClick:open"?: ((value: {
id: unknown;
value: boolean;
path: unknown[];
}) => any) | undefined;
"onClick:select"?: ((value: {
id: unknown;
value: boolean;
path: unknown[];
}) => any) | undefined;
"onClick:activate"?: ((value: {
id: unknown;
value: boolean;
path: unknown[];
}) => any) | undefined;
}, {
open: (id: unknown, value: boolean, event?: Event | undefined) => void;
select: (id: unknown, value: boolean, event?: Event | undefined) => void;
focus: (location?: 'next' | 'prev' | 'first' | 'last') => void;
children: vue.Ref<Map<unknown, unknown[]>>;
parents: vue.Ref<Map<unknown, unknown>>;
}, {}, {}, {}, {
style: vue.StyleValue;
nav: boolean;
disabled: boolean;
tag: string;
rounded: string | number | boolean;
variant: NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
mandatory: boolean;
tile: boolean;
density: Density;
slim: boolean;
valueComparator: typeof deepEqual;
activatable: boolean;
selectable: boolean;
selectStrategy: NonNullable<SelectStrategyProp>;
openStrategy: NonNullable<OpenStrategyProp>;
lines: false | "one" | "two" | "three";
returnObject: boolean;
itemType: string;
}>;
__isFragment?: undefined;
__isTeleport?: undefined;
__isSuspense?: undefined;
} & vue.ComponentOptionsBase<{
style: vue.StyleValue;
nav: boolean;
disabled: boolean;
tag: string;
variant: NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
mandatory: boolean;
tile: boolean;
density: Density;
slim: boolean;
valueComparator: typeof deepEqual;
activatable: boolean;
selectable: boolean;
selectStrategy: NonNullable<SelectStrategyProp>;
openStrategy: NonNullable<OpenStrategyProp>;
lines: false | "one" | "two" | "three";
returnObject: boolean;
itemType: string;
} & {
class?: any;
width?: string | number | undefined;
height?: string | number | undefined;
theme?: string | undefined;
color?: string | undefined;
activated?: any;
border?: string | number | boolean | undefined;
rounded?: string | number | boolean | undefined;
maxHeight?: string | number | undefined;
maxWidth?: string | number | undefined;
minHeight?: string | number | undefined;
minWidth?: string | number | undefined;
elevation?: string | number | undefined;
baseColor?: string | undefined;
bgColor?: string | undefined;
activeClass?: string | undefined;
activeStrategy?: ActiveStrategyProp | undefined;
activeColor?: string | undefined;
collapseIcon?: string | undefined;
expandIcon?: string | undefined;
} & {
"onUpdate:activated"?: ((value: unknown) => any) | undefined;
"onClick:open"?: ((value: {
id: unknown;
value: boolean;
path: unknown[];
}) => any) | undefined;
"onClick:select"?: ((value: {
id: unknown;
value: boolean;
path: unknown[];
}) => any) | undefined;
"onClick:activate"?: ((value: {
id: unknown;
value: boolean;
path: unknown[];
}) => any) | undefined;
}, {
open: (id: unknown, value: boolean, event?: Event | undefined) => void;
select: (id: unknown, value: boolean, event?: Event | undefined) => void;
focus: (location?: 'next' | 'prev' | 'first' | 'last') => void;
children: vue.Ref<Map<unknown, unknown[]>>;
parents: vue.Ref<Map<unknown, unknown>>;
}, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, Omit<{
'update:selected': (value: unknown) => boolean;
'update:activated': (value: unknown) => boolean;
'update:opened': (value: unknown) => boolean;
'click:open': (value: {
id: unknown;
value: boolean;
path: unknown[];
}) => boolean;
'click:activate': (value: {
id: unknown;
value: boolean;
path: unknown[];
}) => boolean;
'click:select': (value: {
id: unknown;
value: boolean;
path: unknown[];
}) => boolean;
}, "v-slot:default" | "$children" | "v-slots" | "items" | "v-slot:title" | "v-slot:prepend" | "v-slot:append" | "selected" | "opened" | "v-slot:subtitle" | "v-slot:header" | "v-slot:divider" | "v-slot:item" | "v-slot:subheader" | "itemTitle" | "itemValue" | "itemChildren" | "itemProps" | "update:selected" | "update:opened">, string, {
style: vue.StyleValue;
nav: boolean;
disabled: boolean;
tag: string;
rounded: string | number | boolean;
variant: NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
mandatory: boolean;
tile: boolean;
density: Density;
slim: boolean;
valueComparator: typeof deepEqual;
activatable: boolean;
selectable: boolean;
selectStrategy: NonNullable<SelectStrategyProp>;
openStrategy: NonNullable<OpenStrategyProp>;
lines: false | "one" | "two" | "three";
returnObject: boolean;
itemType: string;
}, {}, string, vue.SlotsType<Partial<{
title: (arg: ListItemTitleSlot & {
item: any;
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
prepend: (arg: {
isActive: boolean;
isSelected: boolean;
isIndeterminate: boolean;
select: (value: boolean) => void;
} & {
item: any;
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
append: (arg: {
isActive: boolean;
isSelected: boolean;
isIndeterminate: boolean;
select: (value: boolean) => void;
} & {
item: any;
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
subtitle: (arg: ListItemSubtitleSlot & {
item: any;
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
default: () => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
item: (arg: {
props: {
[key: string]: any;
title: string;
value: any;
};
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
divider: (arg: {
props: {
[key: string]: any;
title: string;
value: any;
};
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
subheader: (arg: {
props: {
[key: string]: any;
title: string;
value: any;
};
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
header: (arg: {
props: {
[key: string]: any;
title: string;
value: any;
};
}) => vue.VNode<vue.RendererNode, vue.RendererElement, {
[key: string]: any;
}>[];
}>>> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & (new <T extends readonly any[], S = unknown, O = unknown>(props: {
items?: T | undefined;
itemTitle?: SelectItemKey<ItemType<T>>;
itemValue?: SelectItemKey<ItemType<T>>;
itemChildren?: SelectItemKey<ItemType<T>>;
itemProps?: SelectItemKey<ItemType<T>>;
selected?: S | undefined;
'onUpdate:selected'?: ((value: S) => void) | undefined;
opened?: O | undefined;
'onUpdate:opened'?: ((value: O) => void) | undefined;
}, slots: VListChildrenSlots<ItemType<T>>) => GenericProps<{
items?: T | undefined;
itemTitle?: SelectItemKey<ItemType<T>>;
itemValue?: SelectItemKey<ItemType<T>>;
itemChildren?: SelectItemKey<ItemType<T>>;
itemProps?: SelectItemKey<ItemType<T>>;
selected?: S | undefined;
'onUpdate:selected'?: ((value: S) => void) | undefined;
opened?: O | undefined;
'onUpdate:opened'?: ((value: O) => void) | undefined;
}, VListChildrenSlots<ItemType<T>>>) & FilterPropsOptions<{
color: StringConstructor;
variant: Omit<{
type: PropType<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
default: string;
validator: (v: any) => boolean;
}, "default" | "type"> & {
type: PropType<NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">>;
default: NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
};
theme: StringConstructor;
tag: {
type: StringConstructor;
default: string;
};
rounded: {
type: (StringConstructor | NumberConstructor | BooleanConstructor)[];
default: undefined;
};
tile: BooleanConstructor;
items: {
type: PropType<any[]>;
default: () => never[];
};
itemTitle: {
type: PropType<SelectItemKey>;
default: string;
};
itemValue: {
type: PropType<SelectItemKey>;
default: string;
};
itemChildren: {
type: PropType<SelectItemKey>;
default: string;
};
itemProps: {
type: PropType<SelectItemKey>;
default: string;
};
returnObject: BooleanConstructor;
valueComparator: {
type: PropType<typeof deepEqual>;
default: typeof deepEqual;
};
itemType: {
type: StringConstructor;
default: string;
};
elevation: {
type: (StringConstructor | NumberConstructor)[];
validator(v: any): boolean;
};
height: (StringConstructor | NumberConstructor)[];
maxHeight: (StringConstructor | NumberConstructor)[];
maxWidth: (StringConstructor | NumberConstructor)[];
minHeight: (StringConstructor | NumberConstructor)[];
minWidth: (StringConstructor | NumberConstructor)[];
width: (StringConstructor | NumberConstructor)[];
density: {
type: PropType<Density>;
default: string;
validator: (v: any) => boolean;
};
class: PropType<any>;
style: {
type: PropType<vue.StyleValue>;
default: null;
};
border: (StringConstructor | NumberConstructor | BooleanConstructor)[];
activatable: BooleanConstructor;
selectable: BooleanConstructor;
activeStrategy: PropType<ActiveStrategyProp>;
selectStrategy: {
type: PropType<NonNullable<SelectStrategyProp>>;
default: NonNullable<SelectStrategyProp>;
};
openStrategy: {
type: PropType<NonNullable<OpenStrategyProp>>;
default: NonNullable<OpenStrategyProp>;
};
opened: null;
activated: null;
selected: null;
mandatory: BooleanConstructor;
baseColor: StringConstructor;
activeColor: StringConstructor;
activeClass: StringConstructor;
bgColor: StringConstructor;
disabled: BooleanConstructor;
expandIcon: StringConstructor;
collapseIcon: StringConstructor;
lines: {
type: PropType<false | "one" | "two" | "three">;
default: string;
};
slim: BooleanConstructor;
nav: BooleanConstructor;
}, vue.ExtractPropTypes<{
color: StringConstructor;
variant: Omit<{
type: PropType<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
default: string;
validator: (v: any) => boolean;
}, "default" | "type"> & {
type: PropType<NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">>;
default: NonNullable<"flat" | "text" | "elevated" | "tonal" | "outlined" | "plain">;
};
theme: StringConstructor;
tag: {
type: StringConstructor;
default: string;
};
rounded: {
type: (StringConstructor | NumberConstructor | BooleanConstructor)[];
default: undefined;
};
tile: BooleanConstructor;
items: {
type: PropType<any[]>;
default: () => never[];
};
itemTitle: {
type: PropType<SelectItemKey>;
default: string;
};
itemValue: {
type: PropType<SelectItemKey>;
default: string;
};
itemChildren: {
type: PropType<SelectItemKey>;
default: string;
};
itemPr