@oiij/naive-ui
Version:
Some Composable Functions And Components for Vue 3
366 lines (365 loc) • 13.1 kB
TypeScript
import { DataObject } from "../../composables/useDataRequest.js";
import "../../composables/index.js";
import { DataTablePlusEmits, DataTablePlusExpose, DataTablePlusProps } from "./index.js";
import * as _vueuse_core10 from "@vueuse/core";
import * as vue59 from "vue";
import { DataTableBaseColumn, DataTableFilterState, DataTableInst, DataTableSortState } from "naive-ui";
//#region src/components/data-table-plus/DataTablePlus.vue.d.ts
declare const __VLS_export: <P extends DataObject, D extends DataObject, R extends DataObject>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
props: vue59.PublicProps & __VLS_PrettifyLocal<DataTablePlusProps<P, D, R> & {
onSuccess?: ((data: D, params: P[]) => any) | undefined;
onError?: ((err: Error, params: P[]) => any) | undefined;
onLoad?: ((row: R) => any) | undefined;
onScroll?: ((ev: Event) => any) | undefined;
onFinally?: ((params: P[], data?: D | undefined, err?: Error | undefined) => any) | undefined;
onBefore?: ((params: P[]) => any) | undefined;
onClickRow?: ((row: R, index: number, event: MouseEvent, currentData: R[]) => any) | undefined;
onContextMenuRow?: ((row: R, index: number, event: MouseEvent, currentData: R[]) => any) | undefined;
onScrollBottom?: ((ev: Event) => any) | undefined;
"onUpdate:checkedRowKeys"?: ((keys: (string | number)[], rows: (R | undefined)[], meta: {
row: R | undefined;
action: "check" | "uncheck" | "checkAll" | "uncheckAll";
}, currentData: R[]) => any) | undefined;
"onUpdate:expandedRowKeys"?: ((keys: (string | number)[], currentData: R[]) => any) | undefined;
"onUpdate:filters"?: ((filterState: DataTableFilterState, sourceColumn: DataTableBaseColumn) => any) | undefined;
"onUpdate:sorter"?: ((options: DataTableSortState | DataTableSortState[] | null) => any) | undefined;
"onUpdate:page"?: ((page: number) => any) | undefined;
"onUpdate:pageSize"?: ((pageSize: number) => any) | undefined;
}> & (typeof globalThis extends {
__VLS_PROPS_FALLBACK: infer P_1;
} ? P_1 : {});
expose: (exposed: vue59.ShallowUnwrapRef<DataTablePlusExpose<P, D, R>>) => void;
attrs: any;
slots: {
header?: (props: {
loading: boolean;
data: D | undefined;
error: Error | undefined;
params: [] | P[];
list: R[];
paginationRef: {
page: number;
pageSize: number;
itemCount: number;
} | {
page: number;
pageSize: number;
itemCount: number;
};
filters: DataTableFilterState | undefined;
sorters: Record<string, DataTableSortState> | undefined;
dataTableRef: DataTableInst | null;
pagination: vue59.Ref<{
page: number;
pageSize: number;
itemCount: number;
}, {
page: number;
pageSize: number;
itemCount: number;
} | {
page: number;
pageSize: number;
itemCount: number;
}>;
run: (...params: P[]) => void;
runAsync: (...params: P[]) => Promise<D>;
refresh: () => void;
refreshAsync: () => Promise<D>;
cancel: () => void;
mutate: (data?: D | ((oldData?: D | undefined) => D | undefined) | undefined) => void;
setParams: (_params: Partial<P>) => void;
runParams: (_params: Partial<P>) => void;
runParamsAsync: (_params: Partial<P>) => Promise<D>;
onBefore: _vueuse_core10.EventHookOn<[P[]]>;
onSuccess: _vueuse_core10.EventHookOn<[D, P[]]>;
onError: _vueuse_core10.EventHookOn<[Error, P[]]>;
onFinally: _vueuse_core10.EventHookOn<[P[], D | undefined, Error | undefined]>;
}) => any;
} & {
title?: (props: {}) => any;
} & {
'header-extra'?: (props: {
loading: boolean;
data: D | undefined;
error: Error | undefined;
params: [] | P[];
list: R[];
paginationRef: {
page: number;
pageSize: number;
itemCount: number;
} | {
page: number;
pageSize: number;
itemCount: number;
};
filters: DataTableFilterState | undefined;
sorters: Record<string, DataTableSortState> | undefined;
dataTableRef: DataTableInst | null;
pagination: vue59.Ref<{
page: number;
pageSize: number;
itemCount: number;
}, {
page: number;
pageSize: number;
itemCount: number;
} | {
page: number;
pageSize: number;
itemCount: number;
}>;
run: (...params: P[]) => void;
runAsync: (...params: P[]) => Promise<D>;
refresh: () => void;
refreshAsync: () => Promise<D>;
cancel: () => void;
mutate: (data?: D | ((oldData?: D | undefined) => D | undefined) | undefined) => void;
setParams: (_params: Partial<P>) => void;
runParams: (_params: Partial<P>) => void;
runParamsAsync: (_params: Partial<P>) => Promise<D>;
onBefore: _vueuse_core10.EventHookOn<[P[]]>;
onSuccess: _vueuse_core10.EventHookOn<[D, P[]]>;
onError: _vueuse_core10.EventHookOn<[Error, P[]]>;
onFinally: _vueuse_core10.EventHookOn<[P[], D | undefined, Error | undefined]>;
}) => any;
} & {
filter?: (props: {
loading: boolean;
data: D | undefined;
error: Error | undefined;
params: [] | P[];
list: R[];
paginationRef: {
page: number;
pageSize: number;
itemCount: number;
} | {
page: number;
pageSize: number;
itemCount: number;
};
filters: DataTableFilterState | undefined;
sorters: Record<string, DataTableSortState> | undefined;
dataTableRef: DataTableInst | null;
pagination: vue59.Ref<{
page: number;
pageSize: number;
itemCount: number;
}, {
page: number;
pageSize: number;
itemCount: number;
} | {
page: number;
pageSize: number;
itemCount: number;
}>;
run: (...params: P[]) => void;
runAsync: (...params: P[]) => Promise<D>;
refresh: () => void;
refreshAsync: () => Promise<D>;
cancel: () => void;
mutate: (data?: D | ((oldData?: D | undefined) => D | undefined) | undefined) => void;
setParams: (_params: Partial<P>) => void;
runParams: (_params: Partial<P>) => void;
runParamsAsync: (_params: Partial<P>) => Promise<D>;
onBefore: _vueuse_core10.EventHookOn<[P[]]>;
onSuccess: _vueuse_core10.EventHookOn<[D, P[]]>;
onError: _vueuse_core10.EventHookOn<[Error, P[]]>;
onFinally: _vueuse_core10.EventHookOn<[P[], D | undefined, Error | undefined]>;
}) => any;
} & {
empty?: (props: {
loading: boolean;
data: D | undefined;
error: Error | undefined;
params: [] | P[];
list: R[];
paginationRef: {
page: number;
pageSize: number;
itemCount: number;
} | {
page: number;
pageSize: number;
itemCount: number;
};
filters: DataTableFilterState | undefined;
sorters: Record<string, DataTableSortState> | undefined;
dataTableRef: DataTableInst | null;
pagination: vue59.Ref<{
page: number;
pageSize: number;
itemCount: number;
}, {
page: number;
pageSize: number;
itemCount: number;
} | {
page: number;
pageSize: number;
itemCount: number;
}>;
run: (...params: P[]) => void;
runAsync: (...params: P[]) => Promise<D>;
refresh: () => void;
refreshAsync: () => Promise<D>;
cancel: () => void;
mutate: (data?: D | ((oldData?: D | undefined) => D | undefined) | undefined) => void;
setParams: (_params: Partial<P>) => void;
runParams: (_params: Partial<P>) => void;
runParamsAsync: (_params: Partial<P>) => Promise<D>;
onBefore: _vueuse_core10.EventHookOn<[P[]]>;
onSuccess: _vueuse_core10.EventHookOn<[D, P[]]>;
onError: _vueuse_core10.EventHookOn<[Error, P[]]>;
onFinally: _vueuse_core10.EventHookOn<[P[], D | undefined, Error | undefined]>;
}) => any;
} & {
loading?: (props: {
loading: boolean;
data: D | undefined;
error: Error | undefined;
params: [] | P[];
list: R[];
paginationRef: {
page: number;
pageSize: number;
itemCount: number;
} | {
page: number;
pageSize: number;
itemCount: number;
};
filters: DataTableFilterState | undefined;
sorters: Record<string, DataTableSortState> | undefined;
dataTableRef: DataTableInst | null;
pagination: vue59.Ref<{
page: number;
pageSize: number;
itemCount: number;
}, {
page: number;
pageSize: number;
itemCount: number;
} | {
page: number;
pageSize: number;
itemCount: number;
}>;
run: (...params: P[]) => void;
runAsync: (...params: P[]) => Promise<D>;
refresh: () => void;
refreshAsync: () => Promise<D>;
cancel: () => void;
mutate: (data?: D | ((oldData?: D | undefined) => D | undefined) | undefined) => void;
setParams: (_params: Partial<P>) => void;
runParams: (_params: Partial<P>) => void;
runParamsAsync: (_params: Partial<P>) => Promise<D>;
onBefore: _vueuse_core10.EventHookOn<[P[]]>;
onSuccess: _vueuse_core10.EventHookOn<[D, P[]]>;
onError: _vueuse_core10.EventHookOn<[Error, P[]]>;
onFinally: _vueuse_core10.EventHookOn<[P[], D | undefined, Error | undefined]>;
}) => any;
} & {
footer?: (props: {
loading: boolean;
data: D | undefined;
error: Error | undefined;
params: [] | P[];
list: R[];
paginationRef: {
page: number;
pageSize: number;
itemCount: number;
} | {
page: number;
pageSize: number;
itemCount: number;
};
filters: DataTableFilterState | undefined;
sorters: Record<string, DataTableSortState> | undefined;
dataTableRef: DataTableInst | null;
pagination: vue59.Ref<{
page: number;
pageSize: number;
itemCount: number;
}, {
page: number;
pageSize: number;
itemCount: number;
} | {
page: number;
pageSize: number;
itemCount: number;
}>;
run: (...params: P[]) => void;
runAsync: (...params: P[]) => Promise<D>;
refresh: () => void;
refreshAsync: () => Promise<D>;
cancel: () => void;
mutate: (data?: D | ((oldData?: D | undefined) => D | undefined) | undefined) => void;
setParams: (_params: Partial<P>) => void;
runParams: (_params: Partial<P>) => void;
runParamsAsync: (_params: Partial<P>) => Promise<D>;
onBefore: _vueuse_core10.EventHookOn<[P[]]>;
onSuccess: _vueuse_core10.EventHookOn<[D, P[]]>;
onError: _vueuse_core10.EventHookOn<[Error, P[]]>;
onFinally: _vueuse_core10.EventHookOn<[P[], D | undefined, Error | undefined]>;
}) => any;
} & {
'footer-extra'?: (props: {
loading: boolean;
data: D | undefined;
error: Error | undefined;
params: [] | P[];
list: R[];
paginationRef: {
page: number;
pageSize: number;
itemCount: number;
} | {
page: number;
pageSize: number;
itemCount: number;
};
filters: DataTableFilterState | undefined;
sorters: Record<string, DataTableSortState> | undefined;
dataTableRef: DataTableInst | null;
pagination: vue59.Ref<{
page: number;
pageSize: number;
itemCount: number;
}, {
page: number;
pageSize: number;
itemCount: number;
} | {
page: number;
pageSize: number;
itemCount: number;
}>;
run: (...params: P[]) => void;
runAsync: (...params: P[]) => Promise<D>;
refresh: () => void;
refreshAsync: () => Promise<D>;
cancel: () => void;
mutate: (data?: D | ((oldData?: D | undefined) => D | undefined) | undefined) => void;
setParams: (_params: Partial<P>) => void;
runParams: (_params: Partial<P>) => void;
runParamsAsync: (_params: Partial<P>) => Promise<D>;
onBefore: _vueuse_core10.EventHookOn<[P[]]>;
onSuccess: _vueuse_core10.EventHookOn<[D, P[]]>;
onError: _vueuse_core10.EventHookOn<[Error, P[]]>;
onFinally: _vueuse_core10.EventHookOn<[P[], D | undefined, Error | undefined]>;
}) => any;
};
emit: DataTablePlusEmits<P, D, R>;
}>) => vue59.VNode & {
__ctx?: Awaited<typeof __VLS_setup>;
};
declare const _default: typeof __VLS_export;
type __VLS_PrettifyLocal<T> = (T extends any ? { [K in keyof T]: T[K] } : { [K in keyof T as K]: T[K] }) & {};
//#endregion
export { _default };