@flatbiz/antd 4.0.16 → 4.0.17

package/index.d.ts

@@ -506,8 +506,17 @@ export type EasyTableProps = {
 	/** 初始化是否请求，默认值：true */
 	initRequest?: boolean;
 };
+/**
+ * 对 查询条件+表格数据 进行深度封装，内置数据交互处理
+ * ```
+ * 1. 需要获取查询条件、主动发起请求等可通过ref操作
+ * 2. 可通过属性 initRequest 设置初始化是否请求数据
+ * 3. 可通过属性 fieldNames 来设置自定义变量，默认值为：list、total、pageNo、pageSize
+ * ```
+ */
 export declare const EasyTable: import("react").ForwardRefExoticComponent<EasyTableProps & import("react").RefAttributes<EasyTableRefApi>>;
 export type FormColProps = {
+	span?: number;
 	/** 屏幕 < 576px  */
 	xs?: number;
 	/** 屏幕 ≥ 576px */
@@ -527,7 +536,8 @@ export type FormColProps = {
 /**
  * 网格响应式布局，默认值：{ xs: 24, sm: 12, md: 12, lg: 8, xl: 8, xxl: 6 }
  *```
- * grid
+ * 1. 设置 span 栅格占位格数，不考虑响应式
+ * 2. grid 自定义响应式网格布局
  * xs: 屏幕 < 576px
  * sm: 屏幕 ≥ 576px
  * md: 屏幕 ≥ 768px
@@ -535,8 +545,6 @@ export type FormColProps = {
  * xl: 屏幕 ≥ 1200px
  * xxl: 屏幕 ≥ 1600px
  * ```
- *
- * @returns
  */
 export declare const FormCol: {
 	(props: FormColProps): JSX.Element;
@@ -587,11 +595,48 @@ export type EasyTableFilterProps = {
 		text?: string;
 	};
 };
+/**
+ * 过滤条件
+ * @param props
+ * @returns
+ *
+ *```
+ *1. 用法1
+ *  -- 默认网格布局 规则：{ xs: 24, sm: 12, md: 12, lg: 8, xl: 8, xxl: 6 }
+ *  <EasyTableFilter>
+ *   <Form.Item name="field1" label="条件1">xxx</Form.Item>
+ *  </EasyTableFilter>
+ *
+ *  -- 自定义网格布局 使用 FormCol组件包装 Form.Item
+ *  <EasyTableFilter>
+ *    <FormCol span={12}><Form.Item name="field1" label="条件1">xxx</Form.Item></FormCol>
+ *  </EasyTableFilter>
+ *
+ *  -- children 可为 function
+ *  <EasyTableFilter>
+ *   {(form) => {
+ *     return <Form.Item name="field1" label="条件1">xxx</Form.Item>
+ *   }}
+ * </EasyTableFilter>
+ *2. 用户2（自定义布局）
+ *   EasyTableFilter设置 isPure = true，FormItem无布局规则
+ *3. EasyTableFilter中内置了 Form 标签，当children为函数时，可获取form实例
+ *4. 默认布局下，可通过设置 filterOperate 设置操作按钮
+ *```
+ */
 export declare const EasyTableFilter: (props: EasyTableFilterProps) => JSX.Element;
-export type EasyTableTableProps = Omit<TableProps<TAny>, "dataSource" | "loading" | "pagination"> & {
+export type EasyTableTableProps = Omit<TableProps<TAny>, "dataSource" | "loading" | "rowKey"> & {
 	children?: ReactElement;
-	pagination?: false;
+	/** 表格行 key 的取值，可以是字符串或一个函数 */
+	rowKey: string | ((record: TPlainObject, index?: number) => React.Key);
 };
+/**
+ * 表格渲染
+ * @param props
+ * ```
+ * 1. 继承了 TableProps 可设置antd table功能
+ * ```
+ */
 export declare const EasyTableTable: (props: EasyTableTableProps) => JSX.Element;
 export type SelectorWrapperValue = string | number | Array<string | number> | TPlainObject<string | number> | Array<TPlainObject<string | number>>;
 export type SelectorServiceConfig = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flatbiz/antd",
-  "version": "4.0.16",
+  "version": "4.0.17",
   "description": "flat-biz oss ui components",
   "main": "index.js",
   "typings": "index.d.ts",