@amaoaaaaa/search-table 0.3.0 → 0.5.0

package/dist/SearchTable/types.d.ts

@@ -1,6 +1,29 @@
 import { ProTableProps, TableRow } from '../ProTable/types';
 import { PaginationProps } from 'element-plus';
 import { SortState } from './useTableSort';
+/**
+ * 分页组件的视觉配置
+ *
+ * @description
+ * 直接从 element-plus 的 `PaginationProps` 中 Pick，
+ * 保证这里的类型与 `el-pagination` 的 props 始终一致。
+ */
+export type SearchTablePaginationProps = Partial<Pick<PaginationProps, 'size' | 'background' | 'pagerCount' | 'layout' | 'popperClass' | 'popperStyle' | 'prevText' | 'prevIcon' | 'nextText' | 'nextIcon'>>;
+/**
+ * 搜索区域的配置
+ *
+ * @description
+ * 用对象承载搜索区的可配置项，后续新增配置直接往里加字段，
+ * 避免在全局配置上不断堆叠扁平的单项属性。
+ */
+export interface SearchTableSearchProps {
+    /**
+     * 搜索按钮的文字
+     *
+     * @default '搜索'
+     */
+    buttonText?: string;
+}
 export type SearchTableProps<T extends TableRow = any> = Omit<ProTableProps<T>, 'data' | 'defaultSort'> & {
     /**
      * 是否显示搜索区域
@@ -9,8 +32,18 @@ export type SearchTableProps<T extends TableRow = any> = Omit<ProTableProps<T>,
     showSearch?: boolean;
     /**
      * 搜索输入框的提示语
+     *
+     * @default '输入搜索关键词'
      */
     searchInputPlaceholder?: string;
+    /**
+     * 搜索按钮的文字
+     *
+     * 优先级高于 `SearchTableConfigProvider` 中的 `searchProps.buttonText`
+     *
+     * @default '搜索'
+     */
+    searchButtonText?: string;
     /**
      * 搜索框绑定到查询参数的字段名
      *
@@ -34,9 +67,11 @@ export type SearchTableProps<T extends TableRow = any> = Omit<ProTableProps<T>,
      */
     pageSize?: number;
     /**
-     * element-plus 分页组件属性
+     * element-plus 分页组件的视觉配置
+     *
+     * 优先级高于 `SearchTableConfigProvider` 中的 `paginationProps`
      */
-    elPaginationProps?: Partial<Pick<PaginationProps, 'size' | 'pagerCount'>>;
+    elPaginationProps?: SearchTablePaginationProps;
     /**
      * 默认排序
      */

package/dist/index.d.ts

@@ -2,7 +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 { SearchTableProps, SearchTableFetchFn, PageParams, PageResp, } from './SearchTable/types';
+export type { SearchTableProps, SearchTablePaginationProps, SearchTableSearchProps, SearchTableFetchFn, PageParams, PageResp, } from './SearchTable/types';
 export type { SearchTableInstance } from './SearchTable';
 export type { SearchTableConfigProviderProps } from './SearchTable/config';
 export type { ProTableProps, ProTableColumn, ProTableAction, TableRow, FilterOption, FilterType, ActionButtonVisibility, ApplyFilterPayload, CellEditPayload, ProTableColumn as SearchTableColumn, ProTableAction as SearchTableAction, } from './ProTable/types';