sprintify-ui 0.1.17 → 0.2.0

package/dist/types/src/components/BaseDataTable.vue.d.ts

@@ -1,383 +1,385 @@
-import { PropType } from 'vue';
-import { CollectionItem, DataIteratorSection, DataTableQuery, MenuItemInterface, RowAction } from '@/types';
-import { RouteLocationRaw } from 'vue-router';
-declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
-    /**
-     * Base URL from which to make requests
-     */
-    url: {
-        required: true;
-        type: StringConstructor;
-    };
-    /**
-     * Query params that always get applied
-     */
-    urlQuery: {
-        default: undefined;
-        type: PropType<Record<string, any>>;
-    };
-    /**
-     * Query params that gets applied by default
-     * These may be overwritten by URL params generated by the data-table or filters
-     */
-    defaultQuery: {
-        default: undefined;
-        type: PropType<DataTableQuery>;
-    };
-    /**
-     * Show url for router link
-     */
-    showUrl: {
-        default: undefined;
-        type: PropType<((row: CollectionItem) => RouteLocationRaw) | undefined>;
-    };
-    /**
-     * Show/Hide edit button
-     */
-    editButton: {
-        default: boolean;
-        type: BooleanConstructor;
-    };
-    /**
-     * Edit url for router link
-     */
-    editUrl: {
-        default: undefined;
-        type: PropType<((row: CollectionItem) => RouteLocationRaw) | undefined>;
-    };
-    /**
-     * Show/Hide delete button
-     */
-    deleteButton: {
-        default: boolean;
-        type: BooleanConstructor;
-    };
-    /**
-     * Delete endpoint to delete an item
-     */
-    deleteUrl: {
-        default: undefined;
-        type: PropType<((row: CollectionItem) => string) | undefined>;
-    };
-    /**
-     * Show toggle-able details on each row
-     */
-    detailed: {
-        default: boolean;
-        type: BooleanConstructor;
-    };
-    /**
-     * Check is a given row has details
-     */
-    hasDetailedVisible: {
-        default(): boolean;
-        type: PropType<(row: any) => boolean>;
-    };
-    /**
-     * Makes row checkable
-     */
-    checkable: {
-        default: boolean;
-        type: BooleanConstructor;
-    };
-    /**
-     * Actions on each row
-     */
-    checkableActions: {
-        default: undefined;
-        type: PropType<MenuItemInterface[]>;
-    };
-    /**
-     * Checked rows array
-     */
-    checkedRows: {
-        default(): never[];
-        type: PropType<Record<string, any>[]>;
-    };
-    /**
-     * Check is a given row is checkable
-     */
-    isRowCheckable: {
-        default(): () => true;
-        type: FunctionConstructor;
-    };
-    /**
-     * Adds a search bar
-     */
-    searchable: {
-        default: boolean;
-        type: BooleanConstructor;
-    };
-    /**
-     * Shows the column toggle utility
-     */
-    toggleable: {
-        default: boolean;
-        type: BooleanConstructor;
-    };
-    /**
-     * Actions
-     */
-    actions: {
-        default: undefined;
-        type: PropType<MenuItemInterface[]>;
-    };
-    /**
-     * Save data table state in URL
-     */
-    historyMode: {
-        default: boolean;
-        type: BooleanConstructor;
-    };
-    maxHeight: {
-        default: undefined;
-        type: NumberConstructor;
-    };
-    /**
-     * Layout type
-     */
-    layout: {
-        default: string;
-        type: PropType<"default" | "compact">;
-    };
-    sections: {
-        default: undefined;
-        type: PropType<DataIteratorSection[]>;
-    };
-    rowActions: {
-        default: undefined;
-        type: PropType<RowAction[]>;
-    };
-    numberOfVisibleRowActions: {
-        default: number;
-        type: NumberConstructor;
-    };
-    /**
-     * Scroll to top when fetching new data
-     */
-    scrollTopOnFetch: {
-        default: boolean;
-        type: BooleanConstructor;
-    };
-}, {
-    fetch: () => void;
-    fetchWithoutLoading: () => void;
-    query: import("vue").ComputedRef<DataTableQuery | null>;
-}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("delete" | "update:checked-rows" | "fetch" | "cell-click")[], "delete" | "update:checked-rows" | "fetch" | "cell-click", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    /**
-     * Base URL from which to make requests
-     */
-    url: {
-        required: true;
-        type: StringConstructor;
-    };
-    /**
-     * Query params that always get applied
-     */
-    urlQuery: {
-        default: undefined;
-        type: PropType<Record<string, any>>;
-    };
-    /**
-     * Query params that gets applied by default
-     * These may be overwritten by URL params generated by the data-table or filters
-     */
-    defaultQuery: {
-        default: undefined;
-        type: PropType<DataTableQuery>;
-    };
-    /**
-     * Show url for router link
-     */
-    showUrl: {
-        default: undefined;
-        type: PropType<((row: CollectionItem) => RouteLocationRaw) | undefined>;
-    };
-    /**
-     * Show/Hide edit button
-     */
-    editButton: {
-        default: boolean;
-        type: BooleanConstructor;
-    };
-    /**
-     * Edit url for router link
-     */
-    editUrl: {
-        default: undefined;
-        type: PropType<((row: CollectionItem) => RouteLocationRaw) | undefined>;
-    };
-    /**
-     * Show/Hide delete button
-     */
-    deleteButton: {
-        default: boolean;
-        type: BooleanConstructor;
-    };
-    /**
-     * Delete endpoint to delete an item
-     */
-    deleteUrl: {
-        default: undefined;
-        type: PropType<((row: CollectionItem) => string) | undefined>;
-    };
-    /**
-     * Show toggle-able details on each row
-     */
-    detailed: {
-        default: boolean;
-        type: BooleanConstructor;
-    };
-    /**
-     * Check is a given row has details
-     */
-    hasDetailedVisible: {
-        default(): boolean;
-        type: PropType<(row: any) => boolean>;
-    };
-    /**
-     * Makes row checkable
-     */
-    checkable: {
-        default: boolean;
-        type: BooleanConstructor;
-    };
-    /**
-     * Actions on each row
-     */
-    checkableActions: {
-        default: undefined;
-        type: PropType<MenuItemInterface[]>;
-    };
-    /**
-     * Checked rows array
-     */
-    checkedRows: {
-        default(): never[];
-        type: PropType<Record<string, any>[]>;
-    };
-    /**
-     * Check is a given row is checkable
-     */
-    isRowCheckable: {
-        default(): () => true;
-        type: FunctionConstructor;
-    };
-    /**
-     * Adds a search bar
-     */
-    searchable: {
-        default: boolean;
-        type: BooleanConstructor;
-    };
-    /**
-     * Shows the column toggle utility
-     */
-    toggleable: {
-        default: boolean;
-        type: BooleanConstructor;
-    };
-    /**
-     * Actions
-     */
-    actions: {
-        default: undefined;
-        type: PropType<MenuItemInterface[]>;
-    };
-    /**
-     * Save data table state in URL
-     */
-    historyMode: {
-        default: boolean;
-        type: BooleanConstructor;
-    };
-    maxHeight: {
-        default: undefined;
-        type: NumberConstructor;
-    };
-    /**
-     * Layout type
-     */
-    layout: {
-        default: string;
-        type: PropType<"default" | "compact">;
-    };
-    sections: {
-        default: undefined;
-        type: PropType<DataIteratorSection[]>;
-    };
-    rowActions: {
-        default: undefined;
-        type: PropType<RowAction[]>;
-    };
-    numberOfVisibleRowActions: {
-        default: number;
-        type: NumberConstructor;
-    };
-    /**
-     * Scroll to top when fetching new data
-     */
-    scrollTopOnFetch: {
-        default: boolean;
-        type: BooleanConstructor;
-    };
-}>> & {
-    onDelete?: ((...args: any[]) => any) | undefined;
-    "onUpdate:checked-rows"?: ((...args: any[]) => any) | undefined;
-    onFetch?: ((...args: any[]) => any) | undefined;
-    "onCell-click"?: ((...args: any[]) => any) | undefined;
-}, {
-    actions: MenuItemInterface[];
-    urlQuery: Record<string, any>;
-    defaultQuery: DataTableQuery;
-    searchable: boolean;
-    historyMode: boolean;
-    layout: "default" | "compact";
-    sections: DataIteratorSection[];
-    scrollTopOnFetch: boolean;
-    detailed: boolean;
-    checkable: boolean;
-    isRowCheckable: Function;
-    checkedRows: Record<string, any>[];
-    hasDetailedVisible: (row: any) => boolean;
-    maxHeight: number;
-    showUrl: ((row: CollectionItem) => RouteLocationRaw) | undefined;
-    editButton: boolean;
-    editUrl: ((row: CollectionItem) => RouteLocationRaw) | undefined;
-    deleteButton: boolean;
-    deleteUrl: ((row: CollectionItem) => string) | undefined;
-    checkableActions: MenuItemInterface[];
-    toggleable: boolean;
-    rowActions: RowAction[];
-    numberOfVisibleRowActions: number;
-}>, Record<string, (_: {}) => any> & {
-    default: (_: {}) => any;
-    detail: (_: {
-        row: import("@/types").Row;
-        index: number;
-    }) => any;
-    checkedHeader: (_: any) => any;
-    filters: (_: {
-        query: {
-            [x: string]: any;
-            page?: number | undefined;
-            sort?: string | undefined;
-            search?: string | undefined;
-            filter?: Record<string, any> | undefined;
-        };
-        updateQuery: (newQuery: DataTableQuery) => void;
-        updateQueryValue: (key: string, value: any) => void;
-    }) => any;
-    sidebarTop: (_: {
-        paginationMetadata: import("@/types").PaginationMetadata | null;
-    }) => any;
-    sidebarBottom: (_: {
-        paginationMetadata: import("@/types").PaginationMetadata | null;
-    }) => any;
-}>;
-export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & {
-    new (): {
-        $slots: S;
-    };
-};
+import { PropType } from 'vue';
+import { CollectionItem, DataIteratorSection, DataTableQuery, MenuItemInterface, RowAction } from '@/types';
+import { RouteLocationRaw } from 'vue-router';
+declare function fetch(): void;
+declare function fetchWithoutLoading(): void;
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    /**
+     * Base URL from which to make requests
+     */
+    url: {
+        required: true;
+        type: StringConstructor;
+    };
+    /**
+     * Query params that always get applied
+     */
+    urlQuery: {
+        default: undefined;
+        type: PropType<Record<string, any>>;
+    };
+    /**
+     * Query params that gets applied by default
+     * These may be overwritten by URL params generated by the data-table or filters
+     */
+    defaultQuery: {
+        default: undefined;
+        type: PropType<DataTableQuery>;
+    };
+    /**
+     * Show url for router link
+     */
+    showUrl: {
+        default: undefined;
+        type: PropType<((row: CollectionItem) => RouteLocationRaw) | undefined>;
+    };
+    /**
+     * Show/Hide edit button
+     */
+    editButton: {
+        default: boolean;
+        type: BooleanConstructor;
+    };
+    /**
+     * Edit url for router link
+     */
+    editUrl: {
+        default: undefined;
+        type: PropType<((row: CollectionItem) => RouteLocationRaw) | undefined>;
+    };
+    /**
+     * Show/Hide delete button
+     */
+    deleteButton: {
+        default: boolean;
+        type: BooleanConstructor;
+    };
+    /**
+     * Delete endpoint to delete an item
+     */
+    deleteUrl: {
+        default: undefined;
+        type: PropType<((row: CollectionItem) => string) | undefined>;
+    };
+    /**
+     * Show toggle-able details on each row
+     */
+    detailed: {
+        default: boolean;
+        type: BooleanConstructor;
+    };
+    /**
+     * Check is a given row has details
+     */
+    hasDetailedVisible: {
+        default(): boolean;
+        type: PropType<(row: any) => boolean>;
+    };
+    /**
+     * Makes row checkable
+     */
+    checkable: {
+        default: boolean;
+        type: BooleanConstructor;
+    };
+    /**
+     * Actions on each row
+     */
+    checkableActions: {
+        default: undefined;
+        type: PropType<MenuItemInterface[]>;
+    };
+    /**
+     * Checked rows array
+     */
+    checkedRows: {
+        default(): never[];
+        type: PropType<Record<string, any>[]>;
+    };
+    /**
+     * Check is a given row is checkable
+     */
+    isRowCheckable: {
+        default(): () => true;
+        type: FunctionConstructor;
+    };
+    /**
+     * Adds a search bar
+     */
+    searchable: {
+        default: boolean;
+        type: BooleanConstructor;
+    };
+    /**
+     * Shows the column toggle utility
+     */
+    toggleable: {
+        default: boolean;
+        type: BooleanConstructor;
+    };
+    /**
+     * Actions
+     */
+    actions: {
+        default: undefined;
+        type: PropType<MenuItemInterface[]>;
+    };
+    /**
+     * Save data table state in URL
+     */
+    historyMode: {
+        default: boolean;
+        type: BooleanConstructor;
+    };
+    maxHeight: {
+        default: undefined;
+        type: NumberConstructor;
+    };
+    /**
+     * Layout type
+     */
+    layout: {
+        default: string;
+        type: PropType<"default" | "compact">;
+    };
+    sections: {
+        default: undefined;
+        type: PropType<DataIteratorSection[]>;
+    };
+    rowActions: {
+        default: undefined;
+        type: PropType<RowAction[]>;
+    };
+    numberOfVisibleRowActions: {
+        default: number;
+        type: NumberConstructor;
+    };
+    /**
+     * Scroll to top when fetching new data
+     */
+    scrollTopOnFetch: {
+        default: boolean;
+        type: BooleanConstructor;
+    };
+}, {
+    fetch: typeof fetch;
+    fetchWithoutLoading: typeof fetchWithoutLoading;
+    query: import("vue").ComputedRef<DataTableQuery | null>;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("delete" | "update:checked-rows" | "fetch" | "cell-click")[], "delete" | "update:checked-rows" | "fetch" | "cell-click", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Base URL from which to make requests
+     */
+    url: {
+        required: true;
+        type: StringConstructor;
+    };
+    /**
+     * Query params that always get applied
+     */
+    urlQuery: {
+        default: undefined;
+        type: PropType<Record<string, any>>;
+    };
+    /**
+     * Query params that gets applied by default
+     * These may be overwritten by URL params generated by the data-table or filters
+     */
+    defaultQuery: {
+        default: undefined;
+        type: PropType<DataTableQuery>;
+    };
+    /**
+     * Show url for router link
+     */
+    showUrl: {
+        default: undefined;
+        type: PropType<((row: CollectionItem) => RouteLocationRaw) | undefined>;
+    };
+    /**
+     * Show/Hide edit button
+     */
+    editButton: {
+        default: boolean;
+        type: BooleanConstructor;
+    };
+    /**
+     * Edit url for router link
+     */
+    editUrl: {
+        default: undefined;
+        type: PropType<((row: CollectionItem) => RouteLocationRaw) | undefined>;
+    };
+    /**
+     * Show/Hide delete button
+     */
+    deleteButton: {
+        default: boolean;
+        type: BooleanConstructor;
+    };
+    /**
+     * Delete endpoint to delete an item
+     */
+    deleteUrl: {
+        default: undefined;
+        type: PropType<((row: CollectionItem) => string) | undefined>;
+    };
+    /**
+     * Show toggle-able details on each row
+     */
+    detailed: {
+        default: boolean;
+        type: BooleanConstructor;
+    };
+    /**
+     * Check is a given row has details
+     */
+    hasDetailedVisible: {
+        default(): boolean;
+        type: PropType<(row: any) => boolean>;
+    };
+    /**
+     * Makes row checkable
+     */
+    checkable: {
+        default: boolean;
+        type: BooleanConstructor;
+    };
+    /**
+     * Actions on each row
+     */
+    checkableActions: {
+        default: undefined;
+        type: PropType<MenuItemInterface[]>;
+    };
+    /**
+     * Checked rows array
+     */
+    checkedRows: {
+        default(): never[];
+        type: PropType<Record<string, any>[]>;
+    };
+    /**
+     * Check is a given row is checkable
+     */
+    isRowCheckable: {
+        default(): () => true;
+        type: FunctionConstructor;
+    };
+    /**
+     * Adds a search bar
+     */
+    searchable: {
+        default: boolean;
+        type: BooleanConstructor;
+    };
+    /**
+     * Shows the column toggle utility
+     */
+    toggleable: {
+        default: boolean;
+        type: BooleanConstructor;
+    };
+    /**
+     * Actions
+     */
+    actions: {
+        default: undefined;
+        type: PropType<MenuItemInterface[]>;
+    };
+    /**
+     * Save data table state in URL
+     */
+    historyMode: {
+        default: boolean;
+        type: BooleanConstructor;
+    };
+    maxHeight: {
+        default: undefined;
+        type: NumberConstructor;
+    };
+    /**
+     * Layout type
+     */
+    layout: {
+        default: string;
+        type: PropType<"default" | "compact">;
+    };
+    sections: {
+        default: undefined;
+        type: PropType<DataIteratorSection[]>;
+    };
+    rowActions: {
+        default: undefined;
+        type: PropType<RowAction[]>;
+    };
+    numberOfVisibleRowActions: {
+        default: number;
+        type: NumberConstructor;
+    };
+    /**
+     * Scroll to top when fetching new data
+     */
+    scrollTopOnFetch: {
+        default: boolean;
+        type: BooleanConstructor;
+    };
+}>> & {
+    onDelete?: ((...args: any[]) => any) | undefined;
+    "onUpdate:checked-rows"?: ((...args: any[]) => any) | undefined;
+    onFetch?: ((...args: any[]) => any) | undefined;
+    "onCell-click"?: ((...args: any[]) => any) | undefined;
+}, {
+    actions: MenuItemInterface[];
+    urlQuery: Record<string, any>;
+    defaultQuery: DataTableQuery;
+    searchable: boolean;
+    historyMode: boolean;
+    layout: "default" | "compact";
+    sections: DataIteratorSection[];
+    scrollTopOnFetch: boolean;
+    detailed: boolean;
+    checkable: boolean;
+    isRowCheckable: Function;
+    checkedRows: Record<string, any>[];
+    hasDetailedVisible: (row: any) => boolean;
+    maxHeight: number;
+    showUrl: ((row: CollectionItem) => RouteLocationRaw) | undefined;
+    editButton: boolean;
+    editUrl: ((row: CollectionItem) => RouteLocationRaw) | undefined;
+    deleteButton: boolean;
+    deleteUrl: ((row: CollectionItem) => string) | undefined;
+    checkableActions: MenuItemInterface[];
+    toggleable: boolean;
+    rowActions: RowAction[];
+    numberOfVisibleRowActions: number;
+}, {}>, Partial<Record<string, (_: {}) => any>> & {
+    default?(_: {}): any;
+    detail?(_: {
+        row: import("@/types").Row;
+        index: number;
+    }): any;
+    checkedHeader?(_: any): any;
+    filters?(_: {
+        query: {
+            [x: string]: any;
+            page?: number | undefined;
+            sort?: string | undefined;
+            search?: string | undefined;
+            filter?: Record<string, any> | undefined;
+        };
+        updateQuery: (newQuery: DataTableQuery) => void;
+        updateQueryValue: (key: string, value: any) => void;
+    }): any;
+    sidebarTop?(_: {
+        paginationMetadata: import("@/types").PaginationMetadata | null;
+    }): any;
+    sidebarBottom?(_: {
+        paginationMetadata: import("@/types").PaginationMetadata | null;
+    }): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};