@vuetify/nightly 3.6.14-master.2024-08-04 → 3.6.14-master.2024-08-13

package/lib/components/VDataIterator/index.d.mts

@@ -1,5 +1,22 @@
 import * as vue from 'vue';
-import { ComponentPropsOptions, ExtractPropTypes, VNodeChild, VNode, PropType, Ref, Component } from 'vue';
+import { Ref, ComponentPropsOptions, ExtractPropTypes, VNodeChild, VNode, PropType, Component } from 'vue';
+
+type ClassValue = any;
+
+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;
+};
 
 type SlotsToProps<U extends RawSlots, T = MakeInternalSlots<U>> = {
     $children?: (VNodeChild | (T extends {
@@ -33,78 +50,7 @@ interface FilterPropsOptions<PropsOptions extends Readonly<ComponentPropsOptions
 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 EventProp<T extends any[] = any[], F = (...args: T) => void> = F;
-declare const EventProp: <T extends any[] = any[]>() => PropType<(...args: T) => void>;
-
-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;
-};
-
-/**
- * - 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?: InternalItem) => FilterMatch;
-type FilterKeyFunctions = Record<string, FilterFunction>;
-type FilterKeys = string | string[];
-type FilterMode = 'some' | 'every' | 'union' | 'intersection';
-interface InternalItem<T = any> {
-    value: any;
-    raw: T;
-}
-
-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[]>;
-    disableSort?: Ref<boolean>;
-}): {
-    sortByWithGroups: vue.ComputedRef<SortItem[]>;
-    toggleGroup: (group: Group) => void;
-    opened: Ref<Set<string> & Omit<Set<string>, keyof Set<any>>>;
-    groupBy: Ref<readonly SortItem[]>;
-    extractRows: <T extends GroupableItem<any>>(items: readonly (T | Group<T>)[]) => T[];
-    isGroupOpen: (group: Group) => boolean;
-};
+declare const EventProp: <T extends any[] = any[]>() => PropType<EventProp<T>>;
 
 interface DataTableItemProps {
     items: any[];
@@ -137,6 +83,22 @@ declare function provideSelection(props: SelectionProps, { allItems, currentPage
     showSelectAll: vue.ComputedRef<boolean>;
 };
 
+/**
+ * - 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?: InternalItem) => FilterMatch;
+type FilterKeyFunctions = Record<string, FilterFunction>;
+type FilterKeys = string | string[];
+type FilterMode = 'some' | 'every' | 'union' | 'intersection';
+interface InternalItem<T = any> {
+    value: any;
+    raw: T;
+}
+
 type DataTableCompareFunction<T = any> = (a: T, b: T) => number | null;
 type DataTableHeader<T = Record<string, any>> = {
     key?: 'data-table-group' | 'data-table-select' | 'data-table-expand' | (string & {});
@@ -190,6 +152,56 @@ type ItemKeySlot<T> = ItemSlotBase<T> & {
 };
 type HeaderCellProps = Record<string, any> | ((data: Pick<ItemKeySlot<any>, 'index' | 'item' | 'internalItem' | 'value'>) => Record<string, any>);
 
+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[]>;
+    disableSort?: Ref<boolean>;
+}): {
+    sortByWithGroups: vue.ComputedRef<SortItem[]>;
+    toggleGroup: (group: Group) => void;
+    opened: Ref<Set<string> & Omit<Set<string>, keyof Set<any>>>;
+    groupBy: Ref<readonly SortItem[]>;
+    extractRows: <T extends GroupableItem>(items: readonly (T | Group<T>)[]) => T[];
+    isGroupOpen: (group: Group) => boolean;
+};
+
+interface DataIteratorItemProps {
+    items: any[];
+    itemValue: SelectItemKey;
+    itemSelectable: SelectItemKey;
+    returnObject: boolean;
+}
+interface DataIteratorItem<T = any> extends GroupableItem<T>, SelectableItem {
+    value: unknown;
+}
+
 declare function providePagination(options: {
     page: Ref<number>;
     itemsPerPage: Ref<number>;
@@ -207,10 +219,6 @@ declare function providePagination(options: {
     setItemsPerPage: (value: number) => void;
 };
 
-interface DataIteratorItem<T = any> extends GroupableItem<T>, SelectableItem {
-    value: unknown;
-}
-
 interface LoaderSlotProps {
     color: string | undefined;
     isActive: boolean;
@@ -247,15 +255,15 @@ type VDataIteratorSlots<T> = {
 declare const VDataIterator: {
     new (...args: any[]): vue.CreateComponentPublicInstance<{
         page: string | number;
-        transition: NonNullable<string | boolean | (vue.TransitionProps & {
-            component?: Component | undefined;
-        })> | {
+        transition: string | boolean | (vue.TransitionProps & {
+            component?: Component;
+        }) | {
             component: Component;
             hideOnLeave: boolean;
         };
+        expanded: readonly string[];
         loading: boolean;
         style: vue.StyleValue;
-        expanded: readonly string[];
         tag: string;
         sortBy: readonly SortItem[];
         modelValue: readonly any[];
@@ -272,7 +280,7 @@ declare const VDataIterator: {
         showSelect: boolean;
         expandOnClick: boolean;
         showExpand: boolean;
-        itemsPerPage: NonNullable<string | number>;
+        itemsPerPage: string | number;
     } & {
         search?: string | undefined;
         class?: any;
@@ -290,25 +298,25 @@ declare const VDataIterator: {
         "onUpdate:options"?: ((value: any) => any) | undefined;
         "onUpdate:currentItems"?: ((value: any) => any) | undefined;
     }, {}, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, Omit<{
-        'update:modelValue': (value: any[]) => boolean;
-        'update:groupBy': (value: any) => boolean;
-        'update:page': (value: number) => boolean;
-        'update:itemsPerPage': (value: number) => boolean;
-        'update:sortBy': (value: any) => boolean;
-        'update:options': (value: any) => boolean;
-        'update:expanded': (value: any) => boolean;
-        'update:currentItems': (value: any) => boolean;
-    }, "$children" | "v-slot:default" | "v-slots" | "items" | "v-slot:loader" | "v-slot:header" | "v-slot:no-data" | "v-slot:footer">, vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
+        'update:modelValue': (value: any[]) => true;
+        'update:groupBy': (value: any) => true;
+        'update:page': (value: number) => true;
+        'update:itemsPerPage': (value: number) => true;
+        'update:sortBy': (value: any) => true;
+        'update:options': (value: any) => true;
+        'update:expanded': (value: any) => true;
+        'update:currentItems': (value: any) => true;
+    }, "$children" | "v-slots" | "v-slot:default" | "items" | "v-slot:loader" | "v-slot:header" | "v-slot:no-data" | "v-slot:footer">, vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & {
         page: string | number;
-        transition: NonNullable<string | boolean | (vue.TransitionProps & {
-            component?: Component | undefined;
-        })> | {
+        transition: string | boolean | (vue.TransitionProps & {
+            component?: Component;
+        }) | {
             component: Component;
             hideOnLeave: boolean;
         };
+        expanded: readonly string[];
         loading: boolean;
         style: vue.StyleValue;
-        expanded: readonly string[];
         tag: string;
         sortBy: readonly SortItem[];
         modelValue: readonly any[];
@@ -325,7 +333,7 @@ declare const VDataIterator: {
         showSelect: boolean;
         expandOnClick: boolean;
         showExpand: boolean;
-        itemsPerPage: NonNullable<string | number>;
+        itemsPerPage: string | number;
     } & {
         search?: string | undefined;
         class?: any;
@@ -344,15 +352,15 @@ declare const VDataIterator: {
         "onUpdate:currentItems"?: ((value: any) => any) | undefined;
     }, {
         page: string | number;
-        transition: NonNullable<string | boolean | (vue.TransitionProps & {
-            component?: Component | undefined;
-        })> | {
+        transition: string | boolean | (vue.TransitionProps & {
+            component?: Component;
+        }) | {
             component: Component;
             hideOnLeave: boolean;
         };
+        expanded: readonly string[];
         loading: boolean;
         style: vue.StyleValue;
-        expanded: readonly string[];
         tag: string;
         sortBy: readonly SortItem[];
         modelValue: readonly any[];
@@ -369,23 +377,13 @@ declare const VDataIterator: {
         showSelect: boolean;
         expandOnClick: boolean;
         showExpand: boolean;
-        itemsPerPage: NonNullable<string | number>;
+        itemsPerPage: string | number;
     }, true, {}, vue.SlotsType<Partial<{
-        default: (arg: VDataIteratorSlotProps<unknown>) => vue.VNode<vue.RendererNode, vue.RendererElement, {
-            [key: string]: any;
-        }>[];
-        header: (arg: VDataIteratorSlotProps<unknown>) => vue.VNode<vue.RendererNode, vue.RendererElement, {
-            [key: string]: any;
-        }>[];
-        footer: (arg: VDataIteratorSlotProps<unknown>) => vue.VNode<vue.RendererNode, vue.RendererElement, {
-            [key: string]: any;
-        }>[];
-        loader: (arg: LoaderSlotProps) => vue.VNode<vue.RendererNode, vue.RendererElement, {
-            [key: string]: any;
-        }>[];
-        'no-data': () => vue.VNode<vue.RendererNode, vue.RendererElement, {
-            [key: string]: any;
-        }>[];
+        default: (arg: VDataIteratorSlotProps<unknown>) => vue.VNode[];
+        header: (arg: VDataIteratorSlotProps<unknown>) => vue.VNode[];
+        footer: (arg: VDataIteratorSlotProps<unknown>) => vue.VNode[];
+        loader: (arg: LoaderSlotProps) => vue.VNode[];
+        'no-data': () => vue.VNode[];
     }>>, {
         P: {};
         B: {};
@@ -395,15 +393,15 @@ declare const VDataIterator: {
         Defaults: {};
     }, {
         page: string | number;
-        transition: NonNullable<string | boolean | (vue.TransitionProps & {
-            component?: Component | undefined;
-        })> | {
+        transition: string | boolean | (vue.TransitionProps & {
+            component?: Component;
+        }) | {
             component: Component;
             hideOnLeave: boolean;
         };
+        expanded: readonly string[];
         loading: boolean;
         style: vue.StyleValue;
-        expanded: readonly string[];
         tag: string;
         sortBy: readonly SortItem[];
         modelValue: readonly any[];
@@ -420,7 +418,7 @@ declare const VDataIterator: {
         showSelect: boolean;
         expandOnClick: boolean;
         showExpand: boolean;
-        itemsPerPage: NonNullable<string | number>;
+        itemsPerPage: string | number;
     } & {
         search?: string | undefined;
         class?: any;
@@ -439,15 +437,15 @@ declare const VDataIterator: {
         "onUpdate:currentItems"?: ((value: any) => any) | undefined;
     }, {}, {}, {}, {}, {
         page: string | number;
-        transition: NonNullable<string | boolean | (vue.TransitionProps & {
-            component?: Component | undefined;
-        })> | {
+        transition: string | boolean | (vue.TransitionProps & {
+            component?: Component;
+        }) | {
             component: Component;
             hideOnLeave: boolean;
         };
+        expanded: readonly string[];
         loading: boolean;
         style: vue.StyleValue;
-        expanded: readonly string[];
         tag: string;
         sortBy: readonly SortItem[];
         modelValue: readonly any[];
@@ -464,22 +462,22 @@ declare const VDataIterator: {
         showSelect: boolean;
         expandOnClick: boolean;
         showExpand: boolean;
-        itemsPerPage: NonNullable<string | number>;
+        itemsPerPage: string | number;
     }>;
-    __isFragment?: undefined;
-    __isTeleport?: undefined;
-    __isSuspense?: undefined;
+    __isFragment?: never;
+    __isTeleport?: never;
+    __isSuspense?: never;
 } & vue.ComponentOptionsBase<{
     page: string | number;
-    transition: NonNullable<string | boolean | (vue.TransitionProps & {
-        component?: Component | undefined;
-    })> | {
+    transition: string | boolean | (vue.TransitionProps & {
+        component?: Component;
+    }) | {
         component: Component;
         hideOnLeave: boolean;
     };
+    expanded: readonly string[];
     loading: boolean;
     style: vue.StyleValue;
-    expanded: readonly string[];
     tag: string;
     sortBy: readonly SortItem[];
     modelValue: readonly any[];
@@ -496,7 +494,7 @@ declare const VDataIterator: {
     showSelect: boolean;
     expandOnClick: boolean;
     showExpand: boolean;
-    itemsPerPage: NonNullable<string | number>;
+    itemsPerPage: string | number;
 } & {
     search?: string | undefined;
     class?: any;
@@ -514,25 +512,25 @@ declare const VDataIterator: {
     "onUpdate:options"?: ((value: any) => any) | undefined;
     "onUpdate:currentItems"?: ((value: any) => any) | undefined;
 }, {}, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, Omit<{
-    'update:modelValue': (value: any[]) => boolean;
-    'update:groupBy': (value: any) => boolean;
-    'update:page': (value: number) => boolean;
-    'update:itemsPerPage': (value: number) => boolean;
-    'update:sortBy': (value: any) => boolean;
-    'update:options': (value: any) => boolean;
-    'update:expanded': (value: any) => boolean;
-    'update:currentItems': (value: any) => boolean;
-}, "$children" | "v-slot:default" | "v-slots" | "items" | "v-slot:loader" | "v-slot:header" | "v-slot:no-data" | "v-slot:footer">, string, {
+    'update:modelValue': (value: any[]) => true;
+    'update:groupBy': (value: any) => true;
+    'update:page': (value: number) => true;
+    'update:itemsPerPage': (value: number) => true;
+    'update:sortBy': (value: any) => true;
+    'update:options': (value: any) => true;
+    'update:expanded': (value: any) => true;
+    'update:currentItems': (value: any) => true;
+}, "$children" | "v-slots" | "v-slot:default" | "items" | "v-slot:loader" | "v-slot:header" | "v-slot:no-data" | "v-slot:footer">, string, {
     page: string | number;
-    transition: NonNullable<string | boolean | (vue.TransitionProps & {
-        component?: Component | undefined;
-    })> | {
+    transition: string | boolean | (vue.TransitionProps & {
+        component?: Component;
+    }) | {
         component: Component;
         hideOnLeave: boolean;
     };
+    expanded: readonly string[];
     loading: boolean;
     style: vue.StyleValue;
-    expanded: readonly string[];
     tag: string;
     sortBy: readonly SortItem[];
     modelValue: readonly any[];
@@ -549,43 +547,31 @@ declare const VDataIterator: {
     showSelect: boolean;
     expandOnClick: boolean;
     showExpand: boolean;
-    itemsPerPage: NonNullable<string | number>;
+    itemsPerPage: string | number;
 }, {}, string, vue.SlotsType<Partial<{
-    default: (arg: VDataIteratorSlotProps<unknown>) => vue.VNode<vue.RendererNode, vue.RendererElement, {
-        [key: string]: any;
-    }>[];
-    header: (arg: VDataIteratorSlotProps<unknown>) => vue.VNode<vue.RendererNode, vue.RendererElement, {
-        [key: string]: any;
-    }>[];
-    footer: (arg: VDataIteratorSlotProps<unknown>) => vue.VNode<vue.RendererNode, vue.RendererElement, {
-        [key: string]: any;
-    }>[];
-    loader: (arg: LoaderSlotProps) => vue.VNode<vue.RendererNode, vue.RendererElement, {
-        [key: string]: any;
-    }>[];
-    'no-data': () => vue.VNode<vue.RendererNode, vue.RendererElement, {
-        [key: string]: any;
-    }>[];
+    default: (arg: VDataIteratorSlotProps<unknown>) => vue.VNode[];
+    header: (arg: VDataIteratorSlotProps<unknown>) => vue.VNode[];
+    footer: (arg: VDataIteratorSlotProps<unknown>) => vue.VNode[];
+    loader: (arg: LoaderSlotProps) => vue.VNode[];
+    'no-data': () => vue.VNode[];
 }>>> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & (new <T>(props: {
-    items?: readonly T[] | undefined;
-}, slots: VDataIteratorSlots<T>) => GenericProps<{
-    items?: readonly T[] | undefined;
-}, VDataIteratorSlots<T>>) & FilterPropsOptions<{
+    items?: readonly T[];
+}, slots: VDataIteratorSlots<T>) => GenericProps<typeof props, typeof slots>) & FilterPropsOptions<{
     transition: Omit<{
         type: vue.PropType<string | boolean | (vue.TransitionProps & {
-            component?: Component | undefined;
+            component?: Component;
         })>;
         default: string;
         validator: (val: unknown) => boolean;
     }, "type" | "default"> & {
-        type: vue.PropType<NonNullable<string | boolean | (vue.TransitionProps & {
-            component?: Component | undefined;
-        })> | {
+        type: vue.PropType<string | boolean | (vue.TransitionProps & {
+            component?: Component;
+        }) | {
             component: Component;
             hideOnLeave: boolean;
         }>;
         default: NonNullable<string | boolean | (vue.TransitionProps & {
-            component?: Component | undefined;
+            component?: Component;
         })> | {
             component: Component;
             hideOnLeave: boolean;
@@ -621,7 +607,7 @@ declare const VDataIterator: {
         type: (StringConstructor | NumberConstructor)[];
         default: number;
     }, "type" | "default"> & {
-        type: vue.PropType<NonNullable<string | number>>;
+        type: vue.PropType<string | number>;
         default: NonNullable<string | number>;
     };
     sortBy: {
@@ -633,7 +619,7 @@ declare const VDataIterator: {
     mustSort: BooleanConstructor;
     showSelect: BooleanConstructor;
     selectStrategy: {
-        type: vue.PropType<"all" | "page" | "single">;
+        type: vue.PropType<"single" | "page" | "all">;
         default: string;
     };
     modelValue: {
@@ -645,7 +631,7 @@ declare const VDataIterator: {
         default: typeof deepEqual;
     };
     items: {
-        type: vue.PropType<any[]>;
+        type: vue.PropType<DataIteratorItemProps["items"]>;
         default: () => never[];
     };
     itemValue: {
@@ -657,7 +643,7 @@ declare const VDataIterator: {
         default: null;
     };
     returnObject: BooleanConstructor;
-    class: vue.PropType<any>;
+    class: vue.PropType<ClassValue>;
     style: {
         type: vue.PropType<vue.StyleValue>;
         default: null;
@@ -667,19 +653,19 @@ declare const VDataIterator: {
 }, vue.ExtractPropTypes<{
     transition: Omit<{
         type: vue.PropType<string | boolean | (vue.TransitionProps & {
-            component?: Component | undefined;
+            component?: Component;
         })>;
         default: string;
         validator: (val: unknown) => boolean;
     }, "type" | "default"> & {
-        type: vue.PropType<NonNullable<string | boolean | (vue.TransitionProps & {
-            component?: Component | undefined;
-        })> | {
+        type: vue.PropType<string | boolean | (vue.TransitionProps & {
+            component?: Component;
+        }) | {
             component: Component;
             hideOnLeave: boolean;
         }>;
         default: NonNullable<string | boolean | (vue.TransitionProps & {
-            component?: Component | undefined;
+            component?: Component;
         })> | {
             component: Component;
             hideOnLeave: boolean;
@@ -715,7 +701,7 @@ declare const VDataIterator: {
         type: (StringConstructor | NumberConstructor)[];
         default: number;
     }, "type" | "default"> & {
-        type: vue.PropType<NonNullable<string | number>>;
+        type: vue.PropType<string | number>;
         default: NonNullable<string | number>;
     };
     sortBy: {
@@ -727,7 +713,7 @@ declare const VDataIterator: {
     mustSort: BooleanConstructor;
     showSelect: BooleanConstructor;
     selectStrategy: {
-        type: vue.PropType<"all" | "page" | "single">;
+        type: vue.PropType<"single" | "page" | "all">;
         default: string;
     };
     modelValue: {
@@ -739,7 +725,7 @@ declare const VDataIterator: {
         default: typeof deepEqual;
     };
     items: {
-        type: vue.PropType<any[]>;
+        type: vue.PropType<DataIteratorItemProps["items"]>;
         default: () => never[];
     };
     itemValue: {
@@ -751,7 +737,7 @@ declare const VDataIterator: {
         default: null;
     };
     returnObject: BooleanConstructor;
-    class: vue.PropType<any>;
+    class: vue.PropType<ClassValue>;
     style: {
         type: vue.PropType<vue.StyleValue>;
         default: null;