@flatbiz/antd 2.3.16 → 2.3.17

package/index.d.ts

@@ -289,20 +289,35 @@ export declare type SelectorServiceConfig = {
 	 */
 	onRequestResultAdapter?: (respData: any) => TPlainObject[];
 };
-export declare type SelectorWrapperProps = SelectProps & {
+export declare type SelectorWrapperProps = Omit<SelectProps, "filterOption" | "onSearch" | "loading" | "notFoundContent"> & {
+	modelKey: string;
+	/**
+	 * useEffect依赖性数组
+	 */
 	effectDependencyList?: DependencyList[];
 	/**
 	 * 请求服务需求的数据，当设置`selectorList`后无效果
 	 */
 	serviceConfig?: SelectorServiceConfig;
 	/**
-	 * 当设置selectorList后，serviceConfig、operateType=search、onSelectorListChange将失效
+	 * 同步设置选择器选项列表
+	 * ```
+	 * 1. 当设置selectorList后，serviceConfig、operateType=search、onSelectorListChange将失效
+	 * 2. 不支持异步数据，异步使用serviceConfig方式
+	 * ```
 	 */
 	selectorList?: LabelValueItem<string | number>[];
 	/**
 	 * 通过服务获取数据后回调，当设置`selectorList`后无效果
 	 */
 	onSelectorListChange?: (selectorList: LabelValueItem<string | number>[]) => void;
+	/**
+	 * 添加全部选项
+	 * ```
+	 * 1. showAllOption = true，添加默认全部选项（value值为空字符串）
+	 * 2. 可自定义全部选项
+	 * ```
+	 */
 	showAllOption?: true | JSX.Element;
 	/**
 	 * 输入操作类型，默认值：filter
@@ -324,24 +339,44 @@ export declare type SelectorWrapperRefApi = {
  * @param props
  * @returns
  * ```
- * 1. 当设置selectorList属性后，serviceConfig、operateType=search、onSelectorListChange将失效
- * 2. operateType=search状态下，回填数据查询接口时，会在接口中默认添加id字段（id的值为回填的值）
+ * 1. modelKey的配置是为了缓存数据；
+ *    1.1: 当有effectDependencyList依赖项时，依赖项的发生变化后，每次都会去调用接口获取数据
+ *    1.2: 当无effectDependencyList依赖项时，第一次调用接口成功后会有标记，下次访问存在标记，就不在调用接口，使用缓存数据；如果想强制刷新数据，可通过随便配置依赖项完成
+ * 2. selectorList属性
+ *    2.1 当设置selectorList属性后，serviceConfig、operateType=search、onSelectorListChange将失效
+ *    2.2 不支持异步数据，异步使用serviceConfig方式
+ * 3. operateType=search状态下，回填数据查询接口时，会在接口中默认添加id字段（id的值为回填的值）
  * ```
  */
-export declare const SelectorWrapper: import("react").ForwardRefExoticComponent<SelectProps<any, import("rc-select/lib/Select").DefaultOptionType> & {
+export declare const SelectorWrapper: import("react").ForwardRefExoticComponent<Omit<SelectProps<any, import("rc-select/lib/Select").DefaultOptionType>, "loading" | "filterOption" | "notFoundContent" | "onSearch"> & {
+	modelKey: string;
+	/**
+	 * useEffect依赖性数组
+	 */
 	effectDependencyList?: DependencyList[] | undefined;
 	/**
 	 * 请求服务需求的数据，当设置`selectorList`后无效果
 	 */
 	serviceConfig?: SelectorServiceConfig | undefined;
 	/**
-	 * 当设置selectorList后，serviceConfig、operateType=search、onSelectorListChange将失效
+	 * 同步设置选择器选项列表
+	 * ```
+	 * 1. 当设置selectorList后，serviceConfig、operateType=search、onSelectorListChange将失效
+	 * 2. 不支持异步数据，异步使用serviceConfig方式
+	 * ```
 	 */
 	selectorList?: LabelValueItem<string | number>[] | undefined;
 	/**
 	 * 通过服务获取数据后回调，当设置`selectorList`后无效果
 	 */
 	onSelectorListChange?: ((selectorList: LabelValueItem<string | number>[]) => void) | undefined;
+	/**
+	 * 添加全部选项
+	 * ```
+	 * 1. showAllOption = true，添加默认全部选项（value值为空字符串）
+	 * 2. 可自定义全部选项
+	 * ```
+	 */
 	showAllOption?: true | JSX.Element | undefined;
 	/**
 	 * 输入操作类型，默认值：filter
@@ -416,6 +451,9 @@ export declare type TreeSelectorWrapperProps = TreeSelectProps & {
 	serviceConfig?: TreeSelectorServiceConfig;
 	/**
 	 * 当设置treeSelectorList后，serviceConfig、onTreeSelectorListChange将失效
+	 * ```
+	 * 1. 不支持异步数据，异步使用serviceConfig方式
+	 * ```
 	 */
 	treeSelectorList?: TreeSelectProps["treeData"];
 	/**
@@ -443,6 +481,9 @@ export declare const TreeSelectorWrapper: import("react").ForwardRefExoticCompon
 	serviceConfig?: TreeSelectorServiceConfig | undefined;
 	/**
 	 * 当设置treeSelectorList后，serviceConfig、onTreeSelectorListChange将失效
+	 * ```
+	 * 1. 不支持异步数据，异步使用serviceConfig方式
+	 * ```
 	 */
 	treeSelectorList?: TreeSelectProps["treeData"];
 	/**
@@ -467,6 +508,9 @@ export declare type TreeWrapperProps = Omit<TreeProps, "expandedKeys" | "treeDat
 	serviceConfig?: TreeServiceConfig;
 	/**
 	 * 当设置selectorTreeList后，serviceConfig将失效
+	 * ```
+	 * 1. 不支持异步数据，异步使用serviceConfig方式
+	 * ```
 	 */
 	selectorTreeList?: TreeProps["treeData"];
 	value?: string | number | Array<string | number>;
@@ -501,6 +545,9 @@ export declare const TreeWrapper: import("react").ForwardRefExoticComponent<Omit
 	serviceConfig?: TreeServiceConfig | undefined;
 	/**
 	 * 当设置selectorTreeList后，serviceConfig将失效
+	 * ```
+	 * 1. 不支持异步数据，异步使用serviceConfig方式
+	 * ```
 	 */
 	selectorTreeList?: TreeProps["treeData"];
 	value?: string | number | (string | number)[] | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@flatbiz/antd",
-	"version": "2.3.16",
+	"version": "2.3.17",
 	"description": "flat-biz oss ui components",
 	"main": "index.js",
 	"typings": "index.d.ts",
@@ -39,5 +39,5 @@
 		"@flatbiz/utils": "^2.3.4",
 		"@wove/react": "^1.2.9"
 	},
-	"gitHead": "fc2c12b53358b1f3699ea99110544da86ad0b1f8"
+	"gitHead": "c589d71754c70ff36cfb267d1879dacf7a1f3d80"
 }