zy-react-library 2.2.0 → 2.2.1

package/README.md

@@ -37,7 +37,7 @@ import { FORM_ITEM_RENDER_ENUM } from "zy-react-library/enum/formItemRender";
 
 - 本文档根据当前包内 `.d.ts` 类型声明整理。
 - 继承自 `antd`、`@ant-design/pro-components`、`ahooks` 的原生属性不逐项展开，文档会说明继承关系；库自身新增的参数逐项列出。
-- `css` 仅做简要说明。
+- `css` 仅做简要说明。
 - 参数表中的 `-` 表示源码未设置显式默认值；`undefined` 表示源码显式传入或保留为 `undefined`。
 
 ## 基础样式
@@ -50,7 +50,7 @@ import "zy-react-library/css/common.less";
 
 `common.less` 提供组件库通用样式，适合在应用入口统一引入。
 
-## 枚举
+## 枚举
 
 ### FORM_ITEM_RENDER_ENUM
 
@@ -80,7 +80,7 @@ import { FORM_ITEM_RENDER_ENUM } from "zy-react-library/enum/formItemRender";
 | `DATETIME` | `"datetime"` | `antd DatePicker` 日期时间 | `DatePickerProps` |
 | `DATETIME_RANGE` | `"datetimeRange"` | `antd DatePicker.RangePicker` 日期时间范围 | `RangePickerProps` |
 | `DIVIDER` | `"divider"` | `antd Divider` | `DividerProps` |
-| `FORM_LIST` | `"formList"` | `antd Form.List` | `FormListProps` |
+| `FORM_LIST` | `"formList"` | `antd Form.List` | `FormListProps` |
 
 ## 表单配置类型
 
@@ -213,22 +213,22 @@ import { FORM_ITEM_RENDER_ENUM } from "zy-react-library/enum/formItemRender";
 | `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="0bb989ecada5470c87635018ece9f327"`、`dictValue=""`、`nameKey="dictLabel"`、`idKey="dictValue"`。 |
+| `DictionarySelect` | `appKey="0bb989ecada5470c87635018ece9f327"`、`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="0bb989ecada5470c87635018ece9f327"`、`dictValue=""`、`nameKey="dictLabel"`、`idKey="dictValue"`。 |
+| `DictionarySelectTree` | `appKey="0bb989ecada5470c87635018ece9f327"`、`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="0bb989ecada5470c87635018ece9f327"`、`dictValue=""`、`nameKey="dictLabel"`、`idKey="dictValue"`。 |
+| `DictionaryCascader` | `appKey="0bb989ecada5470c87635018ece9f327"`、`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="0bb989ecada5470c87635018ece9f327"`、`dictValue=""`、`nameKey="dictLabel"`、`idKey="dictValue"`。 |
+| `DictionaryLeftTree` | `appKey="0bb989ecada5470c87635018ece9f327"`、`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`。 |
@@ -813,7 +813,7 @@ import DictionarySelect from "zy-react-library/components/Select/Dictionary";
 
 | 参数 | 类型 | 必填 | 默认值 | 说明 |
 | --- | --- | --- | --- | --- |
-| `appKey` | `string` | 否 | `"0bb989ecada5470c87635018ece9f327"` | 字典应用 key。 |
+| `appKey` | `string` | 否 | `"0bb989ecada5470c87635018ece9f327"` | 字典应用 key。 |
 | `dictValue` | `string` | 是 | `""` | 字典类型值；为空会输出缺少参数错误。 |
 | `nameKey` | `string` | 否 | `"dictLabel"` | 标签字段名。 |
 | `idKey` | `string` | 否 | `"dictValue"` | 值字段名。 |
@@ -951,7 +951,7 @@ import DictionarySelectTree from "zy-react-library/components/SelectTree/Diction
 
 | 参数 | 类型 | 必填 | 默认值 | 说明 |
 | --- | --- | --- | --- | --- |
-| `appKey` | `string` | 否 | `"0bb989ecada5470c87635018ece9f327"` | 字典应用 key。 |
+| `appKey` | `string` | 否 | `"0bb989ecada5470c87635018ece9f327"` | 字典应用 key。 |
 | `dictValue` | `string` | 是 | - | 字典类型值。 |
 | `nameKey` | `string` | 否 | 节点标签字段名。 |
 | `idKey` | `string` | 否 | 节点值字段名。 |
@@ -1099,7 +1099,7 @@ import DictionaryCascader from "zy-react-library/components/Cascader/Dictionary"
 
 | 参数 | 类型 | 必填 | 默认值 | 说明 |
 | --- | --- | --- | --- | --- |
-| `appKey` | `string` | 否 | `"0bb989ecada5470c87635018ece9f327"` | 字典应用 key。 |
+| `appKey` | `string` | 否 | `"0bb989ecada5470c87635018ece9f327"` | 字典应用 key。 |
 | `dictValue` | `string` | 是 | - | 字典类型值。 |
 | `nameKey` | `string` | 否 | 节点标签字段名。 |
 | `idKey` | `string` | 否 | 节点值字段名。 |
@@ -1158,7 +1158,7 @@ import DictionaryLeftTree from "zy-react-library/components/LeftTree/Dictionary"
 
 | 参数 | 类型 | 必填 | 默认值 | 说明 |
 | --- | --- | --- | --- | --- |
-| `appKey` | `string` | 否 | `"0bb989ecada5470c87635018ece9f327"` | 字典应用 key。 |
+| `appKey` | `string` | 否 | `"0bb989ecada5470c87635018ece9f327"` | 字典应用 key。 |
 | `dictValue` | `string` | 是 | `""` | 字典类型值；为空会输出缺少参数错误。 |
 | `nameKey` | `string` | 否 | `"dictLabel"` | 节点标题字段名。 |
 | `idKey` | `string` | 否 | `"dictValue"` | 节点 key 字段名。 |
@@ -1219,7 +1219,7 @@ import DepartmentLeftTree from "zy-react-library/components/LeftTree/Department/
 | `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="0bb989ecada5470c87635018ece9f327"`。 |
+| `useDictionary` | `returnType="object"`；执行获取时 `appKey="0bb989ecada5470c87635018ece9f327"`。 |
 | `useGetUserInfo` | `returnType="object"`。 |
 | `useIdle` | `timeout=10000`、`events=["mousemove","mousedown","resize","keydown","touchstart","wheel"]`。 |
 | `useIsExistenceDuplicateSelection` | `message="存在重复项，请勿重复选择"`。 |
@@ -1465,7 +1465,7 @@ useDictionary("object"): { loading: boolean; getDictionary: getDictionaryFunctio
 
 | 参数 | 类型 | 必填 | 默认值 | 说明 |
 | --- | --- | --- | --- | --- |
-| `appKey` | `string` | 否 | `"0bb989ecada5470c87635018ece9f327"` | 字典应用 key。 |
+| `appKey` | `string` | 否 | `"0bb989ecada5470c87635018ece9f327"` | 字典应用 key。 |
 | `dictValue` | `string` | 是 | - | 字典类型值。 |
 
 返回 `Promise<DictionaryItem[]>`。

package/components/FormBuilder/FormItemsRenderer.d.ts

@@ -3,7 +3,7 @@ import type { ColProps } from "antd/es/col";
 import type { FormItemProps, Rule } from "antd/es/form";
 import type { FormListFieldData } from "antd/es/form/FormList";
 import type { Gutter } from "antd/es/grid/row";
-import type { CSSProperties, ReactElement, ReactNode } from "react";
+import type { CSSProperties, Key, ReactElement, ReactNode } from "react";
 import type { FORM_ITEM_RENDER_TYPE_MAP } from "../../enum/formItemRender";
 import type { DeepPartial } from "./FormBuilder";
 
@@ -98,7 +98,7 @@ export interface FormOptionBase<
   Dependencies = NamePath<Values>,
 > {
   /** React 需要的 key，如果传递了唯一的 name，则不需要 */
-  key?: string;
+  key?: Key;
   /** 表单项字段名 */
   name?: Name;
   /** 表单项标签 */

package/components/Table/index.d.ts

@@ -1,11 +1,33 @@
-import type { ProTableProps } from "@ant-design/pro-table";
-import type { TableProps as AntdTableProps } from "antd";
+import type { ProColumns, ProTableProps } from "@ant-design/pro-components";
+import type { TableProps as AntdTableProps, TableColumnType } from "antd";
 import type { FC } from "react";
 
+/** 保留 Ant Design 推导的嵌套元组路径，移除宽泛字符串和普通数组 */
+type StrictTableDataIndex<DataIndex> = DataIndex extends string
+  ? never
+  : DataIndex extends readonly unknown[]
+    ? number extends DataIndex["length"] ? never : DataIndex
+    : DataIndex extends number ? DataIndex : never;
+
+/** 表格字段索引，支持一级字段和嵌套字段路径提示 */
+export type TableDataIndex<DataSource>
+  = | Extract<keyof DataSource, string | number>
+    | StrictTableDataIndex<NonNullable<TableColumnType<DataSource>["dataIndex"]>>;
+
+/** 表格列配置 */
+export type TableColumn<DataSource, ValueType = "text"> = Omit<ProColumns<DataSource, ValueType>, "children" | "dataIndex"> & {
+  /** 当前列对应的数据字段 */
+  dataIndex?: TableDataIndex<DataSource>;
+  /** 多级表头子列 */
+  children?: TableColumn<DataSource, ValueType>[];
+};
+
 /**
- * TablePro 组件属性
+ * Table 组件属性
  */
-export type TableProps<DataSource, U, ValueType> = Omit<AntdTableProps, "columns"> & ProTableProps<DataSource, U, ValueType> & {
+export type TableProps<DataSource, U = Record<string, unknown>, ValueType = "text"> = Omit<AntdTableProps<DataSource>, "columns"> & Omit<ProTableProps<DataSource, U, ValueType>, "columns"> & {
+  /** 表格列配置 */
+  columns: TableColumn<DataSource, ValueType>[];
   /** 当一个路由下存在多个表格的情况下 需要给每一个表格设置一个唯一存储索引 若没有设置则使用默认索引，请注意缓存数据会被覆盖 */
   storeIndex?: string;
   /** 是否禁用内容区滚动，默认 false */
@@ -25,5 +47,5 @@ export type TableProps<DataSource, U, ValueType> = Omit<AntdTableProps, "columns
 /**
  * 表格组件
  */
-declare const Table: <DataSource, U, ValueType = "text">(props: TableProps<DataSource, U, ValueType>) => ReturnType<FC>;
+declare const Table: <DataSource, U = Record<string, unknown>, ValueType = "text">(props: TableProps<DataSource, U, ValueType>) => ReturnType<FC>;
 export default Table;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zy-react-library",
   "private": false,
-  "version": "2.2.0",
+  "version": "2.2.1",
   "type": "module",
   "description": "",
   "author": "LiuJiaNan",