@amaoaaaaa/search-table 0.4.0 → 0.5.1

package/dist/SearchTable/types.d.ts

@@ -74,8 +74,13 @@ export type SearchTableProps<T extends TableRow = any> = Omit<ProTableProps<T>,
     elPaginationProps?: SearchTablePaginationProps;
     /**
      * 默认排序
+     *
+     * @description
+     * 仅用于初始化排序状态，并随首次及后续请求以 `sort`、`order` 参数传给 `fetchFn`。
+     * 使用后端排序时，对应表格列需设置 `sortable: 'custom'`，且列的 `prop` 应与
+     * `sort` 保持一致；排序变化后组件会重新请求后端，由后端返回排序后的分页数据。
      */
-    defaultSort?: SortState;
+    defaultSort?: SortState<T>;
     fetchFn: SearchTableFetchFn<T>;
     /**
      * 搜索参数处理函数

package/dist/SearchTable/useTableSort.d.ts

@@ -6,16 +6,16 @@ export interface SortState<T extends Record<string, any> = Record<string, any>>
     /**
      * 排序字段
      */
-    sort: keyof T;
+    sort: Extract<keyof T, string>;
 }
-export interface UseTableSortOption {
-    defaultSort?: SortState;
+export interface UseTableSortOption<T extends Record<string, any> = Record<string, any>> {
+    defaultSort?: SortState<T>;
     fetchFn: () => void;
     onReset?: () => void;
 }
-export declare function useTableSort({ defaultSort, fetchFn, onReset }: UseTableSortOption): {
+export declare function useTableSort<T extends Record<string, any> = Record<string, any>>({ defaultSort, fetchFn, onReset, }: UseTableSortOption<T>): {
     sortState: {
-        order: "asc" | "desc";
+        order: "asc" | "desc" | "";
         sort: string;
     };
     onSortChange: ({ prop, order, }: {

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export { default as SearchTable } from './SearchTable/index.vue';
 export { default as SearchTableConfigProvider } from './SearchTable/ConfigProvider.vue';
 export { default as ProTable } from './ProTable/index.vue';
 export type { ProTableInstance } from './ProTable';
+export type { SortState } from './SearchTable/useTableSort';
 export type { SearchTableProps, SearchTablePaginationProps, SearchTableSearchProps, SearchTableFetchFn, PageParams, PageResp, } from './SearchTable/types';
 export type { SearchTableInstance } from './SearchTable';
 export type { SearchTableConfigProviderProps } from './SearchTable/config';