@hzab/form-render 1.7.18 → 1.7.19

package/docs/components/LocationPicker.md

@@ -1,67 +0,0 @@
-# LocationPicker
-
-地图选点组件，基于高德地图。支持弹窗 / 内嵌展示，以及点、线、面绘制。
-
-## 使用前安装依赖
-
-```bash
-npm install @amap/amap-jsapi-loader
-```
-
-## 注意事项
-
-- `isObjectRes` 在 `@hzab/form-render@0.5.0` 版本中去除，结果全部存放在对象中
-- `changeMode` 在 `@hzab/form-render@0.5.1` 版本中去除，仅允许点击地图选点
-
-## Schema 示例
-
-```json
-{
-  "x-component": "LocationPicker",
-  "x-component-props": {
-    "mode": "dialog",
-    "hasSearch": true,
-    "lonKey": "longitude",
-    "latKey": "latitude",
-    "addrKey": "address"
-  }
-}
-```
-
-独立使用：
-
-```jsx
-import { LocationPicker } from "@hzab/form-render/src/components";
-
-export default function Demo() {
-  return <LocationPicker mode="dialog" hasSearch />;
-}
-```
-
-### LocationPicker 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 |
-| pointsKey          | string  | 否   | points    | 点位集合字段 key |
-| isAutoSearch       | boolean | 否   | true      | 搜索框是否自动搜索 |
-| modalConf          | Object  | 否   | -         | 弹窗额外配置 |
-| markerIconConf     | Object  | 否   | -         | marker icon 配置对象 |
-| icons              | Object  | 否   | -         | icon 图片配置，见下表 |
-| getCurPositionConf | Object  | 否   | -         | `getCurrentPosition` 配置 |
-
-#### icons
-
-| 参数         | 类型   | 必填 | 默认值 | 说明 |
-| ------------ | ------ | ---- | ------ | ---- |
-| markerIcon   | string | 否   | -      | marker icon 图片地址 |
-| pickerIcon   | string | 否   | -      | 选点 icon 图片地址或元素 |
-| positionIcon | string | 否   | -      | 定位 icon 图片地址或元素 |
-| resetIcon    | string | 否   | -      | 重置 icon 图片地址或元素 |

package/docs/components/PersonnelSelect.md

@@ -1,77 +0,0 @@
-# PersonnelSelect / RemoteSelect
-
-远程人员搜索下拉框。`PersonnelSelect` 为 Formily `connect` 包装；底层实现为 `RemoteSelect`，支持远程分页加载、搜索与自定义列表项。
-
-## Schema 示例
-
-```jsx
-<FormRender
-  schema={schema}
-  schemaScope={{
-    loadPersonnel(search, pagination) {
-      return Promise.resolve({
-        list: [{ userId: "1", userName: "张三", phoneNumber: "13800000000" }],
-        pagination: { ...pagination, total: 1 },
-      });
-    },
-  }}
-/>
-```
-
-```json
-{
-  "x-component": "PersonnelSelect",
-  "x-component-props": {
-    "mode": "multiple",
-    "labelInValue": true,
-    "loadData": "{{loadPersonnel}}"
-  }
-}
-```
-
-也可直接使用 `RemoteSelect`：
-
-```json
-{
-  "x-component": "RemoteSelect",
-  "x-component-props": {
-    "mode": "tags",
-    "loadData": "{{loadPersonnel}}"
-  }
-}
-```
-
-### Attributes
-
-| 参数              | 类型     | 必填 | 默认值 | 说明 |
-| ----------------- | -------- | ---- | ------ | ---- |
-| loadData          | Function | 是   | -      | `(search, pagination) => Promise<{ list, pagination }>` |
-| searchData        | Function | 否   | -      | 额外查询函数 |
-| mode              | string   | 是   | -      | `multiple` 或多选 tags 模式（`tags`） |
-| labelKey          | string   | 否   | userName | 列表项 label 字段 |
-| valueKey          | string   | 否   | userId   | 列表项 value 字段 |
-| disabledKey       | string   | 否   | disabled | 禁用字段 |
-| labelInValue      | boolean  | 否   | false  | 是否以 `{ label, value }` 形式回传 |
-| isClearable       | boolean  | 否   | false  | 下拉收起时是否清空列表缓存 |
-| initialPagination | Object   | 否   | `{ pageNum: 1, pageSize: 10 }` | 初始分页 |
-| listItemConfigs   | Array    | 否   | 姓名/主部门/主驻点/手机号/身份证 | 列表项展示字段配置 `{ label, key }[]` |
-| renderItem        | Function | 否   | -      | 自定义列表项渲染 |
-| customItemNode    | ReactNode\|Function | 否 | - | 自定义列表项中附加节点 |
-| avataProps        | Object   | 否   | -      | antd Avatar props |
-| disabledStyle     | Function | 否   | -      | `(disabled) => CSSProperties` |
-
-其余 props 透传 antd Select（如 `placeholder`、`disabled`）。
-
-### loadData 返回
-
-```ts
-{
-  list: Array<{ label?: string; value?: string | number; [key: string]: any }>;
-  pagination: {
-    pageNum: number;
-    pageSize: number;
-    total?: number;
-    hasMore?: boolean;
-  };
-}
-```

package/docs/components/RadioGroupWithTip.md

@@ -1,43 +0,0 @@
-# RadioGroupWithTip
-
-带描述文案、支持单项禁用的单选组。数据优先取 `dataSource`，否则取 Formily `field.dataSource`（schema `enum`）。
-
-## Schema 示例
-
-```json
-{
-  "x-component": "RadioGroupWithTip",
-  "enum": [
-    {
-      "label": "单次采集",
-      "value": 1,
-      "desc": "以人员为单位开展信息采集。"
-    },
-    {
-      "label": "按月采集",
-      "value": 2,
-      "desc": "以自然月为周期定期采集。",
-      "disabled": true
-    }
-  ]
-}
-```
-
-### RadioGroupWithTip Attributes
-
-| 参数       | 类型           | 必填 | 默认值 | 说明 |
-| ---------- | -------------- | ---- | ------ | ---- |
-| value      | string\|number | 否   | -      | 当前选中值 |
-| onChange   | Function       | 否   | -      | 选中变化回调 |
-| dataSource | Array          | 否   | field.dataSource | 选项列表，见下表 |
-
-其余 props 透传 antd `Radio.Group`。
-
-### dataSource / enum 子项
-
-| 参数     | 类型           | 必填 | 默认值 | 说明 |
-| -------- | -------------- | ---- | ------ | ---- |
-| label    | string         | 是   | -      | 主标题 |
-| value    | string\|number | 是   | -      | 选项值 |
-| desc     | string         | 否   | -      | 描述文案 |
-| disabled | boolean        | 否   | false  | 单项禁用 |

package/docs/components/RichEditor.md

@@ -1,94 +0,0 @@
-# RichEditor
-
-基于 wangEditor 的富文本编辑器，支持 OSS / 私有化上传。Schema 中可使用 `RichEditor` 或别名 `Editor`。
-
-## PC 使用前安装依赖
-
-```bash
-npm install @wangeditor/editor-for-react
-```
-
-## Schema 示例
-
-```json
-{
-  "x-component": "RichEditor",
-  "x-component-props": {
-    "height": "400px",
-    "uploadMode": "oss",
-    "toolbarConfig": {},
-    "editorConfig": {
-      "placeholder": "请输入内容..."
-    }
-  }
-}
-```
-
-独立使用：
-
-```jsx
-import { RichEditor } from "@hzab/form-render/src/components";
-import { useRef } from "react";
-
-export default function Demo() {
-  const editorRef = useRef();
-  return <RichEditor ref={editorRef} height="400px" />;
-}
-```
-
-向富文本 set 内容：`editorRef.current.setEditorContent(HtmlString)`
-
-获取富文本当前内容：`editorRef.current.getEditorContent()`
-
-### RichEditor Attributes
-
-| 参数              | 类型                    | 必填 | 默认值 | 说明 |
-| ----------------- | ----------------------- | ---- | ------ | ---- |
-| value             | string                  | 否   | -      | 编辑器 HTML 内容 |
-| onChange          | Function                | 否   | -      | 内容变化回调 |
-| height            | string                  | 否   | -      | 编辑器高度 |
-| toolbarConfig     | Partial\<IToolbarConfig\> | 否 | {}     | 工具栏配置 |
-| editorConfig      | Partial\<IEditorConfig\>  | 否 | `{ placeholder: '请输入内容...' }` | 编辑器配置 |
-| uploadMode        | string                  | 否   | oss    | 上传模式：`oss` / `offline` 等 |
-| ossOpt            | Object                  | 否   | -      | OSS 上传配置 |
-| uploadParams      | Object                  | 否   | {}     | 上传入参 |
-| ossServerUrl      | string                  | 否   | 全局配置或 `/api/v1/user/oss/getWebOssConfig` | 获取 OSS 配置接口 |
-| ossUrl            | string                  | 否   | 同 ossServerUrl | OSS 配置接口（兼容字段） |
-| offlineServerUrl  | string                  | 否   | -      | 私有化上传接口 |
-| offlinePreviewUrl | string                  | 否   | -      | 私有化预览前缀 |
-| customRequest     | Function                | 否   | -      | 自定义上传请求 |
-| zIndex            | number                  | 否   | 9999   | 编辑器层级 |
-
-图片上传可在 `editorConfig.MENU_CONF.uploadImage` 中配置，参考 [wangEditor 文档](https://www.wangeditor.com/v5/menu-config.html#upload-image)。
-
-```jsx
-editorConfig = {
-  MENU_CONF: {
-    uploadImage: {
-      server: "/api/upload",
-      fieldName: "your-custom-name",
-      maxFileSize: 1 * 1024 * 1024,
-      maxNumberOfFiles: 10,
-      allowedFileTypes: ["image/*"],
-      meta: { token: "xxx" },
-      headers: { Accept: "text/x-json" },
-      withCredentials: true,
-      timeout: 5 * 1000,
-    },
-  },
-};
-```
-
-## 移动端使用前安装依赖
-
-```bash
-npm install lib-flexible
-```
-
-```jsx
-import HandleMobile from "./components/handleMobileVw";
-
-export default function Demo() {
-  return <HandleMobile content={HtmlString} />;
-}
-```

package/docs/components/Text.md

@@ -1,26 +0,0 @@
-# Text
-
-只读文本展示组件，常用于 schema 合并、LocationListPicker 弹层等内部场景；也可在 schema 中直接使用。
-
-## Schema 示例
-
-```json
-{
-  "x-component": "Text",
-  "x-component-props": {
-    "content": "静态文案",
-    "mode": "div"
-  }
-}
-```
-
-表单字段有值时优先展示 `value`，否则展示 `content`。
-
-### Text Attributes
-
-| 参数      | 类型   | 必填 | 默认值 | 说明 |
-| --------- | ------ | ---- | ------ | ---- |
-| value     | any    | 否   | -      | 字段值，优先展示 |
-| content   | any    | 否   | -      | 无 value 时的静态内容 |
-| mode      | string | 否   | div    | 渲染标签名；`normal` 或不传时为 `div`，也可设为 `span` / `p` 等 |
-| className | string | 否   | -      | 附加 class，根节点带 `formily-text` |

package/docs/components/TreeCheckbox.md

@@ -1,52 +0,0 @@
-# TreeCheckbox
-
-树形多选复选框，支持按层级合并叶子节点，以及最外层 Tab 展示。
-
-## Schema 示例
-
-```json
-{
-  "x-component": "TreeCheckbox",
-  "x-component-props": {
-    "mergeLeaf": true,
-    "mergeFullLeaf": true,
-    "tabBox": false,
-    "fieldNames": {
-      "label": "label",
-      "value": "value",
-      "children": "children"
-    }
-  },
-  "enum": [
-    {
-      "label": "一级",
-      "value": "1",
-      "children": [
-        { "label": "二级-1", "value": "1-1" },
-        { "label": "二级-2", "value": "1-2" }
-      ]
-    }
-  ]
-}
-```
-
-数据也可通过 `x-component-props.dataSource` 或 `field.dataSource` 传入。
-
-### TreeCheckbox Attributes
-
-| 参数          | 类型    | 必填 | 默认值                                             | 说明 |
-| ------------- | ------- | ---- | -------------------------------------------------- | ---- |
-| dataSource    | Array   | 否   | field.dataSource                                   | 树数据 |
-| mergeFullLeaf | boolean | 否   | true                                               | 合并不存在 children 的层级 |
-| mergeLeaf     | boolean | 否   | true                                               | 合并每一层级的叶子节点 |
-| fieldNames    | Object  | 否   | `{ label, value, children }`                       | 自定义 options 中字段名 |
-| disabled      | boolean | 否   | false                                              | 禁用状态 |
-| readOnly      | boolean | 否   | false                                              | 只读状态 |
-| tabBox        | boolean | 否   | false                                              | 最外层使用 tab |
-| tabConfList   | Array   | 否   | -                                                  | tab 配置列表；存在时优先用于计算 tab 层级数 |
-| tabLevel      | number  | 否   | -                                                  | tab 层级数（`tabBox === true` 时为 1） |
-| labelKey      | string  | 否   | label                                              | 兼容旧字段，后续废弃 |
-| valueKey      | string  | 否   | value                                              | 兼容旧字段，后续废弃 |
-| childrenKey   | string  | 否   | children                                           | 兼容旧字段，后续废弃 |
-
-表单值为选中节点 `value` 组成的数组。

package/docs/components/Upload.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-公共读写 |

package/docs/components/UserSelect.md

@@ -1,59 +0,0 @@
-# UserSelect
-
-人员下拉选择器，基于 antd Select，支持头像、手机号、身份证号等扩展展示。
-
-## Schema 示例
-
-```json
-{
-  "x-component": "UserSelect",
-  "x-component-props": {
-    "isAvatar": true,
-    "avatarSize": "default",
-    "configKey": {
-      "phoneKey": "phone",
-      "idCardKey": "idCard"
-    }
-  },
-  "enum": [
-    {
-      "label": "张三",
-      "value": "1",
-      "phone": "13800000000",
-      "idCard": "3301**********1234",
-      "avatar": "https://example.com/avatar.png"
-    }
-  ]
-}
-```
-
-数据源也可通过 Formily `field.dataSource` 或 `x-component-props.options` 传入。
-
-### UserSelect Attributes
-
-| 参数       | 类型     | 必填 | 默认值  | 说明 |
-| ---------- | -------- | ---- | ------- | ---- |
-| options    | Array    | 否   | -       | 下拉数据；也可使用 schema `enum` / `field.dataSource` |
-| isAvatar   | boolean  | 否   | false   | 是否显示头像 |
-| avatarSize | AvatarSize | 否 | default | antd Avatar 尺寸 |
-| configKey  | Object   | 否   | -       | 自定义字段映射，见下表 |
-| InfoRender | Function | 否   | -       | 自定义 option 信息区渲染，入参为 option 对象 |
-
-其余 props 透传 antd Select。
-
-### configKey
-
-| 参数      | 类型   | 必填 | 默认值 | 说明 |
-| --------- | ------ | ---- | ------ | ---- |
-| phoneKey  | string | 否   | phone  | 手机号字段名 |
-| idCardKey | string | 否   | idCard | 身份证号字段名 |
-
-### options 子项
-
-| 参数   | 类型           | 必填 | 默认值 | 说明 |
-| ------ | -------------- | ---- | ------ | ---- |
-| label  | string         | 是   | -      | 展示名称 |
-| value  | string\|number | 是   | -      | 选项值 |
-| avatar | string         | 否   | -      | 头像 URL |
-| phone  | string         | 否   | -      | 手机号（可被 configKey 覆盖） |
-| idCard | string         | 否   | -      | 身份证号（可被 configKey 覆盖） |