@hzab/form-render 1.7.17 → 1.7.19

package/README.md

@@ -1,271 +0,0 @@
-# @hzab/form-render
-
-formily schema 表单渲染组件
-
-# 组件
-
-## Tips
-
-- antd 组件样式需要手动引入
-
-## 示例
-
-#### 项目初始化时挂载全局组件
-
-```jsx
-import { setFormilyGlobalComponents } from "@hzab/utils/src/formily/global-components";
-
-// 挂载 Test1 组件到 formRender 组件
-setFormilyGlobalComponents({
-  Test1() {
-    return <div>Test1</div>;
-  },
-});
-
-// 挂载 Test2 组件到 formRender 组件
-setFormilyGlobalComponents({
-  Test2() {
-    return <div>Test2</div>;
-  },
-  Test3() {
-    return <div>Test3</div>;
-  },
-});
-```
-
-```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 的参数                                                                          |
-| emptyValue         | string   | 否   | N/A        | 只读模式 PreviewText emptyValue 配置                                                       |
-| 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/src/components/LocationPicker/README.md

@@ -1,44 +0,0 @@
-## 使用前安装依赖
-
-npm install @amap/amap-jsapi-loader
-
-## 注意事项
-
-- isObjectRes 在 @hzab/form-render0.5.0 版本中去除，结果全部存放在对象中
-- changeMode 在 @hzab/form-render0.5.1 版本中去除，仅允许点击地图选点
-
-## 引入
-
-```jsx
-import MapLocationPoint from "./mapLocationPoint";
-
-export default function AMap(props) {
-  return <MapLocationPoint hasSearch={true}></MapLocationPoint>;
-}
-```
-
-### InfoPanel Attributes
-
-| 参数               | 类型    | 必填 | 默认值    | 说明                                             |
-| ------------------ | ------- | ---- | --------- | ------------------------------------------------ |
-| mode               | string  | 否   | dialog    | 地图显示的类型， dialog 弹窗显示、 show 直接显示 |
-| element            | string  | 否   | Polypoint | 地图绘制的元素名Polypoint&Polyline&Polygon |
-| layout             | string  | 否   | ver       | 选择器和地图的布局 hor 水平、 ver 垂直           |
-| hasSearch          | boolean | 否   | true      | 是否允许搜索                                     |
-| isAutoFixAddr      | boolean | 否   | false     | 打开地图时是否根据经纬度自动修正已填的地址       |
-| lonKey             | string  | 否   | longitude | 经度字段 key                                     |
-| latKey             | string  | 否   | latitude  | 维度字段 key                                     |
-| addrKey            | string  | 否   | address   | 地址字段 key                                     |
-| isAutoSearch       | boolean | 否   | false     | 搜索框是否自动搜索                               |
-| markerIconConf     | Object  | 否   | -         | markerIcon 配置对象                              |
-| icons              | Object  | 否   | -         | icon 图片配置                                    |
-| getCurPositionConf | Object  | 否   | -         | getCurrentPosition Config                        |
-
-#### icons
-
-| 参数         | 类型   | 必填 | 默认值 | 说明                     |
-| ------------ | ------ | ---- | ------ | ------------------------ |
-| markerIcon   | string | 否   | dialog | marker icon 图片地址     |
-| pickerIcon   | string | 否   | dialog | 选点 icon 图片地址或元素 |
-| positionIcon | string | 否   | dialog | 定位 icon 图片地址或元素 |
-| resetIcon    | string | 否   | dialog | 重置 icon 图片地址或元素 |

package/src/components/RichEditor/README.md

@@ -1,82 +0,0 @@
-## PC使用前安装依赖
-
-npm install @wangeditor/editor-for-react
-
-## 引入
-
-```jsx
-import wangEditor from "./wangEditor";
-
-export default function AMap(props) {
-  return <wangEditor ref={editorRef}></wangEditor>;
-}
-```
-向富文本内set内容
-editorRef.current.setEditorContent(HtmlString)
-
-获取富文本当前内容
-editorRef.current.getEditorContent()
-
-
-### InfoPanel Attributes
-
-| 参数                | 类型                    | 必填  | 默认值    | 
-| ------------------ | ----------------------  | ---- | --------- | 
-| toolbarConfig      | Partial<IToolbarConfig> | 否   | {}  | 
-| editorConfig       | Partial<IEditorConfig>  | 否   | { placeholder: '请输入内容...' }   |   
-
-图片上传的配置
-```jsx
-editorConfig = {
-  MENU_CONF{
-    uploadImage:{
-
-    server: '/api/upload',
-
-    // form-data fieldName ，默认值 'wangeditor-uploaded-image'
-    fieldName: 'your-custom-name',
-
-    // 单个文件的最大体积限制，默认为 2M
-    maxFileSize: 1 * 1024 * 1024, // 1M
-
-    // 最多可上传几个文件，默认为 100
-    maxNumberOfFiles: 10,
-
-    // 选择文件时的类型限制，默认为 ['image/*'] 。如不想限制，则设置为 []
-    allowedFileTypes: ['image/*'],
-
-    // 自定义上传参数，例如传递验证的 token 等。参数会被添加到 formData 中，一起上传到服务端。
-    meta: {
-        token: 'xxx',
-        otherKey: 'yyy'
-    },
-
-    // 将 meta 拼接到 url 参数中，默认 false
-    metaWithUrl: false,
-
-    // 自定义增加 http  header
-    headers: {
-        Accept: 'text/x-json',
-        otherKey: 'xxx'
-    },
-
-    // 跨域是否传递 cookie ，默认为 false
-    withCredentials: true,
-
-    // 超时时间，默认为 10 秒
-    timeout: 5 * 1000, // 5 秒
-    }
-  }
-}
-```
-
-## 移动端使用前安装依赖
-npm install lib-flexible
-
-```jsx
-import wangEditor from "./wangEditor/handleMobile";
-
-export default function AMap(props) {
-  return <HandleMobile content={HtmlString}></HandleMobile>;
-}
-```

package/src/components/TreeCheckbox/README.md

@@ -1,11 +0,0 @@
-### InfoPanel Attributes
-
-| 参数          | 类型    | 必填 | 默认值                                             | 说明                                          |
-| ------------- | ------- | ---- | -------------------------------------------------- | --------------------------------------------- |
-| dataSource    | Array   | 是   | -                                                  | 树数据                                        |
-| mergeFullLeaf | boolean | 否   | true                                               | 合并不存在 children 的层级                    |
-| mergeLeaf     | boolean | 否   | true                                               | 合并每一层级的叶子节点                        |
-| fieldNames    | Object  | 否   | { label: label, value: value, children: children } | 自定义 options 中 label value children 的字段 |
-| disabled      | boolean | 否   | false                                              | 禁用状态                                      |
-| readOnly      | boolean | 否   | false                                              | 只读状态                                      |
-| tabBox        | boolean | 否   | false                                              | 最外层使用 tab                                |

package/src/components/Upload/README.md

@@ -1,77 +0,0 @@
-# Uploader
-
-上传组件——使用 antd upload 组件封装而成
-
-- 支持 oss 上传
-- 支持限制文件大小
-- 支持预览
-- 支持配置下载模板
-
-### InfoPanel Attributes
-
-- 参数参考 antd upload 组件
-- props 参数 会覆盖 antd upload 组件已有配置项
-
-| 参数                 | 类型     | 必填 | 默认值   | 说明                                                                                 |
-| -------------------- | -------- | ---- | -------- | ------------------------------------------------------------------------------------ |
-| name                 | string   | 否   | file     | 文件名                                                                               |
-| accept               | string   | 否   | -        | 接受上传的文件类型, 详见 input accept Attribute                                      |
-| listType             | string   | 否   | text     | 上传列表的内建样式，支持三种基本样式 text, picture 和 picture-card                   |
-| maxCount             | number   | 否   | -        | 限制上传数量。当为 1 时，始终用最新上传的文件代替当前文件                            |
-| maxSize              | number   | 否   | -        | 限制上传的文件大小。                                                                 |
-| multiple             | boolean  | 否   | -        | 是否支持多选文件，ie10+ 支持。开启后按住 ctrl 可选择多个文件                         |
-| disabled             | boolean  | 否   | false    | 禁用状态                                                                             |
-| readOnly             | boolean  | 否   | false    | 只读状态                                                                             |
-| isResRemoveArr       | boolean  | 否   | false    | maxCount === 1 时，结果是否自动去除数组嵌套                                          |
-| uploadMode           | string   | 否   | oss      | 上传模式： 阿里云 oss: oss, 内部定制私有化部署: offline, 文件: file, 自定义: custom, |
-| ossServerUrl         | string   | 否   | -        | 获取 oss 参数的接口，默认 /api/v1/user/oss/getWebOssConfig                           |
-| ossOpt               | Object   | 否   | -        | oss 上传的配置参数                                                                   |
-| fileListConf         | Object   | 否   | {}       | 结果数据配置                                                                         |
-| previewConfig        | Object   | 否   | {}       | 预览场景配置（见下表）。仅影响列表/弹窗预览，不进入 onChange / 表单提交 |
-| previewBaseUrl       | string   | 否   | -        | 仅预览使用的域名/路径前缀（糖衣）。与 `previewConfig.url` 并存时，以 `previewConfig.url` 为准；不进入表单提交 |
-| onCountExceed        | Function | 否   | -        | 数量超出 maxCount 时的回调                                                           |
-| beforeUploadCheck    | Function | 否   | -        | 追加的 beforeUpload 检查，返回 Promise.reject() 进行拦截                             |
-| templateUrl          | string   | 否   | -        | 模板下载的地址                                                                       |
-| templateDownloadText | string   | 否   | 模板下载 | 模板下载按钮的文案                                                                   |
-| uploadParams         | Object   | 否   | {}       | 文件上传接口入参                                                                     |
-
-### previewConfig 预览配置
-
-| 参数 | 类型 | 必填 | 默认值 | 说明 |
-| ---- | ---- | ---- | ------ | ---- |
-| url | string | 否 | - | 预览域名或路径前缀，如 `https://cdn.example.com`。相对路径会拼到此前缀后用于列表缩略图与弹窗预览 |
-| query | object | 否 | - | 追加到预览地址的 query 对象，推荐写法，如 `{ loookType: 1 }` |
-| search | string | 否 | - | `?` 后的原始字符串（可不含 `?`），会先解析再与 `query` 合并；同名键以 `query` 为准 |
-
-兼容：把 `query` 写成字符串（如 `"loookType=1"`）时，组件会解析为 `search`，无需立刻改业务 schema。
-
-> **边界**：`previewConfig.url` / `previewBaseUrl` 只用于上传列表视图与弹窗预览；`onChange` 与表单提交仍使用后端返回的相对/原始路径，不会提交拼接后的完整地址。
-
-### fileListConf 结果数据配置
-
-| 参数     | 类型   | 必填 | 默认值 | 说明                         |
-| -------- | ------ | ---- | ------ | ---------------------------- | --------- | ---------- | --------- |
-| listMode | string | 否   | array  | 列表数据模式 "array"         | "jsonStr" | "splitStr" |
-| split    | string | 否   | ", "   | 字符串列表数据模式下的分隔符 |
-| itemMode | string | 否   | "url"  | 子项数据模式 "object"        | "file"    | "url"      | "jsonStr" |
-
-### ossOpt
-
-| 参数            | 类型   | 必填 | 默认值 | 说明                                                           |
-| --------------- | ------ | ---- | ------ | -------------------------------------------------------------- |
-| axios           | Object | 否   | -      | 发起请求的 axios                                               |
-| axiosConf       | Object | 否   | -      | axios 配置                                                     |
-| signatureParams | Object | 否   | -      | 请求 oss 上传地址接口的入参                                    |
-| serverUrl       | string | 否   | -      | 请求 oss 上传地址的接口，默认 /api/v1/user/oss/getWebOssConfig |
-
-#### signatureParams
-
-| 参数    | 类型   | 必填 | 默认值 | 说明                                                                          |
-| ------- | ------ | ---- | ------ | ----------------------------------------------------------------------------- |
-| fileAcl | string | 否   | -      | 是否是私有域上传 private-私有，public-read-公共读，public-read-write-公共读写 |
-
-### uploadParams
-
-| 参数    | 类型   | 必填 | 默认值 | 说明                                                                          |
-| ------- | ------ | ---- | ------ | ----------------------------------------------------------------------------- |
-| fileAcl | string | 否   | -      | 是否是私有域上传 private-私有，public-read-公共读，public-read-write-公共读写 |