sprintify-ui 0.0.0

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

@@ -0,0 +1,657 @@
+import { PropType } from 'vue';
+import { CollectionItem, DataTableQuery, MenuItemInterface } from '@/types/types';
+declare const _default: {
+    new (...args: any[]): {
+        $: import("vue").ComponentInternalInstance;
+        $data: {};
+        $props: Partial<{
+            routeKeyName: string;
+            urlQuery: Record<string, any>;
+            defaultQuery: DataTableQuery;
+            searchable: boolean;
+            actions: MenuItemInterface[];
+            historyMode: boolean;
+            detailed: boolean;
+            checkable: boolean;
+            checkableActions: MenuItemInterface[];
+            isRowCheckable: Function;
+            checkedRows: Record<string, any>[];
+            hasDetailedVisible: (row: any) => boolean;
+            maxHeight: number;
+            editButton: boolean;
+            deleteButton: boolean;
+            editUrl: (row: CollectionItem) => string;
+            deleteUrl: (row: CollectionItem) => string;
+        }> & Omit<Readonly<import("vue").ExtractPropTypes<{
+            /**
+             * Base URL from which to make requests
+             */
+            url: {
+                required: true;
+                type: StringConstructor;
+            };
+            /**
+             * Show/Hide edit button
+             */
+            editButton: {
+                default: boolean;
+                type: BooleanConstructor;
+            };
+            /**
+             * Show/Hide delete button
+             */
+            deleteButton: {
+                default: boolean;
+                type: BooleanConstructor;
+            };
+            /**
+             * Route key name for Laravel route model binding
+             */
+            routeKeyName: {
+                default: string;
+                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>;
+            };
+            /**
+             * Edit url for router link
+             */
+            editUrl: {
+                default: undefined;
+                type: PropType<(row: CollectionItem) => string>;
+            };
+            /**
+             * Delete endpoint to delete an item
+             */
+            deleteUrl: {
+                default: undefined;
+                type: PropType<(row: CollectionItem) => string>;
+            };
+            /**
+             * Show toggle-able details on each row
+             */
+            detailed: {
+                default: boolean;
+                type: BooleanConstructor;
+            };
+            /**
+             * Has detailed visible
+             */
+            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;
+            };
+            /**
+             * Actions
+             */
+            actions: {
+                default: undefined;
+                type: PropType<MenuItemInterface[]>;
+            };
+            /**
+             * Save data table state in URL
+             */
+            historyMode: {
+                default: boolean;
+                type: BooleanConstructor;
+            };
+            maxHeight: {
+                default: undefined;
+                type: NumberConstructor;
+            };
+        }>> & {
+            onClick?: ((...args: any[]) => any) | undefined;
+            onDelete?: ((...args: any[]) => any) | undefined;
+            onCheckAll?: ((...args: any[]) => any) | undefined;
+            "onUpdate:checked-rows"?: ((...args: any[]) => any) | undefined;
+            onCheck?: ((...args: any[]) => any) | undefined;
+        } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, "routeKeyName" | "urlQuery" | "defaultQuery" | "searchable" | "actions" | "historyMode" | "detailed" | "checkable" | "checkableActions" | "isRowCheckable" | "checkedRows" | "hasDetailedVisible" | "maxHeight" | "editButton" | "deleteButton" | "editUrl" | "deleteUrl">;
+        $attrs: {
+            [x: string]: unknown;
+        };
+        $refs: {
+            [x: string]: unknown;
+        };
+        $slots: Readonly<{
+            [name: string]: import("vue").Slot | undefined;
+        }>;
+        $root: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string>, {}> | null;
+        $parent: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string>, {}> | null;
+        $emit: (event: "click" | "delete" | "checkAll" | "update:checked-rows" | "check", ...args: any[]) => void;
+        $el: any;
+        $options: import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
+            /**
+             * Base URL from which to make requests
+             */
+            url: {
+                required: true;
+                type: StringConstructor;
+            };
+            /**
+             * Show/Hide edit button
+             */
+            editButton: {
+                default: boolean;
+                type: BooleanConstructor;
+            };
+            /**
+             * Show/Hide delete button
+             */
+            deleteButton: {
+                default: boolean;
+                type: BooleanConstructor;
+            };
+            /**
+             * Route key name for Laravel route model binding
+             */
+            routeKeyName: {
+                default: string;
+                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>;
+            };
+            /**
+             * Edit url for router link
+             */
+            editUrl: {
+                default: undefined;
+                type: PropType<(row: CollectionItem) => string>;
+            };
+            /**
+             * Delete endpoint to delete an item
+             */
+            deleteUrl: {
+                default: undefined;
+                type: PropType<(row: CollectionItem) => string>;
+            };
+            /**
+             * Show toggle-able details on each row
+             */
+            detailed: {
+                default: boolean;
+                type: BooleanConstructor;
+            };
+            /**
+             * Has detailed visible
+             */
+            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;
+            };
+            /**
+             * Actions
+             */
+            actions: {
+                default: undefined;
+                type: PropType<MenuItemInterface[]>;
+            };
+            /**
+             * Save data table state in URL
+             */
+            historyMode: {
+                default: boolean;
+                type: BooleanConstructor;
+            };
+            maxHeight: {
+                default: undefined;
+                type: NumberConstructor;
+            };
+        }>> & {
+            onClick?: ((...args: any[]) => any) | undefined;
+            onDelete?: ((...args: any[]) => any) | undefined;
+            onCheckAll?: ((...args: any[]) => any) | undefined;
+            "onUpdate:checked-rows"?: ((...args: any[]) => any) | undefined;
+            onCheck?: ((...args: any[]) => any) | undefined;
+        }, {
+            fetch: () => void;
+            query: import("vue").ComputedRef<DataTableQuery | null>;
+        }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("click" | "delete" | "checkAll" | "update:checked-rows" | "check")[], string, {
+            routeKeyName: string;
+            urlQuery: Record<string, any>;
+            defaultQuery: DataTableQuery;
+            searchable: boolean;
+            actions: MenuItemInterface[];
+            historyMode: boolean;
+            detailed: boolean;
+            checkable: boolean;
+            checkableActions: MenuItemInterface[];
+            isRowCheckable: Function;
+            checkedRows: Record<string, any>[];
+            hasDetailedVisible: (row: any) => boolean;
+            maxHeight: number;
+            editButton: boolean;
+            deleteButton: boolean;
+            editUrl: (row: CollectionItem) => string;
+            deleteUrl: (row: CollectionItem) => string;
+        }, {}, string> & {
+            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: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
+            renderTriggered?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
+            errorCaptured?: (((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string>, {}> | null, info: string) => boolean | void) | ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string>, {}> | null, info: string) => boolean | void)[]) | undefined;
+        };
+        $forceUpdate: () => void;
+        $nextTick: typeof import("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?: import("vue").WatchOptions<boolean> | undefined): import("vue").WatchStopHandle;
+    } & Readonly<import("vue").ExtractPropTypes<{
+        /**
+         * Base URL from which to make requests
+         */
+        url: {
+            required: true;
+            type: StringConstructor;
+        };
+        /**
+         * Show/Hide edit button
+         */
+        editButton: {
+            default: boolean;
+            type: BooleanConstructor;
+        };
+        /**
+         * Show/Hide delete button
+         */
+        deleteButton: {
+            default: boolean;
+            type: BooleanConstructor;
+        };
+        /**
+         * Route key name for Laravel route model binding
+         */
+        routeKeyName: {
+            default: string;
+            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>;
+        };
+        /**
+         * Edit url for router link
+         */
+        editUrl: {
+            default: undefined;
+            type: PropType<(row: CollectionItem) => string>;
+        };
+        /**
+         * Delete endpoint to delete an item
+         */
+        deleteUrl: {
+            default: undefined;
+            type: PropType<(row: CollectionItem) => string>;
+        };
+        /**
+         * Show toggle-able details on each row
+         */
+        detailed: {
+            default: boolean;
+            type: BooleanConstructor;
+        };
+        /**
+         * Has detailed visible
+         */
+        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;
+        };
+        /**
+         * Actions
+         */
+        actions: {
+            default: undefined;
+            type: PropType<MenuItemInterface[]>;
+        };
+        /**
+         * Save data table state in URL
+         */
+        historyMode: {
+            default: boolean;
+            type: BooleanConstructor;
+        };
+        maxHeight: {
+            default: undefined;
+            type: NumberConstructor;
+        };
+    }>> & {
+        onClick?: ((...args: any[]) => any) | undefined;
+        onDelete?: ((...args: any[]) => any) | undefined;
+        onCheckAll?: ((...args: any[]) => any) | undefined;
+        "onUpdate:checked-rows"?: ((...args: any[]) => any) | undefined;
+        onCheck?: ((...args: any[]) => any) | undefined;
+    } & import("vue").ShallowUnwrapRef<{
+        fetch: () => void;
+        query: import("vue").ComputedRef<DataTableQuery | null>;
+    }> & {} & import("vue").ComponentCustomProperties & {};
+    __isFragment?: undefined;
+    __isTeleport?: undefined;
+    __isSuspense?: undefined;
+} & import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Base URL from which to make requests
+     */
+    url: {
+        required: true;
+        type: StringConstructor;
+    };
+    /**
+     * Show/Hide edit button
+     */
+    editButton: {
+        default: boolean;
+        type: BooleanConstructor;
+    };
+    /**
+     * Show/Hide delete button
+     */
+    deleteButton: {
+        default: boolean;
+        type: BooleanConstructor;
+    };
+    /**
+     * Route key name for Laravel route model binding
+     */
+    routeKeyName: {
+        default: string;
+        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>;
+    };
+    /**
+     * Edit url for router link
+     */
+    editUrl: {
+        default: undefined;
+        type: PropType<(row: CollectionItem) => string>;
+    };
+    /**
+     * Delete endpoint to delete an item
+     */
+    deleteUrl: {
+        default: undefined;
+        type: PropType<(row: CollectionItem) => string>;
+    };
+    /**
+     * Show toggle-able details on each row
+     */
+    detailed: {
+        default: boolean;
+        type: BooleanConstructor;
+    };
+    /**
+     * Has detailed visible
+     */
+    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;
+    };
+    /**
+     * Actions
+     */
+    actions: {
+        default: undefined;
+        type: PropType<MenuItemInterface[]>;
+    };
+    /**
+     * Save data table state in URL
+     */
+    historyMode: {
+        default: boolean;
+        type: BooleanConstructor;
+    };
+    maxHeight: {
+        default: undefined;
+        type: NumberConstructor;
+    };
+}>> & {
+    onClick?: ((...args: any[]) => any) | undefined;
+    onDelete?: ((...args: any[]) => any) | undefined;
+    onCheckAll?: ((...args: any[]) => any) | undefined;
+    "onUpdate:checked-rows"?: ((...args: any[]) => any) | undefined;
+    onCheck?: ((...args: any[]) => any) | undefined;
+}, {
+    fetch: () => void;
+    query: import("vue").ComputedRef<DataTableQuery | null>;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("click" | "delete" | "checkAll" | "update:checked-rows" | "check")[], "click" | "delete" | "checkAll" | "update:checked-rows" | "check", {
+    routeKeyName: string;
+    urlQuery: Record<string, any>;
+    defaultQuery: DataTableQuery;
+    searchable: boolean;
+    actions: MenuItemInterface[];
+    historyMode: boolean;
+    detailed: boolean;
+    checkable: boolean;
+    checkableActions: MenuItemInterface[];
+    isRowCheckable: Function;
+    checkedRows: Record<string, any>[];
+    hasDetailedVisible: (row: any) => boolean;
+    maxHeight: number;
+    editButton: boolean;
+    deleteButton: boolean;
+    editUrl: (row: CollectionItem) => string;
+    deleteUrl: (row: CollectionItem) => string;
+}, {}, string> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
+    $slots: {
+        default: (_: {}) => any;
+        rowActions: (_: {
+            row: any;
+        }) => any;
+        detail: (_: {
+            row: import("@/types/types").Row;
+            index: number;
+        }) => any;
+        checkedHeader: (_: {
+            uncheckAll: () => void;
+            count: number;
+            checkRows: import("@/types/types").Row[];
+        }) => any;
+        filters: (_: {
+            query: DataTableQuery;
+            updateQuery: (newQuery: DataTableQuery) => void;
+            updateQueryValue: (key: string, value: any) => void;
+        }) => any;
+        sidebarTop: (_: {
+            paginationMetadata: import("@/types/types").PaginationMetadata;
+        }) => any;
+    };
+});
+export default _default;