diff --git a/README.md b/README.md index e7bac1a..bb3f9bc 100644 --- a/README.md +++ b/README.md @@ -167,19 +167,19 @@ import { FORM_ITEM_RENDER_ENUM } from "zy-react-library/enum/formItemRender"; ### OptionItem -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `bianma` | `any` | 否 | 默认选项值字段。 | -| `name` | `string \| ReactNode` | 否 | 默认选项标签字段。 | -| `disabled` | `boolean` | 否 | 是否禁用当前选项。 | -| `[key: string]` | `any` | 否 | 允许携带业务自定义字段。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `bianma` | `any` | 否 | - | 默认选项值字段。 | +| `name` | `string \| ReactNode` | 否 | - | 默认选项标签字段。 | +| `disabled` | `boolean` | 否 | `false` | 是否禁用当前选项。 | +| `[key: string]` | `any` | 否 | - | 允许携带业务自定义字段。 | ### ItemsFieldConfig -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `valueKey` | `string` | 否 | 选项值字段名,默认使用 `bianma`。 | -| `labelKey` | `string \| ((item) => ReactNode)` | 否 | 选项标签字段名或自定义标签渲染函数,默认使用 `name`。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `valueKey` | `string` | 否 | `"bianma"` | 选项值字段名。 | +| `labelKey` | `string \| ((item) => ReactNode)` | 否 | `"name"` | 选项标签字段名或自定义标签渲染函数。 | ### FormListUniqueProps @@ -219,21 +219,35 @@ import { FORM_ITEM_RENDER_ENUM } from "zy-react-library/enum/formItemRender"; | `HeaderBack` | `previous=true`。 | | `Upload` | `value=[]`、`ratio=""`、`showTip=true`、`multiple=true`;未传 `fileType` 时根据 `accept` 推断,默认按图片;图片默认 `accept=".jpg,.jpeg,.png"`、`maxCount=4`、`size=10`;视频默认 `accept=".mp4"`、`maxCount=1`、`size=100`;文档默认 `accept=".pdf,.doc,.docx"`、`maxCount=4`、`size=10`。 | | `ImportFile` | `title="导入"`、`labelCol={ span: 4 }`、`exportTemplateButtonText="导出模板"`;弹窗宽度 `600`,内置附件上传 `accept=".xls,.xlsx"`、`listType="text"`、`maxCount=1`。 | +| `PreviewImg` | `files=[]`、`fileUrlKey="filePath"`;图片固定 `width=100`、`height=100`,图片间距 `marginRight=10`、`marginBottom=10`。 | +| `PreviewPdf` | `files=[]`、`nameKey=""`、`urlKey=""`、`name=""`、`url=""`。 | | `Pdf` | `visible=false`、`inline=false`、`title="PDF预览"`、`style={}`。 | +| `Video` | `source=""`、`vid=""`、`playAuth=""`、`cover=""`、`autoplay=true`、`showProgress=true`、`playTime=0`、`inline=false`、`isLive=false`、`width="100%"`、`height="600px"`、`title="视频"`、`visible=false`、`aliPlayerProps={}`;弹窗宽度 `800`。 | +| `AliPlayer` | `source=""`、`vid=""`、`playAuth=""`、`cover=""`、`width="100%"`、`height="600px"`、`autoplay=true`、`showProgress=true`、`isLive=false`、`playTime=0`。 | +| `Signature` | `width=752`、`height=300`、`url=""`;签名弹窗宽度 `800`,画笔颜色 `black`,画布背景 `rgb(255,255,255)`。 | | `TooltipPreviewImg` | `files=[]`、`fileUrlKey="filePath"`。 | +| `SelectCreate` | `showDelete=true`、`label=""`、`maxCount=1`,内部固定 `mode="tags"`。 | | `BasicSelect` | `placeholder=""`、`data=[]`、`nameKey="name"`、`idKey="id"`,内置 `showSearch=true`、`allowClear=true`、`optionFilterProp="children"`。 | | `DictionarySelect` | `appKey=DICTIONARY_APP_KEY_ENUM.DEFAULT`、`dictValue=""`、`nameKey="dictLabel"`、`idKey="dictValue"`。 | | `PersonnelSelect` | `params={}`、`placeholder="人员"`、`isNeedCorpInfoId=false`、`isNeedDepartmentId=true`、`isNeedPostId=false`、`extraParams={}`,内部默认额外参数 `{ noMain: "", eqEmploymentFlag: 1 }`。 | | `BasicSelectTree` | `getNodePathsIsIncludeOneself=true`、`placeholder=""`、`treeData=[]`、`nameKey="name"`、`idKey="id"`、`childrenKey="children"`、`onlyLastLevel=false`,内置 `showSearch=true`、`allowClear=true`、`style={ width: "100%" }`。 | +| `AreaSelectTree` | 内部使用 `area.json`,默认 `nameKey="label"`、`idKey="value"`。 | +| `IndustrySelectTree` | 内部使用 `industry.json`,默认 `nameKey="dict_label"`、`idKey="dict_value"`、`childrenKey="childrenList"`。 | +| `DepartmentSelectTree` | `params={}`、`placeholder="部门"`、`isNeedCorpInfoId=false`、`isNeedParentId=false`、`searchType="current"`,内部固定 `childrenKey="childrenList"`。 | | `DictionarySelectTree` | `appKey=DICTIONARY_APP_KEY_ENUM.DEFAULT`、`dictValue=""`、`nameKey="dictLabel"`、`idKey="dictValue"`。 | | `HiddenLevelSelectTree` | `isShowNeglect=true`、`isShowLarger=true`、`isShowMajor=true`,内部固定 `placeholder="隐患级别"`、`onlyLastLevel=true`、`nameKey="dictLabel"`、`idKey="dictValue"`。 | +| `HiddenPartSelectTree` | `params={}`、`isNeedCorpInfoId=false`,内部固定 `placeholder="隐患部位"`、`nameKey="hiddenregion"`、`idKey="hiddenregionId"`。 | | `BasicCascader` | `getNodePathsIsIncludeOneself=true`、`placeholder=""`、`data=[]`、`nameKey="name"`、`idKey="id"`、`childrenKey="children"`。 | | `AreaCascader` | 内部使用 `area.json`,默认 `nameKey="label"`、`idKey="value"`。 | | `IndustryCascader` | 内部使用 `industry.json`,默认 `nameKey="dict_label"`、`idKey="dict_value"`、`childrenKey="childrenList"`。 | | `DictionaryCascader` | `appKey=DICTIONARY_APP_KEY_ENUM.DEFAULT`、`dictValue=""`、`nameKey="dictLabel"`、`idKey="dictValue"`。 | | `BasicLeftTree` | `getNodePathsIsIncludeOneself=true`、`treeData=[]`、`nameKey="name"`、`idKey="id"`、`childrenKey="children"`,搜索框固定宽度容器 `300`。 | +| `AreaLeftTree` | 内部使用 `area.json`,默认 `nameKey="label"`、`idKey="value"`。 | +| `DictionaryLeftTree` | `appKey=DICTIONARY_APP_KEY_ENUM.DEFAULT`、`dictValue=""`、`nameKey="dictLabel"`、`idKey="dictValue"`。 | +| `DepartmentLeftTree` | `params={}`、`searchType="current"`,内部固定 `childrenKey="childrenList"`。 | | `Map` | `longitudeProps="longitude"`、`latitudeProps="latitude"`、`required=true`、`area=""`、`showArea=false`、`disable=false`、`type="baidu"`。 | | `MapSelector` | `area=""`、`showArea=false`、`disable=false`、`type="baidu"`;弹窗宽度 `1000`、`maskClosable=false`、地图容器高度 `500px`。 | +| `SeamlessScroll` | `value=true`、`list=[]`、`step=1`、`limitScrollNum=3`、`hover=true`、`direction="up"`、`singleHeight=0`、`singleWidth=0`、`singleWaitTime=1000`、`isRemUnit=false`、`isWatch=true`、`delay=0`、`ease="ease-in"`、`count=-1`、`copyNum=1`、`wheel=false`、`singleLine=false`。 | | `HiddenInfo` | `id=""`、`idKey="id"`、`hiddenId=""`、`hiddenIdKey="hiddenId"`、`history=false`。 | ### Table @@ -342,20 +356,20 @@ import Page from "zy-react-library/components/Page"; 页面容器组件。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `headerTitle` | `ReactNode` | 否 | 页头标题。 | -| `history` | `{ goBack?: () => void; [key: string]: any }` | 否 | 路由历史对象,用于返回。 | -| `isShowHeader` | `boolean` | 否 | 是否显示头部。 | -| `headerPrevious` | `boolean` | 否 | 头部是否显示返回能力。 | -| `isShowFooter` | `boolean` | 否 | 是否显示底部操作区。 | -| `isShowAllAction` | `boolean` | 否 | 是否显示默认全部操作。 | -| `loading` | `boolean` | 否 | 页面加载状态。 | -| `backButtonText` | `string` | 否 | 返回按钮文案。 | -| `contentPadding` | `string` | 否 | 内容区内边距。 | -| `customActionButtons` | `ReactNode` | 否 | 自定义底部操作按钮。 | -| `extraActionButtons` | `ReactNode` | 否 | 额外底部操作按钮。 | -| `children` | `ReactNode \| (() => ReactNode)` | 是 | 页面内容。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `headerTitle` | `ReactNode` | 否 | - | 页头标题。 | +| `history` | `{ goBack?: () => void; [key: string]: any }` | 否 | `window.history.back` | 路由历史对象,用于返回;没有 `history.goBack` 时使用浏览器返回。 | +| `isShowHeader` | `boolean` | 否 | `true` | 是否显示头部。 | +| `headerPrevious` | `boolean` | 否 | `true` | 头部是否显示返回能力。 | +| `isShowFooter` | `boolean` | 否 | `true` | 是否显示底部操作区。 | +| `isShowAllAction` | `boolean` | 否 | `true` | 是否显示默认全部操作。 | +| `loading` | `boolean` | 否 | `false` | 页面加载状态,控制外层 `Spin`。 | +| `backButtonText` | `string` | 否 | `"关闭"` | 返回按钮文案。 | +| `contentPadding` | `string` | 否 | `"20px"` | 内容区内边距。 | +| `customActionButtons` | `ReactNode` | 否 | - | 自定义底部操作按钮;传入后替换默认底部按钮组。 | +| `extraActionButtons` | `ReactNode` | 否 | - | 额外底部操作按钮,插入默认关闭按钮前。 | +| `children` | `ReactNode \| (() => ReactNode)` | 是 | - | 页面内容。 | ### HeaderBack @@ -367,11 +381,11 @@ import HeaderBack from "zy-react-library/components/HeaderBack"; 页头返回组件。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `title` | `ReactNode` | 是 | 标题内容。 | -| `history` | `{ goBack?: () => void; [key: string]: any }` | 否 | 路由历史对象。 | -| `previous` | `boolean` | 否 | 是否显示返回操作。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `title` | `ReactNode` | 是 | - | 标题内容。 | +| `history` | `{ goBack?: () => void; [key: string]: any }` | 否 | `window.history.back` | 路由历史对象;没有 `history.goBack` 时使用浏览器返回。 | +| `previous` | `boolean` | 否 | `true` | 是否显示返回操作。 | ### Upload @@ -383,16 +397,20 @@ import Upload from "zy-react-library/components/Upload"; 上传组件,继承 `Omit`。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `value` | `UploadFile[]` | 否 | 当前文件列表。 | -| `ratio` | `` `${number}*${number}` `` | 否 | 图片宽高比例提示,例如 `"16*9"`。 | -| `showTip` | `boolean` | 否 | 是否显示上传提示。 | -| `size` | `number` | 否 | 文件大小限制。 | -| `tipContent` | `ReactNode` | 否 | 自定义提示内容。 | -| `uploadButtonText` | `string` | 否 | 上传按钮文案。 | -| `fileType` | `"image" \| "video" \| "document"` | 否 | 文件类型。 | -| `onGetRemoveFile` | `(file: Omit) => void` | 否 | 删除文件时返回被移除的文件。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `value` | `UploadFile[]` | 否 | `[]` | 当前文件列表。 | +| `ratio` | `` `${number}*${number}` `` | 否 | `""` | 图片宽高比例提示,例如 `"16*9"`。 | +| `showTip` | `boolean` | 否 | `true` | 是否显示上传提示。 | +| `size` | `number` | 否 | 图片/文档 `10`,视频 `100` | 文件大小限制,单位 MB。 | +| `tipContent` | `ReactNode` | 否 | 自动生成提示文案 | 自定义提示内容。 | +| `uploadButtonText` | `string` | 否 | 视频 `"上传视频"`,其他 `"上传附件"` | 上传按钮文案。 | +| `fileType` | `"image" \| "video" \| "document"` | 否 | 根据 `accept` 推断,默认 `"image"` | 文件类型。 | +| `onGetRemoveFile` | `(file: Omit) => void` | 否 | - | 删除文件时返回被移除的文件。 | +| `multiple` | `boolean` | 否 | `true` | 是否允许多选,继承自 antd Upload。 | +| `maxCount` | `number` | 否 | 图片/文档 `4`,视频 `1` | 最大上传数量,继承自 antd Upload。 | +| `accept` | `string` | 否 | 图片 `.jpg,.jpeg,.png`;视频 `.mp4`;文档 `.pdf,.doc,.docx` | 允许的文件类型,继承自 antd Upload。 | +| `listType` | `string` | 否 | 图片 `"picture-card"`,其他 `"text"` | 上传列表样式,继承自 antd Upload。 | ### ImportFile @@ -404,16 +422,17 @@ import ImportFile from "zy-react-library/components/ImportFile"; 文件导入弹窗,继承 `Omit`。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `visible` | `boolean` | 是 | 是否显示弹窗。 | -| `title` | `string` | 否 | 弹窗标题。 | -| `templateUrl` | `string` | 否 | 导入模板下载地址。 | -| `children` | `ReactNode \| ((props: { form: FormInstance }) => ReactNode)` | 否 | 自定义弹窗内容;函数形式可拿到内部表单实例。 | -| `onConfirm` | `(values: { file?: UploadFile[]; [key: string]: any }) => void` | 是 | 确认导入回调。 | -| `onCancel` | `() => void` | 是 | 取消回调。 | -| `exportTemplateButtonText` | `ReactNode` | 否 | 下载模板按钮文案。 | -| `extraButtons` | `ReactNode` | 否 | 额外按钮。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `visible` | `boolean` | 是 | - | 是否显示弹窗。 | +| `title` | `string` | 否 | `"导入"` | 弹窗标题。 | +| `templateUrl` | `string` | 否 | - | 导入模板下载地址。 | +| `children` | `ReactNode \| ((props: { form: FormInstance }) => ReactNode)` | 否 | - | 自定义弹窗内容;函数形式可拿到内部表单实例。 | +| `onConfirm` | `(values: { file?: UploadFile[]; [key: string]: any }) => void` | 是 | - | 确认导入回调。 | +| `onCancel` | `() => void` | 是 | - | 取消回调。 | +| `exportTemplateButtonText` | `ReactNode` | 否 | `"导出模板"` | 下载模板按钮文案。 | +| `extraButtons` | `ReactNode` | 否 | - | 额外按钮。 | +| `labelCol` | `ColProps` | 否 | `{ span: 4 }` | 表单标签栅格,继承自 `FormProps`。 | ### PreviewImg @@ -425,10 +444,10 @@ import PreviewImg from "zy-react-library/components/PreviewImg"; 图片预览组件。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `files` | `string[] \| { filePath?: string; [key: string]: string }[]` | 是 | 图片地址数组,或包含图片地址字段的对象数组。 | -| `fileUrlKey` | `string` | 否 | 对象数组中图片地址字段名。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `files` | `string[] \| { filePath?: string; [key: string]: string }[]` | 是 | `[]` | 图片地址数组,或包含图片地址字段的对象数组。 | +| `fileUrlKey` | `string` | 否 | `"filePath"` | 对象数组中图片地址字段名。 | ### TooltipPreviewImg @@ -450,13 +469,13 @@ import PreviewPdf from "zy-react-library/components/PreviewPdf"; PDF 预览入口组件。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `files` | `{ filePath?: string; fileName?: string; name?: string; [key: string]: string }[]` | 否 | PDF 文件对象数组。 | -| `nameKey` | `string` | 否 | 文件名字段名。 | -| `urlKey` | `string` | 否 | 文件地址字段名。 | -| `name` | `string` | 否 | 单文件文件名。 | -| `url` | `string` | 否 | 单文件地址。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `files` | `{ filePath?: string; fileName?: string; name?: string; [key: string]: string }[]` | 否 | `[]` | PDF 文件对象数组。 | +| `nameKey` | `string` | 否 | `""` | 文件名字段名;不传时优先取 `name`、`fileName`。 | +| `urlKey` | `string` | 否 | `""` | 文件地址字段名;不传时优先取 `filePath`。 | +| `name` | `string` | 否 | `""` | 单文件文件名。 | +| `url` | `string` | 否 | `""` | 单文件地址。 | ### Pdf @@ -468,15 +487,15 @@ import Pdf from "zy-react-library/components/Pdf"; PDF 展示组件。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `file` | `string` | 是 | PDF 文件地址。 | -| `name` | `string` | 否 | 文件名。 | -| `visible` | `boolean` | 否 | 是否以弹窗形式显示。 | -| `title` | `string` | 否 | 弹窗标题。 | -| `onCancel` | `() => void` | 否 | 关闭弹窗回调。 | -| `inline` | `boolean` | 否 | 是否内联展示。 | -| `style` | `CSSProperties` | 否 | 外层样式。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `file` | `string` | 是 | - | PDF 文件地址。 | +| `name` | `string` | 否 | - | 文件名。 | +| `visible` | `boolean` | 否 | `false` | 是否以弹窗形式显示。 | +| `title` | `string` | 否 | `"PDF预览"` | 弹窗标题。 | +| `onCancel` | `() => void` | 否 | - | 关闭弹窗回调。 | +| `inline` | `boolean` | 否 | `false` | 是否内联展示。 | +| `style` | `CSSProperties` | 否 | `{}` | 外层样式。 | ### Video @@ -488,12 +507,12 @@ import Video from "zy-react-library/components/Video"; 视频播放组件,继承 `AliPlayerProps`。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `title` | `string` | 否 | 弹窗标题。 | -| `visible` | `boolean` | 否 | 是否显示弹窗。 | -| `inline` | `boolean` | 否 | 是否内联展示。 | -| `onCancel` | `() => void` | 否 | 关闭回调。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `title` | `string` | 否 | `"视频"` | 弹窗标题。 | +| `visible` | `boolean` | 否 | `false` | 是否显示弹窗;传 `onCancel` 时由外部控制。 | +| `inline` | `boolean` | 否 | `false` | 是否内联展示。 | +| `onCancel` | `() => void` | 否 | 内部状态关闭 | 关闭回调;不传时组件内部维护弹窗显隐。 | ### AliPlayer @@ -505,22 +524,22 @@ import AliPlayer from "zy-react-library/components/Video/AliPlayer"; 阿里云播放器封装,支持 `ref`。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `source` | `string \| string[]` | 否 | 视频播放地址。 | -| `vid` | `string` | 否 | 阿里云视频 ID。 | -| `playAuth` | `string` | 否 | 阿里云播放凭证。 | -| `cover` | `string` | 否 | 封面地址。 | -| `width` | `string` | 否 | 播放器宽度。 | -| `height` | `string` | 否 | 播放器高度。 | -| `autoplay` | `boolean` | 否 | 是否自动播放。 | -| `showProgress` | `boolean` | 否 | 是否显示进度条。 | -| `isLive` | `boolean` | 否 | 是否为直播。 | -| `playTime` | `number` | 否 | 初始播放时间。 | -| `onEnded` | `() => void` | 否 | 播放结束回调。 | -| `onTimeupdate` | `(currentTime: number) => void` | 否 | 播放时间更新回调。 | -| `onGetPlayerInstance` | `(player: any) => void` | 否 | 获取播放器实例。 | -| `aliPlayerProps` | `Record` | 否 | 透传给 AliPlayer 的额外属性。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `source` | `string \| string[]` | 否 | `""` | 视频播放地址。 | +| `vid` | `string` | 否 | `""` | 阿里云视频 ID。 | +| `playAuth` | `string` | 否 | `""` | 阿里云播放凭证。 | +| `cover` | `string` | 否 | `""` | 封面地址。 | +| `width` | `string` | 否 | `"100%"` | 播放器宽度。 | +| `height` | `string` | 否 | `"600px"` | 播放器高度。 | +| `autoplay` | `boolean` | 否 | `true` | 是否自动播放。 | +| `showProgress` | `boolean` | 否 | `true` | 是否显示进度条。 | +| `isLive` | `boolean` | 否 | `false` | 是否为直播。 | +| `playTime` | `number` | 否 | `0` | 初始播放时间,大于 0 时会 seek 到该时间。 | +| `onEnded` | `() => void` | 否 | - | 播放结束回调。 | +| `onTimeupdate` | `(currentTime: number) => void` | 否 | - | 播放时间更新回调。 | +| `onGetPlayerInstance` | `(player: any) => void` | 否 | - | 获取播放器实例。 | +| `aliPlayerProps` | `Record` | 否 | - | 透传给 AliPlayer 的额外属性。 | Ref 方法: @@ -540,11 +559,11 @@ import Editor from "zy-react-library/components/Editor"; 富文本编辑器组件,支持 `ref`。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `value` | `string` | 否 | HTML 内容。 | -| `onChange` | `(html: string) => void` | 否 | 内容变化回调。 | -| `disabled` | `boolean` | 否 | 是否禁用编辑。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `value` | `string` | 否 | - | HTML 内容。 | +| `onChange` | `(html: string) => void` | 否 | - | 内容变化回调。 | +| `disabled` | `boolean` | 否 | - | 是否禁用编辑。 | Ref 方法: @@ -565,12 +584,12 @@ import Signature from "zy-react-library/components/Signature"; 手写签名组件。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `onConfirm` | `(value: SignatureValue) => void` | 是 | 确认签名回调。 | -| `width` | `number` | 否 | 画布宽度。 | -| `height` | `number` | 否 | 画布高度。 | -| `url` | `string` | 否 | 已有签名图片地址。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `onConfirm` | `(value: SignatureValue) => void` | 是 | - | 确认签名回调。 | +| `width` | `number` | 否 | `752` | 签名画布宽度。 | +| `height` | `number` | 否 | `300` | 签名画布高度,也用于已签名图片预览高度。 | +| `url` | `string` | 否 | `""` | 已有签名图片地址。 | `SignatureValue`: @@ -590,16 +609,16 @@ import Map from "zy-react-library/components/Map"; 地图选择组件。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `longitudeProps` | `string` | 否 | 经度字段名。 | -| `latitudeProps` | `string` | 否 | 纬度字段名。 | -| `required` | `boolean` | 否 | 是否必填。 | -| `area` | `string` | 否 | 区域文本。 | -| `showArea` | `boolean` | 否 | 是否显示区域。 | -| `disable` | `boolean` | 否 | 是否禁用选择。 | -| `onConfirm` | `(longitude, latitude, extra: { area: string }) => void` | 否 | 确认选择回调。 | -| `type` | `"baidu" \| "cesium"` | 否 | 地图类型。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `longitudeProps` | `string` | 否 | `"longitude"` | 经度字段名。 | +| `latitudeProps` | `string` | 否 | `"latitude"` | 纬度字段名。 | +| `required` | `boolean` | 否 | `true` | 是否必填。 | +| `area` | `string` | 否 | `""` | 区域文本。 | +| `showArea` | `boolean` | 否 | `false` | 是否显示区域。 | +| `disable` | `boolean` | 否 | `false` | 是否禁用选择。 | +| `onConfirm` | `(longitude, latitude, extra: { area: string }) => void` | 否 | - | 确认选择回调。 | +| `type` | `"baidu" \| "cesium"` | 否 | `"baidu"` | 地图类型。 | ### MapSelector @@ -611,17 +630,17 @@ import MapSelector from "zy-react-library/components/Map/MapSelector"; 地图选择弹窗。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `visible` | `boolean` | 是 | 是否显示弹窗。 | -| `onClose` | `() => void` | 是 | 关闭回调。 | -| `longitude` | `number \| string` | 否 | 初始经度。 | -| `latitude` | `number \| string` | 否 | 初始纬度。 | -| `area` | `string` | 否 | 初始区域文本。 | -| `showArea` | `boolean` | 否 | 是否显示区域。 | -| `disable` | `boolean` | 否 | 是否禁用选择。 | -| `onConfirm` | `(longitude, latitude, extra: { area: string }) => void` | 否 | 确认选择回调。 | -| `type` | `"baidu" \| "cesium"` | 否 | 地图类型。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `visible` | `boolean` | 是 | - | 是否显示弹窗。 | +| `onClose` | `() => void` | 是 | - | 关闭回调。 | +| `longitude` | `number \| string` | 否 | `""` | 初始经度;不传时使用 `window.mapLongitude` 初始化地图中心。 | +| `latitude` | `number \| string` | 否 | `""` | 初始纬度;不传时使用 `window.mapLatitude` 初始化地图中心。 | +| `area` | `string` | 否 | `""` | 初始区域文本。 | +| `showArea` | `boolean` | 否 | `false` | 是否显示区域。 | +| `disable` | `boolean` | 否 | `false` | 是否禁用选择。 | +| `onConfirm` | `(longitude, latitude, extra: { area: string }) => void` | 否 | - | 确认选择回调。 | +| `type` | `"baidu" \| "cesium"` | 否 | `"baidu"` | 地图类型。 | ### SeamlessScroll @@ -633,26 +652,26 @@ import SeamlessScroll from "zy-react-library/components/SeamlessScroll"; 无缝滚动组件,支持 `ref.reset()`。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `value` | `boolean` | 否 | 是否启用滚动。 | -| `list` | `unknown[]` | 是 | 滚动数据列表。 | -| `step` | `number` | 否 | 滚动步长。 | -| `limitScrollNum` | `number` | 否 | 触发滚动的最小数据条数。 | -| `hover` | `boolean` | 否 | 鼠标悬浮时是否暂停。 | -| `direction` | `"up" \| "down" \| "left" \| "right"` | 否 | 滚动方向。 | -| `singleHeight` | `number` | 否 | 单条高度。 | -| `singleWidth` | `number` | 否 | 单条宽度。 | -| `singleWaitTime` | `number` | 否 | 单步滚动等待时间。 | -| `isRemUnit` | `boolean` | 否 | 尺寸是否使用 rem 单位。 | -| `isWatch` | `boolean` | 否 | 是否监听数据变化并重置滚动。 | -| `delay` | `number` | 否 | 动画延迟。 | -| `ease` | `string \| { x1: number; y1: number; x2: number; y2: number }` | 否 | 动画缓动函数。 | -| `count` | `number` | 否 | 滚动次数。 | -| `copyNum` | `number` | 否 | 复制列表份数。 | -| `wheel` | `boolean` | 否 | 是否支持滚轮。 | -| `singleLine` | `boolean` | 否 | 是否单行滚动。 | -| `className` | `string` | 否 | 自定义类名。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `value` | `boolean` | 否 | `true` | 是否启用滚动。 | +| `list` | `unknown[]` | 是 | `[]` | 滚动数据列表。 | +| `step` | `number` | 否 | `1` | 滚动步长。 | +| `limitScrollNum` | `number` | 否 | `3` | 触发滚动的最小数据条数。 | +| `hover` | `boolean` | 否 | `true` | 鼠标悬浮时是否暂停。 | +| `direction` | `"up" \| "down" \| "left" \| "right"` | 否 | `"up"` | 滚动方向。 | +| `singleHeight` | `number` | 否 | `0` | 单条高度;大于 0 时按单条高度做停顿。 | +| `singleWidth` | `number` | 否 | `0` | 单条宽度;横向滚动时可用于单步停顿。 | +| `singleWaitTime` | `number` | 否 | `1000` | 单步滚动等待时间。 | +| `isRemUnit` | `boolean` | 否 | `false` | 尺寸是否使用 rem 单位。 | +| `isWatch` | `boolean` | 否 | `true` | 是否监听数据变化并重置滚动。 | +| `delay` | `number` | 否 | `0` | 动画延迟。 | +| `ease` | `string \| { x1: number; y1: number; x2: number; y2: number }` | 否 | `"ease-in"` | 动画缓动函数。 | +| `count` | `number` | 否 | `-1` | 滚动次数;`-1` 表示不限制次数。 | +| `copyNum` | `number` | 否 | `1` | 复制列表份数。 | +| `wheel` | `boolean` | 否 | `false` | 是否支持滚轮。 | +| `singleLine` | `boolean` | 否 | `false` | 是否单行滚动。 | +| `className` | `string` | 否 | - | 自定义类名。 | ### SelectCreate @@ -664,12 +683,13 @@ import SelectCreate from "zy-react-library/components/SelectCreate"; 可创建/删除选项的选择器,继承 `antd SelectProps`。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `items` | `SelectCreateOption[]` | 是 | 选项列表。 | -| `showDelete` | `boolean` | 否 | 是否显示删除选项能力。 | -| `label` | `string` | 否 | 创建项标签文案。 | -| `onDelete` | `(option: SelectCreateOption) => void` | 否 | 删除选项回调。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `items` | `SelectCreateOption[]` | 是 | - | 选项列表。 | +| `showDelete` | `boolean` | 否 | `true` | 是否显示删除选项能力。 | +| `label` | `string` | 否 | `""` | 创建项标签文案,会拼到默认 placeholder 中。 | +| `maxCount` | `number` | 否 | `1` | 最大选择数量,继承自 antd Select。 | +| `onDelete` | `(option: SelectCreateOption) => void` | 否 | - | 删除选项回调。 | `SelectCreateOption`: @@ -688,14 +708,14 @@ import HiddenInfo from "zy-react-library/components/HiddenInfo/gwj"; 隐患信息展示组件。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `id` | `string` | 否 | 业务 ID。 | -| `idKey` | `string` | 否 | 业务 ID 字段名。 | -| `hiddenId` | `string` | 否 | 隐患 ID。 | -| `hiddenIdKey` | `string` | 否 | 隐患 ID 字段名。 | -| `history` | `boolean` | 否 | 是否展示历史相关内容。 | -| `onGetData` | `(data: Record) => void` | 否 | 获取详情数据后的回调。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `id` | `string` | 否 | `""` | 业务 ID。 | +| `idKey` | `string` | 否 | `"id"` | URL 查询参数中的业务 ID 字段名。 | +| `hiddenId` | `string` | 否 | `""` | 隐患 ID。 | +| `hiddenIdKey` | `string` | 否 | `"hiddenId"` | URL 查询参数中的隐患 ID 字段名。 | +| `history` | `boolean` | 否 | `false` | 是否请求历史详情接口。 | +| `onGetData` | `(data: Record) => void` | 否 | - | 获取详情数据后的回调。 | ## Select 选择器 @@ -709,16 +729,16 @@ import BasicSelect from "zy-react-library/components/Select/Basic"; 基础选择器,继承 `antd SelectProps`。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `data` | `Record[]` | 是 | 选项数据。 | -| `nameKey` | `string` | 否 | 标签字段名。 | -| `idKey` | `string` | 否 | 值字段名。 | -| `placeholder` | `string` | 否 | 占位文案。 | -| `onGetLabel` | `(label: string \| string[]) => void` | 否 | 选择后返回标签。 | -| `onGetOption` | `(option: Record \| Record[]) => void` | 否 | 选择后返回选项对象。 | -| `onGetData` | `(data: Record[]) => void` | 否 | 返回处理后的选项数据。 | -| `labelRender` | `(item: Record) => ReactNode` | 否 | 自定义选项标签渲染。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `data` | `Record[]` | 是 | `[]` | 选项数据。 | +| `nameKey` | `string` | 否 | `"name"` | 标签字段名。 | +| `idKey` | `string` | 否 | `"id"` | 值字段名。 | +| `placeholder` | `string` | 否 | `""` | 占位文案,最终显示为 `请选择${placeholder}`。 | +| `onGetLabel` | `(label: string \| string[]) => void` | 否 | - | 选择后返回标签。 | +| `onGetOption` | `(option: Record \| Record[]) => void` | 否 | - | 选择后返回选项对象。 | +| `onGetData` | `(data: Record[]) => void` | 否 | - | 返回处理后的选项数据。 | +| `labelRender` | `(item: Record) => ReactNode` | 否 | - | 自定义选项标签渲染。 | ### DictionarySelect @@ -730,14 +750,14 @@ import DictionarySelect from "zy-react-library/components/Select/Dictionary"; 字典选择器,继承 `BasicSelectProps`,但内部接管 `data`、默认字段和部分回调。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `appKey` | `string` | 否 | 字典应用 key。 | -| `dictValue` | `string` | 是 | 字典类型值。 | -| `nameKey` | `string` | 否 | 标签字段名。 | -| `idKey` | `string` | 否 | 值字段名。 | -| `onGetOption` | `(option: DictionarySelectItem \| DictionarySelectItem[]) => void` | 否 | 选择后返回字典项。 | -| `onGetData` | `(data: DictionarySelectItem[]) => void` | 否 | 返回字典数据。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `appKey` | `string` | 否 | `DICTIONARY_APP_KEY_ENUM.DEFAULT` | 字典应用 key。 | +| `dictValue` | `string` | 是 | `""` | 字典类型值;为空会输出缺少参数错误。 | +| `nameKey` | `string` | 否 | `"dictLabel"` | 标签字段名。 | +| `idKey` | `string` | 否 | `"dictValue"` | 值字段名。 | +| `onGetOption` | `(option: DictionarySelectItem \| DictionarySelectItem[]) => void` | 否 | - | 选择后返回字典项。 | +| `onGetData` | `(data: DictionarySelectItem[]) => void` | 否 | - | 返回字典数据。 | `DictionarySelectItem`: @@ -756,16 +776,16 @@ import PersonnelSelect from "zy-react-library/components/Select/Personnel/Gwj"; 人员选择器,继承 `BasicSelectProps`,内部接管人员数据源和默认字段。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `params` | `Params` | 否 | 人员查询基础参数。 | -| `placeholder` | `string` | 否 | 占位文案。 | -| `isNeedCorpInfoId` | `boolean` | 否 | 是否需要企业 ID。 | -| `isNeedPostId` | `boolean` | 否 | 是否需要岗位 ID。 | -| `isNeedDepartmentId` | `boolean` | 否 | 是否需要部门 ID。 | -| `extraParams` | `ExtraParams` | 否 | 人员查询额外参数。 | -| `onGetOption` | `(option: PersonnelSelectItem \| PersonnelSelectItem[]) => void` | 否 | 选择后返回人员项。 | -| `onGetData` | `(data: PersonnelSelectItem[]) => void` | 否 | 返回人员数据。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `params` | `Params` | 否 | `{}` | 人员查询基础参数。 | +| `placeholder` | `string` | 否 | `"人员"` | 占位文案,最终显示为 `请选择人员`。 | +| `isNeedCorpInfoId` | `boolean` | 否 | `false` | 是否需要企业 ID。 | +| `isNeedPostId` | `boolean` | 否 | `false` | 是否需要岗位 ID。 | +| `isNeedDepartmentId` | `boolean` | 否 | `true` | 是否需要部门 ID。 | +| `extraParams` | `ExtraParams` | 否 | `{}`,内部再合并 `{ noMain: "", eqEmploymentFlag: 1 }` | 人员查询额外参数。 | +| `onGetOption` | `(option: PersonnelSelectItem \| PersonnelSelectItem[]) => void` | 否 | - | 选择后返回人员项。 | +| `onGetData` | `(data: PersonnelSelectItem[]) => void` | 否 | - | 返回人员数据。 | `Params`: @@ -811,18 +831,18 @@ import BasicSelectTree from "zy-react-library/components/SelectTree/Basic"; 基础树选择器,继承 `Omit`。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `nameKey` | `string` | 否 | 节点标签字段名。 | -| `idKey` | `string` | 否 | 节点值字段名。 | -| `childrenKey` | `string` | 否 | 子节点字段名。 | -| `getNodePathsIsIncludeOneself` | `boolean` | 否 | 获取节点路径时是否包含当前节点。 | -| `onGetNodePaths` | `(nodes: Record[]) => void` | 否 | 返回当前节点路径。 | -| `placeholder` | `string` | 否 | 占位文案。 | -| `level` | `number` | 否 | 限制展示层级。 | -| `onGetLabel` | `(label: string \| string[]) => void` | 否 | 返回选中标签。 | -| `onGetData` | `(data, processedData) => void` | 否 | 返回原始数据和处理后的数据。 | -| `onlyLastLevel` | `boolean` | 否 | 是否只允许选择最后一级。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `nameKey` | `string` | 否 | `"name"` | 节点标签字段名。 | +| `idKey` | `string` | 否 | `"id"` | 节点值字段名。 | +| `childrenKey` | `string` | 否 | `"children"` | 子节点字段名。 | +| `getNodePathsIsIncludeOneself` | `boolean` | 否 | `true` | 获取节点路径时是否包含当前节点。 | +| `onGetNodePaths` | `(nodes: Record[]) => void` | 否 | - | 返回当前节点路径。 | +| `placeholder` | `string` | 否 | `""` | 占位文案,最终显示为 `请选择${placeholder}`。 | +| `level` | `number` | 否 | - | 限制展示层级。 | +| `onGetLabel` | `(label: string \| string[]) => void` | 否 | - | 返回选中标签。 | +| `onGetData` | `(data, processedData) => void` | 否 | - | 返回原始数据和处理后的数据。 | +| `onlyLastLevel` | `boolean` | 否 | `false` | 是否只允许选择最后一级。 | ### AreaSelectTree @@ -834,10 +854,10 @@ import AreaSelectTree from "zy-react-library/components/SelectTree/Area"; 地区树选择器,继承 `BasicSelectTree` 能力,内部接管地区数据、默认字段和占位文案。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `onGetNodePaths` | `(nodes: AreaSelectTreeItem[]) => void` | 否 | 返回地区节点路径。 | -| `onGetData` | `(data: AreaSelectTreeItem[], processedData: AreaSelectTreeItem[]) => void` | 否 | 返回原始地区数据和处理后的地区数据。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `onGetNodePaths` | `(nodes: AreaSelectTreeItem[]) => void` | 否 | - | 返回地区节点路径。 | +| `onGetData` | `(data: AreaSelectTreeItem[], processedData: AreaSelectTreeItem[]) => void` | 否 | - | 返回原始地区数据和处理后的地区数据。 | `AreaSelectTreeItem`:`value: string`、`label: string`、`children: AreaSelectTreeItem[]`。 @@ -851,10 +871,10 @@ import IndustrySelectTree from "zy-react-library/components/SelectTree/Industry" 行业树选择器。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `onGetNodePaths` | `(nodes: IndustrySelectTreeItem[]) => void` | 否 | 返回行业节点路径。 | -| `onGetData` | `(data: IndustrySelectTreeItem[], processedData: IndustrySelectTreeItem[]) => void` | 否 | 返回原始行业数据和处理后的行业数据。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `onGetNodePaths` | `(nodes: IndustrySelectTreeItem[]) => void` | 否 | - | 返回行业节点路径。 | +| `onGetData` | `(data: IndustrySelectTreeItem[], processedData: IndustrySelectTreeItem[]) => void` | 否 | - | 返回原始行业数据和处理后的行业数据。 | `IndustrySelectTreeItem`:`dict_value: string`、`dict_label: string`、`childrenList: IndustrySelectTreeItem[]`。 @@ -868,10 +888,10 @@ import DictionarySelectTree from "zy-react-library/components/SelectTree/Diction 字典树选择器。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `appKey` | `string` | 否 | 字典应用 key。 | -| `dictValue` | `string` | 是 | 字典类型值。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `appKey` | `string` | 否 | `DICTIONARY_APP_KEY_ENUM.DEFAULT` | 字典应用 key。 | +| `dictValue` | `string` | 是 | - | 字典类型值。 | | `nameKey` | `string` | 否 | 节点标签字段名。 | | `idKey` | `string` | 否 | 节点值字段名。 | | `onGetNodePaths` | `(nodes: DictionarySelectTreeItem[]) => void` | 否 | 返回字典节点路径。 | @@ -889,15 +909,15 @@ import DepartmentSelectTree from "zy-react-library/components/SelectTree/Departm 部门树选择器。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `params` | `Params` | 否 | 部门查询参数。 | -| `placeholder` | `string` | 否 | 占位文案。 | -| `isNeedCorpInfoId` | `boolean` | 否 | 是否需要企业 ID。 | -| `isNeedParentId` | `boolean` | 否 | 是否需要父级 ID。 | -| `searchType` | `"current" \| "all" \| "inType"` | 否 | 查询范围类型。 | -| `onGetNodePaths` | `(nodes: DepartmentSelectTreeItem[]) => void` | 否 | 返回部门节点路径。 | -| `onGetData` | `(data: DepartmentSelectTreeItem[], processedData: DepartmentSelectTreeItem[]) => void` | 否 | 返回原始部门数据和处理后的部门数据。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `params` | `Params` | 否 | `{}` | 部门查询参数。 | +| `placeholder` | `string` | 否 | `"部门"` | 占位文案。 | +| `isNeedCorpInfoId` | `boolean` | 否 | `false` | 是否需要企业 ID。 | +| `isNeedParentId` | `boolean` | 否 | `false` | 是否需要父级 ID。 | +| `searchType` | `"current" \| "all" \| "inType"` | 否 | `"current"` | 查询范围类型。 | +| `onGetNodePaths` | `(nodes: DepartmentSelectTreeItem[]) => void` | 否 | - | 返回部门节点路径。 | +| `onGetData` | `(data: DepartmentSelectTreeItem[], processedData: DepartmentSelectTreeItem[]) => void` | 否 | - | 返回原始部门数据和处理后的部门数据。 | `Params`: @@ -920,13 +940,13 @@ import HiddenLevelSelectTree from "zy-react-library/components/SelectTree/Hidden 隐患等级树选择器。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `isShowNeglect` | `boolean` | 否 | 是否显示可忽略等级。 | -| `isShowLarger` | `boolean` | 否 | 是否显示较大等级。 | -| `isShowMajor` | `boolean` | 否 | 是否显示重大等级。 | -| `onGetNodePaths` | `(nodes: HiddenLevelSelectTreeItem[]) => void` | 否 | 返回隐患等级节点路径。 | -| `onGetData` | `(data: HiddenLevelSelectTreeItem[], processedData: HiddenLevelSelectTreeItem[]) => void` | 否 | 返回原始数据和处理后的数据。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `isShowNeglect` | `boolean` | 否 | `true` | 是否显示可忽略等级。 | +| `isShowLarger` | `boolean` | 否 | `true` | 是否显示较大等级。 | +| `isShowMajor` | `boolean` | 否 | `true` | 是否显示重大等级。 | +| `onGetNodePaths` | `(nodes: HiddenLevelSelectTreeItem[]) => void` | 否 | - | 返回隐患等级节点路径。 | +| `onGetData` | `(data: HiddenLevelSelectTreeItem[], processedData: HiddenLevelSelectTreeItem[]) => void` | 否 | - | 返回原始数据和处理后的数据。 | `HiddenLevelSelectTreeItem`:`dictValue: string`、`dictLabel: string`、`children: HiddenLevelSelectTreeItem[]`。 @@ -940,12 +960,12 @@ import HiddenPartSelectTree from "zy-react-library/components/SelectTree/HiddenP 隐患部位树选择器。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `params` | `{ eqCorpinfoId?: string }` | 否 | 查询参数。 | -| `isNeedCorpInfoId` | `boolean` | 否 | 是否需要企业 ID。 | -| `onGetNodePaths` | `(nodes: HiddenPartSelectTreeItem[]) => void` | 否 | 返回隐患部位节点路径。 | -| `onGetData` | `(data: HiddenPartSelectTreeItem[], processedData: HiddenPartSelectTreeItem[]) => void` | 否 | 返回原始数据和处理后的数据。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `params` | `{ eqCorpinfoId?: string }` | 否 | `{}` | 查询参数。 | +| `isNeedCorpInfoId` | `boolean` | 否 | `false` | 是否需要企业 ID。 | +| `onGetNodePaths` | `(nodes: HiddenPartSelectTreeItem[]) => void` | 否 | - | 返回隐患部位节点路径。 | +| `onGetData` | `(data: HiddenPartSelectTreeItem[], processedData: HiddenPartSelectTreeItem[]) => void` | 否 | - | 返回原始数据和处理后的数据。 | `HiddenPartSelectTreeItem`:`hiddenregionId: string`、`hiddenregion: string`、`children: HiddenPartSelectTreeItem[]`。 @@ -961,16 +981,16 @@ import BasicCascader from "zy-react-library/components/Cascader/Basic"; 基础级联选择器,继承 `Omit`。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `nameKey` | `string` | 否 | 节点标签字段名。 | -| `idKey` | `string` | 否 | 节点值字段名。 | -| `childrenKey` | `string` | 否 | 子节点字段名。 | -| `getNodePathsIsIncludeOneself` | `boolean` | 否 | 获取节点路径时是否包含当前节点。 | -| `onGetNodePaths` | `(nodes: Record[]) => void` | 否 | 返回当前节点路径。 | -| `placeholder` | `string` | 否 | 占位文案。 | -| `level` | `number` | 否 | 限制展示层级。 | -| `onGetData` | `(data, processedData) => void` | 否 | 返回原始数据和处理后的数据。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `nameKey` | `string` | 否 | `"name"` | 节点标签字段名。 | +| `idKey` | `string` | 否 | `"id"` | 节点值字段名。 | +| `childrenKey` | `string` | 否 | `"children"` | 子节点字段名。 | +| `getNodePathsIsIncludeOneself` | `boolean` | 否 | `true` | 获取节点路径时是否包含当前节点。 | +| `onGetNodePaths` | `(nodes: Record[]) => void` | 否 | - | 返回当前节点路径。 | +| `placeholder` | `string` | 否 | `""` | 占位文案,最终显示为 `请选择${placeholder}`。 | +| `level` | `number` | 否 | - | 限制展示层级。 | +| `onGetData` | `(data, processedData) => void` | 否 | - | 返回原始数据和处理后的数据。 | ### AreaCascader @@ -982,10 +1002,10 @@ import AreaCascader from "zy-react-library/components/Cascader/Area"; 地区级联选择器。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `onGetNodePaths` | `(nodes: AreaCascaderItem[]) => void` | 否 | 返回地区节点路径。 | -| `onGetData` | `(data: AreaCascaderItem[], processedData: AreaCascaderItem[]) => void` | 否 | 返回原始地区数据和处理后的地区数据。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `onGetNodePaths` | `(nodes: AreaCascaderItem[]) => void` | 否 | - | 返回地区节点路径。 | +| `onGetData` | `(data: AreaCascaderItem[], processedData: AreaCascaderItem[]) => void` | 否 | - | 返回原始地区数据和处理后的地区数据。 | `AreaCascaderItem`:`value: string`、`label: string`、`children: AreaCascaderItem[]`。 @@ -999,10 +1019,10 @@ import IndustryCascader from "zy-react-library/components/Cascader/Industry"; 行业级联选择器。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `onGetNodePaths` | `(nodes: IndustryCascaderItem[]) => void` | 否 | 返回行业节点路径。 | -| `onGetData` | `(data: IndustryCascaderItem[], processedData: IndustryCascaderItem[]) => void` | 否 | 返回原始行业数据和处理后的行业数据。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `onGetNodePaths` | `(nodes: IndustryCascaderItem[]) => void` | 否 | - | 返回行业节点路径。 | +| `onGetData` | `(data: IndustryCascaderItem[], processedData: IndustryCascaderItem[]) => void` | 否 | - | 返回原始行业数据和处理后的行业数据。 | `IndustryCascaderItem`:`dict_value: string`、`dict_label: string`、`childrenList: IndustryCascaderItem[]`。 @@ -1016,10 +1036,10 @@ import DictionaryCascader from "zy-react-library/components/Cascader/Dictionary" 字典级联选择器。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `appKey` | `string` | 否 | 字典应用 key。 | -| `dictValue` | `string` | 是 | 字典类型值。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `appKey` | `string` | 否 | `DICTIONARY_APP_KEY_ENUM.DEFAULT` | 字典应用 key。 | +| `dictValue` | `string` | 是 | - | 字典类型值。 | | `nameKey` | `string` | 否 | 节点标签字段名。 | | `idKey` | `string` | 否 | 节点值字段名。 | | `onGetNodePaths` | `(nodes: DictionaryCascaderItem[]) => void` | 否 | 返回字典节点路径。 | @@ -1039,14 +1059,14 @@ import BasicLeftTree from "zy-react-library/components/LeftTree/Basic"; 基础树组件,继承 `Omit`。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `nameKey` | `string` | 否 | 节点标题字段名。 | -| `idKey` | `string` | 否 | 节点 key 字段名。 | -| `childrenKey` | `string` | 否 | 子节点字段名。 | -| `getNodePathsIsIncludeOneself` | `boolean` | 否 | 获取节点路径时是否包含当前节点。 | -| `onGetNodePaths` | `(nodes: Record[]) => void` | 否 | 返回当前节点路径。 | -| `onGetData` | `(data: Record[]) => void` | 否 | 返回树数据。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `nameKey` | `string` | 否 | `"name"` | 节点标题字段名。 | +| `idKey` | `string` | 否 | `"id"` | 节点 key 字段名。 | +| `childrenKey` | `string` | 否 | `"children"` | 子节点字段名。 | +| `getNodePathsIsIncludeOneself` | `boolean` | 否 | `true` | 获取节点路径时是否包含当前节点。 | +| `onGetNodePaths` | `(nodes: Record[]) => void` | 否 | - | 返回当前节点路径。 | +| `onGetData` | `(data: Record[]) => void` | 否 | - | 返回树数据。 | ### AreaLeftTree @@ -1058,10 +1078,10 @@ import AreaLeftTree from "zy-react-library/components/LeftTree/Area"; 地区左侧树。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `onGetNodePaths` | `(nodes: AreaLeftTreeItem[]) => void` | 否 | 返回地区节点路径。 | -| `onGetData` | `(data: AreaLeftTreeItem[], processedData: AreaLeftTreeItem[]) => void` | 否 | 返回原始地区数据和处理后的地区数据。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `onGetNodePaths` | `(nodes: AreaLeftTreeItem[]) => void` | 否 | - | 返回地区节点路径。 | +| `onGetData` | `(data: AreaLeftTreeItem[], processedData: AreaLeftTreeItem[]) => void` | 否 | - | 返回原始地区数据和处理后的地区数据。 | `AreaLeftTreeItem`:`value: string`、`label: string`、`children: AreaLeftTreeItem[]`。 @@ -1075,14 +1095,14 @@ import DictionaryLeftTree from "zy-react-library/components/LeftTree/Dictionary" 字典左侧树。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `appKey` | `string` | 否 | 字典应用 key。 | -| `dictValue` | `string` | 是 | 字典类型值。 | -| `nameKey` | `string` | 否 | 节点标题字段名。 | -| `idKey` | `string` | 否 | 节点 key 字段名。 | -| `onGetNodePaths` | `(nodes: DictionaryLeftTreeItem[]) => void` | 否 | 返回字典节点路径。 | -| `onGetData` | `(data: DictionaryLeftTreeItem[], processedData: DictionaryLeftTreeItem[]) => void` | 否 | 返回原始字典数据和处理后的字典数据。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `appKey` | `string` | 否 | `DICTIONARY_APP_KEY_ENUM.DEFAULT` | 字典应用 key。 | +| `dictValue` | `string` | 是 | `""` | 字典类型值;为空会输出缺少参数错误。 | +| `nameKey` | `string` | 否 | `"dictLabel"` | 节点标题字段名。 | +| `idKey` | `string` | 否 | `"dictValue"` | 节点 key 字段名。 | +| `onGetNodePaths` | `(nodes: DictionaryLeftTreeItem[]) => void` | 否 | - | 返回字典节点路径。 | +| `onGetData` | `(data: DictionaryLeftTreeItem[], processedData: DictionaryLeftTreeItem[]) => void` | 否 | - | 返回原始字典数据和处理后的字典数据。 | `DictionaryLeftTreeItem`:`dictValue: string`、`dictLabel: string`、`children: DictionaryLeftTreeItem[]`。 @@ -1096,12 +1116,12 @@ import DepartmentLeftTree from "zy-react-library/components/LeftTree/Department/ 部门左侧树。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `params` | `DepartmentSelectTreeProps["params"]` | 否 | 部门查询参数。 | -| `searchType` | `DepartmentSelectTreeProps["searchType"]` | 否 | 查询范围类型。 | -| `onGetNodePaths` | `(nodes: DepartmentLeftTreeItem[]) => void` | 否 | 返回部门节点路径。 | -| `onGetData` | `(data: DepartmentLeftTreeItem[], processedData: DepartmentLeftTreeItem[]) => void` | 否 | 返回原始部门数据和处理后的部门数据。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `params` | `DepartmentSelectTreeProps["params"]` | 否 | `{}` | 部门查询参数。 | +| `searchType` | `DepartmentSelectTreeProps["searchType"]` | 否 | `"current"` | 查询范围类型。 | +| `onGetNodePaths` | `(nodes: DepartmentLeftTreeItem[]) => void` | 否 | - | 返回部门节点路径。 | +| `onGetData` | `(data: DepartmentLeftTreeItem[], processedData: DepartmentLeftTreeItem[]) => void` | 否 | - | 返回原始部门数据和处理后的部门数据。 | `DepartmentLeftTreeItem`:`id: string`、`name: string`、`childrenList: DepartmentLeftTreeItem[]`。 @@ -1127,6 +1147,23 @@ import DepartmentLeftTree from "zy-react-library/components/LeftTree/Department/ ## Hooks +### Hook 默认值速查 + +| Hook | 默认值 | +| --- | --- | +| `useTable` | `usePagination=true`、`useStorageQueryCriteria=true`、`usePermission=true`、`defaultType="advance"`、`defaultPagination={ current: 1, pageSize: 20 }`。 | +| `useUploadFile` | `returnType="object"`;执行上传时 `files=[]`、`single=true`。 | +| `useGetFile` | `returnType="object"`;执行获取时 `single=true`。 | +| `useDeleteFile` | `returnType="object"`;执行删除时 `files=[]`、`single=true`。 | +| `useImportFile` | `returnType="object"`;执行导入时 `options.files=[]`、`options.params={}`。 | +| `useDownloadBlob` | `returnType="object"`;执行下载时 `options.name=""`、`options.type=""`、`options.params={}`,未传 `type` 时使用 `application/vnd.ms-excel`,未传 `name` 时使用当前时间 `YYYY-MM-DD HH:mm:ss`。 | +| `useDownloadFile` | `returnType="object"`;未传 `name` 时从 `url` 中截取文件名。 | +| `useDictionary` | `returnType="object"`;执行获取时 `appKey=DICTIONARY_APP_KEY_ENUM.DEFAULT`。 | +| `useGetUserInfo` | `returnType="object"`。 | +| `useIdle` | `timeout=10000`、`events=["mousemove","mousedown","resize","keydown","touchstart","wheel"]`。 | +| `useIsExistenceDuplicateSelection` | `message="存在重复项,请勿重复选择"`。 | +| `useUrlQueryCriteria` | URL 状态初始值 `{ searchFormKeys: "", searchFormValues: "", paginationKeys: "", paginationValues: "" }`,`navigateMode="replace"`。 | + ### useTable 引入: @@ -1194,21 +1231,21 @@ useUploadFile("object"): { loading: boolean; uploadFile: UploadFileFunction } 单文件上传参数: -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `files` | `UploadFile[]` | 是 | 待上传文件。 | -| `single` | `true` | 否 | 单文件上传标识。 | -| `params` | `SingleParams` | 是 | 上传参数。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `files` | `UploadFile[]` | 是 | `[]` | 待上传文件;为空时直接返回空文件结果。 | +| `single` | `true` | 否 | `true` | 单文件上传标识。 | +| `params` | `SingleParams` | 是 | - | 上传参数。 | `SingleParams`:`type: number`、`corpinfoId?: string`、`foreignKey?: string`。 多文件上传参数: -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `files` | `UploadFile[]` | 是 | 待上传文件。 | -| `single` | `false` | 是 | 多文件上传标识。 | -| `params` | `MultipleParams` | 是 | 上传参数。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `files` | `UploadFile[]` | 是 | `[]` | 待上传文件;为空时直接返回原 `foreignKey`。 | +| `single` | `false` | 是 | - | 多文件上传标识。 | +| `params` | `MultipleParams` | 是 | - | 上传参数。 | `MultipleParams`:`type: number`、`corpinfoId?: string`、`foreignKey: string`。 @@ -1231,20 +1268,20 @@ useGetFile("object"): { loading: boolean; getFile: GetFileFunction } 单文件获取参数: -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `eqType` | `number` | 是 | 文件类型。 | -| `eqForeignKey` | `string` | 是 | 外键 ID。 | -| `single` | `true` | 否 | 单文件获取标识。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `eqType` | `number` | 是 | - | 文件类型。 | +| `eqForeignKey` | `string` | 是 | - | 外键 ID。 | +| `single` | `true` | 否 | `true` | 单文件获取标识。 | 多文件获取参数: -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `eqType` | `number` | 是 | 文件类型。 | -| `foreignKey` | `string` | 是 | `dataSource` 中外键 ID 的字段名。 | -| `single` | `false` | 是 | 多文件获取标识。 | -| `dataSource` | `Record[]` | 是 | 原始数据源。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `eqType` | `number` | 是 | - | 文件类型。 | +| `foreignKey` | `string` | 是 | - | `dataSource` 中外键 ID 的字段名。 | +| `single` | `false` | 是 | - | 多文件获取标识。 | +| `dataSource` | `Record[]` | 是 | - | 原始数据源;空数组时直接返回空数组。 | `GetFileItem`: @@ -1272,10 +1309,10 @@ useDeleteFile("array"): [boolean, DeleteFileFunction] useDeleteFile("object"): { loading: boolean; deleteFile: DeleteFileFunction } ``` -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `files` | `DeleteFileItem[]` | 是 | 待删除文件。 | -| `single` | `boolean` | 否 | 是否按单文件删除。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `files` | `DeleteFileItem[]` | 是 | `[]` | 待删除文件;为空时直接结束。 | +| `single` | `boolean` | 否 | `true` | 是否按单文件删除。 | `DeleteFileItem`:`filePath?: string`、`id?: string`。 @@ -1296,11 +1333,11 @@ useImportFile("object"): { loading: boolean; importFile: ImportFileFunction } `importFile(url, options)` 参数: -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `url` | `string` | 是 | 导入接口地址。 | -| `options.files` | `UploadFile[]` | 是 | 上传文件数组。 | -| `options.params` | `Record` | 否 | 额外提交参数。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `url` | `string` | 是 | - | 导入接口地址。 | +| `options.files` | `UploadFile[]` | 是 | `[]` | 上传文件数组。 | +| `options.params` | `Record` | 否 | `{}` | 额外提交参数。 | `UploadFile`:`originFileObj?: File`,并支持业务扩展字段。 @@ -1319,10 +1356,10 @@ useDownloadFile("array"): [boolean, DownloadFileFunction] useDownloadFile("object"): { loading: boolean; downloadFile: DownloadFileFunction } ``` -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `url` | `string` | 是 | 下载地址。 | -| `name` | `string` | 否 | 下载文件名。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `url` | `string` | 是 | - | 下载地址。 | +| `name` | `string` | 否 | 从 `url` 截取文件名 | 下载文件名;传入无后缀文件名时会尝试使用 `url` 后缀补齐。 | ### useDownloadBlob @@ -1341,12 +1378,12 @@ useDownloadBlob("object"): { loading: boolean; downloadBlob: DownloadBlobFunctio `downloadBlob(url, options?)` 参数: -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `url` | `string` | 是 | 下载接口地址。 | -| `options.name` | `string` | 否 | 自定义文件名,不含后缀。 | -| `options.type` | `string` | 否 | Blob MIME 类型。 | -| `options.params` | `Record` | 否 | 请求查询参数。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `url` | `string` | 是 | - | 下载接口地址。 | +| `options.name` | `string` | 否 | 当前时间 `YYYY-MM-DD HH:mm:ss` | 自定义文件名,不含后缀。 | +| `options.type` | `string` | 否 | `"application/vnd.ms-excel"` | Blob MIME 类型。 | +| `options.params` | `Record` | 否 | `{}` | 请求查询参数。 | 返回:`Promise<{ data: Blob }>`。 @@ -1367,10 +1404,10 @@ useDictionary("object"): { loading: boolean; getDictionary: getDictionaryFunctio `getDictionary(options)` 参数: -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `appKey` | `string` | 否 | 字典应用 key。 | -| `dictValue` | `string` | 是 | 字典类型值。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `appKey` | `string` | 否 | `DICTIONARY_APP_KEY_ENUM.DEFAULT` | 字典应用 key。 | +| `dictValue` | `string` | 是 | - | 字典类型值。 | 返回 `Promise`。 @@ -1451,10 +1488,10 @@ import useIdle from "zy-react-library/hooks/useIdle"; 检测用户是否空闲。 -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `timeout` | `number` | 否 | 空闲超时时间。 | -| `events` | `string[]` | 否 | 用于判断活跃状态的事件名列表。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `timeout` | `number` | 否 | `10000` | 空闲超时时间,单位毫秒。 | +| `events` | `string[]` | 否 | `["mousemove","mousedown","resize","keydown","touchstart","wheel"]` | 用于判断活跃状态的事件名列表。 | 返回:`boolean`,表示是否处于空闲状态。 @@ -1470,11 +1507,11 @@ import useIsExistenceDuplicateSelection from "zy-react-library/hooks/useIsExiste `isExistenceDuplicateSelection(options)` 参数: -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | --- | --- | -| `data` | `T[]` | 是 | 需要检查重复项的目标数组。 | -| `key` | `keyof T \| string` | 是 | 用于判断重复的对象属性名。 | -| `message` | `string` | 否 | 存在重复项时的错误提示。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| --- | --- | --- | --- | --- | +| `data` | `T[]` | 是 | - | 需要检查重复项的目标数组。 | +| `key` | `keyof T \| string` | 是 | - | 用于判断重复的对象属性名。 | +| `message` | `string` | 否 | `"存在重复项,请勿重复选择"` | 存在重复项时的错误提示。 | 返回:`Promise`。