@hzab/form-render 1.6.18 → 1.6.20

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# @hzab/form-render@1.6.20
+feat: 新增 TreeCheckbox的readOnly属性
+
+# @hzab/form-render@1.6.19
+
+fix: LocationListPicker 搜索新增时在搜索项切换地址异常问题修复
+
 # @hzab/form-render@1.6.18
 
 fix:修复人员选择组件单选模式自定义节点展示以及选中判断问题

package/README.md

@@ -1,239 +1,247 @@
-# @hzab/form-render
-
-formily schema 表单渲染组件
-
-# 组件
-
-## Tips
-
-- antd 组件样式需要手动引入
-
-## 示例
-
-```jsx
-import FormRender from "@hzab/form-render";
-
-// testSchema 为 formily 生成的 schema json
-<FormRender schema={testSchema} />;
-```
-
-#### 组件远程数据
-
-- 使用 schemaScope 传入全局配置变量，在响应器的动作响应中调用
-
-```jsx
-// schema
-{
-  "form": {
-    "labelCol": 6,
-    "wrapperCol": 12
-  },
-  "schema": {
-    "type": "object",
-    "properties": {
-      "parentId": {
-        "type": "string",
-        "title": "上级菜单",
-        "x-decorator": "FormItem",
-        "x-component": "TreeSelect",
-        "x-validator": [],
-        "x-component-props": {},
-        "x-decorator-props": {},
-        "x-reactions": {
-          "fulfill": {
-            "run": "fetchMenuTree($self);"
-          }
-        },
-        "name": "parentId",
-        "x-designable-id": "i012z5nbd5z",
-        "x-index": 0
-      }
-    }
-  }
-}
-
-// formRender
-  <FormRender
-    schema={testSchema}
-    schemaScope={{
-      fetchMenuTree(field) {
-        // 模拟请求
-        setTimeout(() => {
-          // field 目标组件的 配置参数
-          // 通过 field.component[1] 可以动态配置目标组件的 props
-          // 树选择器 数据源
-          field.component[1].treeData = [{ value: 1, label: 1 }];
-        }, 1000)
-      },
-    }}
-  />
-```
-
-#### 自定义组件
-
-- 使用 components 传入自定义组件，在 schema 中 x-component 配置对应的组件名称
-
-```jsx
-// schema
-{
-  "form": {
-    "labelCol": 6,
-    "wrapperCol": 12
-  },
-  "schema": {
-    "type": "object",
-    "properties": {
-      "parentId": {
-        "type": "string",
-        "title": "图标选择器",
-        "x-decorator": "FormItem",
-        "x-component": "IconSelect",
-        "x-validator": [],
-        "x-component-props": {},
-        "x-decorator-props": {},
-        "x-reactions": {},
-        "name": "parentId",
-        "x-designable-id": "i012z5nbd5z",
-        "x-index": 0
-      }
-    }
-  }
-}
-
-// formRender
-  <FormRender
-    schema={testSchema}
-    components={{
-      // 自定义组件
-      IconSelect() {
-        return "IconSelect";
-      },
-    }}
-  />
-```
-
-## API
-
-### InfoPanel Attributes
-
-| 参数               | 类型     | 必填 | 默认值     | 说明                                   |
-| ------------------ | -------- | ---- | ---------- | -------------------------------------- |
-| schema             | Object   | 是   | -          | 数据信息的 schema                      |
-| schemaScope        | Object   | 否   | -          | 全局作用域，用于实现协议表达式变量注入 |
-| layout             | Object   | 否   | horizontal | 表单布局，horizontal vertical \ inline |
-| initialValues      | Object   | 否   | -          | form 初始值                            |
-| components         | Object   | 否   | -          | 自定义组件                             |
-| formOptions        | Object   | 否   | -          | createForm 的参数                      |
-| disabled           | boolean  | 否   | -          | 禁用状态                               |
-| readOnly           | boolean  | 否   | -          | 只读状态                               |
-| onFormValuesChange | Function | 否   | -          | 表单事件 (form)=>{}  https://core.formilyjs.org/zh-CN/api/entry/form-effect-hooks                             |
-| onFieldValueChange | Function | 否   | -          | 表单项事件 (field, form)=>{} https://core.formilyjs.org/zh-CN/api/entry/field-effect-hooks                             |
-
-### 方法 Methods
-
-| 名称 | 参数      | 说明           |
-| ---- | --------- | -------------- |
-| init | form 实例 | 组件初始化执行 |
-
-### Schema
-
-- 使用 表单编辑器生成：https://designable-antd.formilyjs.org/
-
-```js
-{
-  "form": {
-    "labelCol": 6,
-    "wrapperCol": 12
-  },
-  "schema": {
-    "type": "object",
-    "properties": {
-      // 参数 key
-      "parentId": {
-        "type": "string",
-        // 参数 label
-        "title": "上级菜单",
-        "x-decorator": "FormItem",
-        // 渲染的组件
-        "x-component": "TreeSelect",
-        // 组件校验
-        "x-validator": [],
-        // 组件配置
-        "x-component-props": {
-          "virtual": true,
-          "allowClear": true,
-          "showSearch": true
-        },
-        // 容器配置
-        "x-decorator-props": {},
-        // 响应器
-        "x-reactions": {
-          // 依赖字段
-          "dependencies": [
-            {
-              "property": "value",
-              "type": "any"
-            }
-          ],
-          // 响应动作
-          "fulfill": {
-            // 属性响应，只支持 JS 表达式
-            "state": {
-              "visible": "{{$deps.menuType === \"C\" || $deps.menuType === \"F\"}}"
-            },
-            // 动作响应，支持 JS 语句
-            "run": "fetchMenuTree($self);"
-          }
-        },
-        // 参数 key
-        "name": "parentId",
-        // 组件在编辑器中的 ID（必须唯一）
-        "x-designable-id": "i012z5nbd5z",
-        // 组件在表单中的顺序（必须唯一）
-        "x-index": 0,
-        // 是否在 table 中展示，目前需要手动添加配置
-        "inTable": false
-      }
-    }
-  }
-}
-```
-
-# 组件开发流程
-
-- 在 config/webpack.config/webpack.config.dev.js 中按需修改 alias 配置的包名，便于本地调试
-- 在 example/typings.d.ts 中按需修改 declare module 配置的包名，解决 ts 报错问题
-- npm run dev
-
-## 文件目录
-
-- example 本地测试代码
-- src 组件源码
-- lib 组件打包编译后的代码
-
-## 命令
-
-- 本地运行：npm run dev
-- 测试环境打包编译：npm run build-flow-dev
-- 生产环境打包编译：npm run build
-
-## 发布
-
-- 在 config/webpack.config/webpack.config.prod.js 中按需修改 entry 配置的文件名
-- 编译组件：npm run build
-- 命令：npm publish --access public
-- 发布目录：
-  - lib
-  - src
-
-## 配置
-
-### 配置文件
-
-- 本地配置文件：config/global-config/config.local.js
-- 测试环境配置文件：config/global-config/config.flowDev.js
-- 生产环境配置文件：config/global-config/config.production.js
-
-### webpack 配置文件
-
-- config/webpack.config.js
+# @hzab/form-render
+
+formily schema 表单渲染组件
+
+# 组件
+
+## Tips
+
+- antd 组件样式需要手动引入
+
+## 示例
+
+```jsx
+import FormRender from "@hzab/form-render";
+
+// testSchema 为 formily 生成的 schema json
+<FormRender schema={testSchema} />;
+```
+
+#### 组件远程数据
+
+- 使用 schemaScope 传入全局配置变量，在响应器的动作响应中调用
+
+```jsx
+// schema
+{
+  "form": {
+    "labelCol": 6,
+    "wrapperCol": 12
+  },
+  "schema": {
+    "type": "object",
+    "properties": {
+      "parentId": {
+        "type": "string",
+        "title": "上级菜单",
+        "x-decorator": "FormItem",
+        "x-component": "TreeSelect",
+        "x-validator": [],
+        "x-component-props": {},
+        "x-decorator-props": {},
+        "x-reactions": {
+          "fulfill": {
+            "run": "fetchMenuTree($self);"
+          }
+        },
+        "name": "parentId",
+        "x-designable-id": "i012z5nbd5z",
+        "x-index": 0
+      }
+    }
+  }
+}
+
+// formRender
+  <FormRender
+    schema={testSchema}
+    schemaScope={{
+      fetchMenuTree(field) {
+        // 模拟请求
+        setTimeout(() => {
+          // field 目标组件的 配置参数
+          // 通过 field.component[1] 可以动态配置目标组件的 props
+          // 树选择器 数据源
+          field.component[1].treeData = [{ value: 1, label: 1 }];
+        }, 1000)
+      },
+    }}
+  />
+```
+
+#### 自定义组件
+
+- 使用 components 传入自定义组件，在 schema 中 x-component 配置对应的组件名称
+
+```jsx
+// schema
+{
+  "form": {
+    "labelCol": 6,
+    "wrapperCol": 12
+  },
+  "schema": {
+    "type": "object",
+    "properties": {
+      "parentId": {
+        "type": "string",
+        "title": "图标选择器",
+        "x-decorator": "FormItem",
+        "x-component": "IconSelect",
+        "x-validator": [],
+        "x-component-props": {},
+        "x-decorator-props": {},
+        "x-reactions": {},
+        "name": "parentId",
+        "x-designable-id": "i012z5nbd5z",
+        "x-index": 0
+      }
+    }
+  }
+}
+
+// formRender
+  <FormRender
+    schema={testSchema}
+    components={{
+      // 自定义组件
+      IconSelect() {
+        return "IconSelect";
+      },
+    }}
+  />
+```
+
+## API
+
+### InfoPanel Attributes
+
+| 参数               | 类型     | 必填 | 默认值     | 说明                                                                                       |
+| ------------------ | -------- | ---- | ---------- | ------------------------------------------------------------------------------------------ |
+| schema             | Object   | 是   | -          | 数据信息的 schema                                                                          |
+| schemaScope        | Object   | 否   | -          | 全局作用域，用于实现协议表达式变量注入                                                     |
+| layout             | Object   | 否   | horizontal | 表单布局，horizontal vertical \ inline                                                     |
+| initialValues      | Object   | 否   | -          | form 初始值                                                                                |
+| components         | Object   | 否   | -          | 自定义组件                                                                                 |
+| formOptions        | Object   | 否   | -          | createForm 的参数                                                                          |
+| disabled           | boolean  | 否   | -          | 禁用状态                                                                                   |
+| readOnly           | boolean  | 否   | -          | 只读状态                                                                                   |
+| onFormValuesChange | Function | 否   | -          | 表单事件 (form)=>{} https://core.formilyjs.org/zh-CN/api/entry/form-effect-hooks           |
+| onFieldValueChange | Function | 否   | -          | 表单项事件 (field, form)=>{} https://core.formilyjs.org/zh-CN/api/entry/field-effect-hooks |
+
+### 方法 Methods
+
+| 名称 | 参数      | 说明           |
+| ---- | --------- | -------------- |
+| init | form 实例 | 组件初始化执行 |
+
+### Schema
+
+- 使用 表单编辑器生成：https://designable-antd.formilyjs.org/
+
+```js
+{
+  "form": {
+    "labelCol": 6,
+    "wrapperCol": 12
+  },
+  "schema": {
+    "type": "object",
+    "properties": {
+      // 参数 key
+      "parentId": {
+        "type": "string",
+        // 参数 label
+        "title": "上级菜单",
+        "x-decorator": "FormItem",
+        // 渲染的组件
+        "x-component": "TreeSelect",
+        // 组件校验
+        "x-validator": [],
+        // 组件配置
+        "x-component-props": {
+          "virtual": true,
+          "allowClear": true,
+          "showSearch": true
+        },
+        // 容器配置
+        "x-decorator-props": {},
+        // 响应器
+        "x-reactions": {
+          // 依赖字段
+          "dependencies": [
+            {
+              "property": "value",
+              "type": "any"
+            }
+          ],
+          // 响应动作
+          "fulfill": {
+            // 属性响应，只支持 JS 表达式
+            "state": {
+              "visible": "{{$deps.menuType === \"C\" || $deps.menuType === \"F\"}}"
+            },
+            // 动作响应，支持 JS 语句
+            "run": "fetchMenuTree($self);"
+          }
+        },
+        // 参数 key
+        "name": "parentId",
+        // 组件在编辑器中的 ID（必须唯一）
+        "x-designable-id": "i012z5nbd5z",
+        // 组件在表单中的顺序（必须唯一）
+        "x-index": 0,
+        // 是否在 table 中展示，目前需要手动添加配置
+        "inTable": false
+      }
+    }
+  }
+}
+```
+
+# 组件开发流程
+
+- 在 config/webpack.config/webpack.config.dev.js 中按需修改 alias 配置的包名，便于本地调试
+- 在 example/typings.d.ts 中按需修改 declare module 配置的包名，解决 ts 报错问题
+- npm run dev
+
+## 文件目录
+
+- example 本地测试代码
+- src 组件源码
+
+## 命令
+
+- 生成文档：npm run docs
+- 本地运行：npm run dev
+- 打包编译：npm run build
+
+## 发布
+
+- npm 源和云效源都需要发布
+
+- 命令：npm publish --access public
+- 发布目录：
+  - src
+
+### nrm
+
+- 安装
+  npm install -g nrm
+- 增加源
+  nrm add aliyun https://packages.aliyun.com/62046985b3ead41b374a17f7/npm/npm-registry/
+- 切换源
+  nrm use aliyun
+  nrm use npm
+- 登录（账号密码在 https://packages.aliyun.com/npm/npm-registry/guide 查看）
+  npm login --registry=https://packages.aliyun.com/62046985b3ead41b374a17f7/npm/npm-registry/
+
+## 配置
+
+### 配置文件
+
+- 本地配置文件：config/config.js
+
+### webpack 配置文件
+
+- config/webpack.config.js

package/package.json

@@ -1,57 +1,57 @@
-{
-  "name": "@hzab/form-render",
-  "version": "1.6.18",
-  "description": "",
-  "main": "src",
-  "scripts": {
-    "dev": "webpack serve -c ./config/webpack.config.js --env local",
-    "build": "webpack -c ./config/webpack.config.js --env production",
-    "publish-beta": "npm publish --beta",
-    "publish-patch": "npm version patch && npm publish --access public",
-    "publish-minor": "npm version minor && npm publish --access public",
-    "publish-major": "npm version major && npm publish --access public"
-  },
-  "files": [
-    "src",
-    "CHANGELOG.md"
-  ],
-  "keywords": [],
-  "author": "CaiYansong",
-  "license": "ISC",
-  "devDependencies": {
-    "@hzab/data-model": "^1.2.0",
-    "@hzab/permissions": "^0.1.1",
-    "@hzab/webpack-config": "0.0.12",
-    "@types/react": "^17.0.62",
-    "@types/react-dom": "^17.0.20",
-    "antd": "^4.24.12",
-    "dayjs": "1.11.10",
-    "eslint": "^8.30.0",
-    "less": "^4.1.3",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
-    "react-router-dom": "^6.8.1",
-    "typescript": "^4.9.4"
-  },
-  "peerDependencies": {
-    "antd": "4.x",
-    "axios": ">=1.6.2",
-    "react": ">=16.8.0",
-    "react-dom": ">=16.8.0"
-  },
-  "dependencies": {
-    "@amap/amap-jsapi-loader": "^1.0.1",
-    "@formily/core": "2.3.1",
-    "@formily/react": "2.3.1",
-    "@formily/reactive-react": "2.3.1",
-    "@turf/turf": "^6.5.0",
-    "@wangeditor/editor": "^5.1.23",
-    "@wangeditor/editor-for-react": "^1.0.6",
-    "ajv": "^8.12.0",
-    "c-formily-antd": "^2.3.1",
-    "nanoid": "^3.3.7"
-  },
-  "directories": {
-    "src": "src"
-  }
-}
+{
+  "name": "@hzab/form-render",
+  "version": "1.6.20",
+  "description": "",
+  "main": "src",
+  "scripts": {
+    "dev": "webpack serve -c ./config/webpack.config.js --env local",
+    "build": "webpack -c ./config/webpack.config.js --env production",
+    "publish-beta": "npm publish --beta",
+    "publish-patch": "npm version patch && npm publish --access public",
+    "publish-minor": "npm version minor && npm publish --access public",
+    "publish-major": "npm version major && npm publish --access public"
+  },
+  "files": [
+    "src",
+    "CHANGELOG.md"
+  ],
+  "keywords": [],
+  "author": "CaiYansong",
+  "license": "ISC",
+  "devDependencies": {
+    "@hzab/data-model": "^1.2.0",
+    "@hzab/permissions": "^0.1.1",
+    "@hzab/webpack-config": "0.0.12",
+    "@types/react": "^17.0.62",
+    "@types/react-dom": "^17.0.20",
+    "antd": "^4.24.12",
+    "dayjs": "1.11.10",
+    "eslint": "^8.30.0",
+    "less": "^4.1.3",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2",
+    "react-router-dom": "^6.8.1",
+    "typescript": "^4.9.4"
+  },
+  "peerDependencies": {
+    "antd": "4.x",
+    "axios": ">=1.6.2",
+    "react": ">=16.8.0",
+    "react-dom": ">=16.8.0"
+  },
+  "dependencies": {
+    "@amap/amap-jsapi-loader": "^1.0.1",
+    "@formily/core": "2.3.1",
+    "@formily/react": "2.3.1",
+    "@formily/reactive-react": "2.3.1",
+    "@turf/turf": "^6.5.0",
+    "@wangeditor/editor": "^5.1.23",
+    "@wangeditor/editor-for-react": "^1.0.6",
+    "ajv": "^8.12.0",
+    "c-formily-antd": "^2.3.1",
+    "nanoid": "^3.3.7"
+  },
+  "directories": {
+    "src": "src"
+  }
+}