@flatbiz/antd 2.5.4 → 2.5.7

package/index.d.ts

@@ -33,6 +33,14 @@ export interface ButtonOperateProps {
 }
 export declare const ButtonOperate: VFC<ButtonOperateProps>;
 export declare type TPlainObject<T = any> = Record<string, T>;
+export declare type RequestStatus = "request-init" | "request-progress" | "request-success" | "request-error";
+export declare type RequestStatusRenderProps = {
+	status?: RequestStatus;
+	errorButton?: ReactElement;
+	messageConfig?: Partial<Record<RequestStatus, string>>;
+	loading?: boolean;
+};
+export declare const RequestStatusRender: (props: RequestStatusRenderProps) => JSX.Element;
 export declare type CascaderWrapperServiceConfig = {
 	params?: TPlainObject;
 	onRequest?: (params?: any) => any;
@@ -54,6 +62,7 @@ export declare type CascaderWrapperProps = Omit<CascaderProps<any>, "loading" |
 	isDynamicLoad?: boolean;
 	value?: string | number;
 	onChange?: (value: string | number, selectedList: TPlainObject[]) => void;
+	requestMessageConfig?: RequestStatusRenderProps["messageConfig"];
 };
 export declare type CascaderWrapperRefApi = {
 	getCascaderList: () => TPlainObject[];
@@ -81,6 +90,7 @@ export declare const CascaderWrapper: import("react").ForwardRefExoticComponent<
 	isDynamicLoad?: boolean | undefined;
 	value?: string | number | undefined;
 	onChange?: ((value: string | number, selectedList: TPlainObject[]) => void) | undefined;
+	requestMessageConfig?: RequestStatusRenderProps["messageConfig"];
 } & import("react").RefAttributes<CascaderWrapperRefApi>>;
 export declare type DatePickerWrapperProps = Omit<PickerDateProps<moment.Moment>, "value" | "onChange"> & {
 	value?: string;
@@ -274,8 +284,12 @@ export interface DropdownMenuWrapperProps extends Omit<DropdownProps, "overlay">
 	menuList: Array<DropdownMenuItem | null>;
 }
 export declare const DropdownMenuWrapper: FC<DropdownMenuWrapperProps>;
+export declare type SelectorWrapperValue = string | number | Array<string | number> | TPlainObject<string | number> | Array<TPlainObject<string | number>>;
 export declare type SelectorServiceConfig = {
 	params?: TPlainObject;
+	/**
+	 * 与 effectDependencyList 配合使用
+	 */
 	requiredParamsKeys?: string[];
 	onRequest?: (params?: any) => any;
 	/**
@@ -283,26 +297,25 @@ export declare type SelectorServiceConfig = {
 	 */
 	onRequestResultAdapter?: (respData: any) => TPlainObject[];
 };
-export declare type SelectorWrapperProps = Omit<SelectProps, "filterOption" | "onSearch" | "loading" | "notFoundContent" | "options" | "fieldNames" | "onChange"> & {
+export declare type SelectorWrapperProps = Omit<SelectProps, "filterOption" | "onSearch" | "loading" | "notFoundContent" | "options" | "fieldNames" | "onChange" | "value"> & {
 	modelKey: string;
 	fieldNames?: {
 		label: string;
 		value: string;
 	};
 	/**
-	 * useEffect依赖性数组
+	 * useEffect依赖项数组，用于重新发起获取接口数据
 	 */
 	effectDependencyList?: DependencyList;
 	/**
-	 * 请求服务需求的数据，当设置`selectorList`后无效果
+	 * 请求服务需求的数据
 	 */
 	serviceConfig?: SelectorServiceConfig;
 	/**
 	 * 同步设置选择器选项列表
 	 * ```
-	 * 1. 当设置selectorList后，serviceConfig、operateType=search将失效
-	 * 2. 不支持异步数据，异步使用serviceConfig方式
-	 * 3. 如果配置fieldNames，会转换后使用
+	 * 1. 如果配置fieldNames，会转换后使用
+	 * 2. 值为undefined、null不会更新，需要清空可传递空数组
 	 * ```
 	 */
 	selectorList?: TPlainObject[];
@@ -327,15 +340,41 @@ export declare type SelectorWrapperProps = Omit<SelectProps, "filterOption" | "o
 	 * ```
 	 * 1. search：根据输入项去服务端查询
 	 * 2. filter：初始化已查询数据，根据输入内容筛选
-	 * 3. 在设置`selectorList`后，operateType=search将失效
 	 * ```
 	 */
 	operateType?: "search" | "filter";
 	searchFieldName?: string;
+	/**
+	 * search模式下，回填value查询接口字段名称，默认值：searchValue
+	 * ```
+	 * search模式下，外部传递 value 数据用于回填Select，会在查询接口中默认添加searchId字段（searchId的值为回填的value，类型有：string | number | Array<string | number>）
+	 * ```
+	 */
+	searchIdFieldName?: string;
 	onLabelRenderAdapter?: (dataItem: TPlainObject) => string | ReactElement;
-	onChange?: (value?: string | number | string[] | number[], selectedList?: TPlainObject[] | TPlainObject) => void;
+	onChange?: (value?: SelectorWrapperValue, selectedList?: TPlainObject[] | TPlainObject) => void;
 	showIcon?: boolean;
 	icon?: (data: TPlainObject) => ReactElement;
+	requestMessageConfig?: RequestStatusRenderProps["messageConfig"];
+	/**
+	 * value格式
+	 *```
+	 * 1. string 、number
+	 * 2. Array<string | number>
+	 * 3. lableInValue = true，根据labelInValueFieldNames配置格式
+	 * 4. lableInValue = true，Array<labelInValueFieldNames配置>
+	 * ```
+	 */
+	value?: SelectorWrapperValue;
+	/**
+	 * ```
+	 * lableInValue = true，onChange输出数据字段名称，默认：{ label: string; value: string|number }
+	 * ```
+	 */
+	labelInValueFieldNames?: {
+		label: string;
+		value: string;
+	};
 };
 export declare type SelectorWrapperRefApi = {
 	onClearSelectorList: () => void;
@@ -349,32 +388,29 @@ export declare type SelectorWrapperRefApi = {
  * 1. modelKey的配置是为了缓存数据；
  *    1.1: 当有effectDependencyList依赖项时，依赖项的发生变化后，每次都会去调用接口获取数据
  *    1.2: 当无effectDependencyList依赖项时，第一次调用接口成功后会有标记，下次访问存在标记，就不在调用接口，使用缓存数据；如果想强制刷新数据，可通过随便配置依赖项完成
- * 2. selectorList属性
- *    2.1 当设置selectorList属性后，serviceConfig、operateType=search将失效
- *    2.2 不支持异步数据，异步使用serviceConfig方式
- * 3. operateType=search状态下，回填数据查询接口时，会在接口中默认添加id字段（id的值为回填的值）
+ * 2. 设置 labelInValue 后，onChange 返回数据item：labelInValueFieldNames配置格式
+ * 2. operateType=search状态下，外部传递 selectorValueList 回填数据查询接口时，会在接口中默认添加searchId字段（searchId的值为回填的selectorValueList，类型有：string | number | Array<string | number>）
  * ```
  */
-export declare const SelectorWrapper: import("react").ForwardRefExoticComponent<Omit<SelectProps<any, import("rc-select/lib/Select").DefaultOptionType>, "loading" | "options" | "onChange" | "filterOption" | "notFoundContent" | "onSearch" | "fieldNames"> & {
+export declare const SelectorWrapper: import("react").ForwardRefExoticComponent<Omit<SelectProps<any, import("rc-select/lib/Select").DefaultOptionType>, "value" | "loading" | "options" | "onChange" | "filterOption" | "notFoundContent" | "onSearch" | "fieldNames"> & {
 	modelKey: string;
 	fieldNames?: {
 		label: string;
 		value: string;
 	} | undefined;
 	/**
-	 * useEffect依赖性数组
+	 * useEffect依赖项数组，用于重新发起获取接口数据
 	 */
 	effectDependencyList?: DependencyList | undefined;
 	/**
-	 * 请求服务需求的数据，当设置`selectorList`后无效果
+	 * 请求服务需求的数据
 	 */
 	serviceConfig?: SelectorServiceConfig | undefined;
 	/**
 	 * 同步设置选择器选项列表
 	 * ```
-	 * 1. 当设置selectorList后，serviceConfig、operateType=search将失效
-	 * 2. 不支持异步数据，异步使用serviceConfig方式
-	 * 3. 如果配置fieldNames，会转换后使用
+	 * 1. 如果配置fieldNames，会转换后使用
+	 * 2. 值为undefined、null不会更新，需要清空可传递空数组
 	 * ```
 	 */
 	selectorList?: TPlainObject<any>[] | undefined;
@@ -399,15 +435,41 @@ export declare const SelectorWrapper: import("react").ForwardRefExoticComponent<
 	 * ```
 	 * 1. search：根据输入项去服务端查询
 	 * 2. filter：初始化已查询数据，根据输入内容筛选
-	 * 3. 在设置`selectorList`后，operateType=search将失效
 	 * ```
 	 */
 	operateType?: "search" | "filter" | undefined;
 	searchFieldName?: string | undefined;
+	/**
+	 * search模式下，回填value查询接口字段名称，默认值：searchValue
+	 * ```
+	 * search模式下，外部传递 value 数据用于回填Select，会在查询接口中默认添加searchId字段（searchId的值为回填的value，类型有：string | number | Array<string | number>）
+	 * ```
+	 */
+	searchIdFieldName?: string | undefined;
 	onLabelRenderAdapter?: ((dataItem: TPlainObject) => string | ReactElement) | undefined;
-	onChange?: ((value?: string | number | string[] | number[], selectedList?: TPlainObject[] | TPlainObject) => void) | undefined;
+	onChange?: ((value?: SelectorWrapperValue, selectedList?: TPlainObject[] | TPlainObject) => void) | undefined;
 	showIcon?: boolean | undefined;
 	icon?: ((data: TPlainObject) => ReactElement) | undefined;
+	requestMessageConfig?: RequestStatusRenderProps["messageConfig"];
+	/**
+	 * value格式
+	 *```
+	 * 1. string 、number
+	 * 2. Array<string | number>
+	 * 3. lableInValue = true，根据labelInValueFieldNames配置格式
+	 * 4. lableInValue = true，Array<labelInValueFieldNames配置>
+	 * ```
+	 */
+	value?: SelectorWrapperValue | undefined;
+	/**
+	 * ```
+	 * lableInValue = true，onChange输出数据字段名称，默认：{ label: string; value: string|number }
+	 * ```
+	 */
+	labelInValueFieldNames?: {
+		label: string;
+		value: string;
+	} | undefined;
 } & import("react").RefAttributes<SelectorWrapperRefApi>>;
 export declare type UploadWrapperFileItem = {
 	uid: string;
@@ -986,6 +1048,7 @@ declare const Table: FC<{
 declare const Footer: FC<{
 	className?: string;
 }>;
+export declare type TreeSelectorWrapperValue = string | number | Array<string | number> | TPlainObject<string | number> | Array<TPlainObject<string | number>>;
 export declare type TreeSelectorServiceConfig = {
 	params?: TPlainObject;
 	requiredParamsKeys?: string[];
@@ -996,8 +1059,10 @@ export declare type TreeSelectorServiceConfig = {
 	onRequestResultAdapter?: (respData: any) => TPlainObject[];
 };
 export declare type TreeSelectorWrapperProps = Omit<TreeSelectProps, "treeExpandedKeys" | "treeData" | "loading" | "onTreeExpand" | "onChange" | "value"> & {
-	value?: string | number | Array<string | number>;
 	modelKey: string;
+	/**
+	 * useEffect依赖项数组，用于重新发起获取接口数据
+	 */
 	effectDependencyList?: DependencyList;
 	/**
 	 * 请求服务需求的数据，当设置`treeSelectorList`后无效果
@@ -1037,6 +1102,27 @@ export declare type TreeSelectorWrapperProps = Omit<TreeSelectProps, "treeExpand
 	 */
 	onChange?: (selectedValue?: Array<string | number> | string | number, selectedData?: TPlainObject[] | TPlainObject, selectAllDataList?: TPlainObject[]) => void;
 	onLabelRenderAdapter?: (dataItem: TPlainObject) => string;
+	requestMessageConfig?: RequestStatusRenderProps["messageConfig"];
+	/**
+	 * value格式
+	 *```
+	 * 1. string 、number
+	 * 2. Array<string | number>
+	 * 3. lableInValue = true，根据labelInValueFieldNames配置格式
+	 * 4. lableInValue = true，Array<labelInValueFieldNames配置>
+	 * ```
+	 */
+	value?: TreeSelectorWrapperValue;
+	labelInValue?: boolean;
+	/**
+	 * ```
+	 * lableInValue = true，onChange输出数据字段名称，默认：{ label: string; value: string|number }
+	 * ```
+	 */
+	labelInValueFieldNames?: {
+		label: string;
+		value: string;
+	};
 };
 export declare type TreeSelectorWrapperRefApi = {
 	onClearSelectorList: () => void;
@@ -1052,8 +1138,10 @@ export declare type TreeSelectorWrapperRefApi = {
  * ```
  */
 export declare const TreeSelectorWrapper: import("react").ForwardRefExoticComponent<Omit<TreeSelectProps<any, import("rc-tree-select/lib/TreeSelect").DefaultOptionType>, "value" | "loading" | "onChange" | "treeData" | "treeExpandedKeys" | "onTreeExpand"> & {
-	value?: string | number | (string | number)[] | undefined;
 	modelKey: string;
+	/**
+	 * useEffect依赖项数组，用于重新发起获取接口数据
+	 */
 	effectDependencyList?: DependencyList | undefined;
 	/**
 	 * 请求服务需求的数据，当设置`treeSelectorList`后无效果
@@ -1093,7 +1181,29 @@ export declare const TreeSelectorWrapper: import("react").ForwardRefExoticCompon
 	 */
 	onChange?: ((selectedValue?: Array<string | number> | string | number, selectedData?: TPlainObject[] | TPlainObject, selectAllDataList?: TPlainObject[]) => void) | undefined;
 	onLabelRenderAdapter?: ((dataItem: TPlainObject) => string) | undefined;
+	requestMessageConfig?: RequestStatusRenderProps["messageConfig"];
+	/**
+	 * value格式
+	 *```
+	 * 1. string 、number
+	 * 2. Array<string | number>
+	 * 3. lableInValue = true，根据labelInValueFieldNames配置格式
+	 * 4. lableInValue = true，Array<labelInValueFieldNames配置>
+	 * ```
+	 */
+	value?: TreeSelectorWrapperValue | undefined;
+	labelInValue?: boolean | undefined;
+	/**
+	 * ```
+	 * lableInValue = true，onChange输出数据字段名称，默认：{ label: string; value: string|number }
+	 * ```
+	 */
+	labelInValueFieldNames?: {
+		label: string;
+		value: string;
+	} | undefined;
 } & import("react").RefAttributes<TreeSelectorWrapperRefApi>>;
+export declare type TreeWrapperValue = string | number | Array<string | number> | TPlainObject<string | number> | Array<TPlainObject<string | number>>;
 export declare type TreeServiceConfig = {
 	params?: TPlainObject;
 	requiredParamsKeys?: string[];
@@ -1118,6 +1228,9 @@ export declare type TreeWrapperMenuItem = {
 };
 export declare type TreeWrapperProps = Omit<TreeProps, "expandedKeys" | "treeData" | "onExpand" | "selectedKeys" | "checkedKeys" | "onCheck" | "onSelect" | "defaultCheckedKeys" | "defaultSelectedKeys" | "fieldNames" | "multiple" | "loadData" | "icon"> & {
 	modelKey: string;
+	/**
+	 * useEffect依赖项数组，用于重新发起获取接口数据
+	 */
 	effectDependencyList?: DependencyList;
 	/**
 	 * 请求服务需求的数据，当设置`selectorTreeList`后无效果
@@ -1135,7 +1248,6 @@ export declare type TreeWrapperProps = Omit<TreeProps, "expandedKeys" | "treeDat
 	 * 通过服务获取数据后回调，当设置`selectorList`后无效果
 	 */
 	onSelectorTreeListChange?: (dataList: TPlainObject[]) => void;
-	value?: string | number | Array<string | number>;
 	onChange?: (selectedKey?: string | number | Array<string | number>, selectedList?: TPlainObject[] | TPlainObject, selectedAllList?: TPlainObject[]) => void;
 	fieldNames?: {
 		label?: string;
@@ -1160,13 +1272,38 @@ export declare type TreeWrapperProps = Omit<TreeProps, "expandedKeys" | "treeDat
 		isParent: boolean;
 		isLeaf: boolean;
 	}) => ReactElement;
+	/**
+	 * 是否必选，最后一个不能取消
+	 */
+	required?: boolean;
+	requestMessageConfig?: RequestStatusRenderProps["messageConfig"];
+	/**
+	 * value格式
+	 *```
+	 * 1. string 、number
+	 * 2. Array<string | number>
+	 * 3. lableInValue = true，根据labelInValueFieldNames配置格式
+	 * 4. lableInValue = true，Array<labelInValueFieldNames配置>
+	 * ```
+	 */
+	value?: TreeWrapperValue;
+	labelInValue?: boolean;
+	/**
+	 * ```
+	 * lableInValue = true，onChange输出数据字段名称，默认：{ label: string; value: string|number }
+	 * ```
+	 */
+	labelInValueFieldNames?: {
+		label: string;
+		value: string;
+	};
 };
 export declare type TreeWrapperRefApi = {
 	onClearSelectorList: () => void;
 	getTreeDataList: () => TreeProps["treeData"];
 };
 /**
- * 树包装组件
+ * Tree包装组件，默认返回父节点，可配置不返回
  * @param props
  * @returns
  * ```
@@ -1182,6 +1319,9 @@ export declare type TreeWrapperRefApi = {
  */
 export declare const TreeWrapper: import("react").ForwardRefExoticComponent<Omit<TreeProps<import("antd").TreeDataNode>, "multiple" | "icon" | "onSelect" | "checkedKeys" | "selectedKeys" | "fieldNames" | "loadData" | "defaultSelectedKeys" | "onExpand" | "expandedKeys" | "treeData" | "defaultCheckedKeys" | "onCheck"> & {
 	modelKey: string;
+	/**
+	 * useEffect依赖项数组，用于重新发起获取接口数据
+	 */
 	effectDependencyList?: DependencyList | undefined;
 	/**
 	 * 请求服务需求的数据，当设置`selectorTreeList`后无效果
@@ -1199,7 +1339,6 @@ export declare const TreeWrapper: import("react").ForwardRefExoticComponent<Omit
 	 * 通过服务获取数据后回调，当设置`selectorList`后无效果
 	 */
 	onSelectorTreeListChange?: ((dataList: TPlainObject[]) => void) | undefined;
-	value?: string | number | (string | number)[] | undefined;
 	onChange?: ((selectedKey?: string | number | Array<string | number>, selectedList?: TPlainObject[] | TPlainObject, selectedAllList?: TPlainObject[]) => void) | undefined;
 	fieldNames?: {
 		label?: string | undefined;
@@ -1224,6 +1363,31 @@ export declare const TreeWrapper: import("react").ForwardRefExoticComponent<Omit
 		isParent: boolean;
 		isLeaf: boolean;
 	}) => ReactElement) | undefined;
+	/**
+	 * 是否必选，最后一个不能取消
+	 */
+	required?: boolean | undefined;
+	requestMessageConfig?: RequestStatusRenderProps["messageConfig"];
+	/**
+	 * value格式
+	 *```
+	 * 1. string 、number
+	 * 2. Array<string | number>
+	 * 3. lableInValue = true，根据labelInValueFieldNames配置格式
+	 * 4. lableInValue = true，Array<labelInValueFieldNames配置>
+	 * ```
+	 */
+	value?: TreeWrapperValue | undefined;
+	labelInValue?: boolean | undefined;
+	/**
+	 * ```
+	 * lableInValue = true，onChange输出数据字段名称，默认：{ label: string; value: string|number }
+	 * ```
+	 */
+	labelInValueFieldNames?: {
+		label: string;
+		value: string;
+	} | undefined;
 } & import("react").RefAttributes<TreeWrapperRefApi>>;
 
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flatbiz/antd",
-  "version": "2.5.4",
+  "version": "2.5.7",
   "description": "flat-biz oss ui components",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -51,5 +51,5 @@
     "react-router": "^6.3.0",
     "react-router-dom": "^6.3.0"
   },
-  "gitHead": "6108dcf91fcb892102884adf8cfdc727ddf227ea"
+  "gitHead": "bc1856f003ba01566c7ae8ad99656b5e2093445d"
 }