From 56ed9854dfe14da5a00b3d18c361af76b8e7c06e Mon Sep 17 00:00:00 2001 From: tangjinzhou <415800467@qq.com> Date: Sat, 11 Sep 2021 17:02:22 +0800 Subject: [PATCH] doc: update table doc --- components/table/index.zh-CN.md | 117 +++++++++++++++++++++----------- components/table/interface.tsx | 5 +- 2 files changed, 81 insertions(+), 41 deletions(-) diff --git a/components/table/index.zh-CN.md b/components/table/index.zh-CN.md index 1c896c395..a0288baf8 100644 --- a/components/table/index.zh-CN.md +++ b/components/table/index.zh-CN.md @@ -74,36 +74,49 @@ cover: https://gw.alipayobjects.com/zos/alicdn/f-SbcX2Lx/Table.svg | 参数 | 说明 | 类型 | 默认值 | 版本 | | --- | --- | --- | --- | --- | -| tableLayout | 表格元素的 [table-layout](https://developer.mozilla.org/zh-CN/docs/Web/CSS/table-layout) 属性，设为 `fixed` 表示内容不会影响列的布局 | - \| 'auto' \| 'fixed' | 无
固定表头/列或使用了 `column.ellipsis` 时，默认值为 `fixed` | 1.5.0 | | bordered | 是否展示外边框和列边框 | boolean | false | | -| childrenColumnName | 指定树形结构的列名 | string | `children` | | | columns | 表格列的配置描述，具体项见[下表](#Column) | array | - | | | components | 覆盖默认的 table 元素 | object | - | | -| dataSource | 数据数组 | any\[] | | | +| childrenColumnName | 指定树形结构的列名 | string | `children` | | +| dataSource | 数据数组 | object\[] | | | | defaultExpandAllRows | 初始时，是否展开所有行 | boolean | false | | | defaultExpandedRowKeys | 默认展开的行 | string\[] | - | | | expandedRowKeys | 展开的行，控制属性 | string\[] | - | | -| expandedRowRender | 额外的展开行 | Function(record, index, indent, expanded):VNode \| #expandedRowRender="{record, index, indent, expanded}" | - | | -| expandIcon | 自定义展开图标 | Function(props):VNode \| #expandIcon="props" | - | | +| expandedRowRender | 额外的展开行 | Function(record, index, indent, expanded):VNode \| v-slot:expandedRowRender="{record, index, indent, expanded}" | - | | +| expandFixed | 控制展开图标是否固定，可选 true `left` `right` | boolean \| string | false | 3.0 | +| expandIcon | 自定义展开图标 | Function(props):VNode \| v-slot:expandIcon="props" | - | | | expandRowByClick | 通过点击行来展开子行 | boolean | `false` | | -| expandIconColumnIndex | 展开的图标显示在哪一列，如果没有 `rowSelection`，默认显示在第一列，否则显示在选择框后面 | `number` | | -| footer | 表格尾部 | Function(currentPageData)\|v-slot | | | -| indentSize | 展示树形数据时，每层缩进的宽度，以 px 为单位 | number | 15 | | +| expandIconColumnIndex | 自定义展开按钮的列顺序，`-1` 时不展示 | number | - | | +| footer | 表格尾部 | Function(currentPageData)\|v-slot:footer="currentPageData" | | | +| getPopupContainer | 设置表格内各类浮层的渲染节点，如筛选菜单 | (triggerNode) => HTMLElement | `() => TableHtmlElement` | 1.5.0 | | loading | 页面是否加载中 | boolean\|[object](/components/spin-cn) | false | | -| locale | 默认文案设置，目前包括排序、过滤、空数据文案 | object | filterConfirm: '确定'
filterReset: '重置'
emptyText: '暂无数据' | | +| locale | 默认文案设置，目前包括排序、过滤、空数据文案 | object | filterConfirm: `确定`
filterReset: `重置`
emptyText: `暂无数据` | | | pagination | 分页器，参考[配置项](#pagination)或 [pagination](/components/pagination-cn/)文档，设为 false 时不展示和进行分页 | object | | | | rowClassName | 表格行的类名 | Function(record, index):string | - | | | rowKey | 表格行 key 的取值，可以是字符串或一个函数 | string\|Function(record):string | 'key' | | | rowSelection | 列表项是否可选择，[配置项](#rowSelection) | object | null | | -| scroll | 设置横向或纵向滚动，也可用于指定滚动区域的宽和高，建议为 `x` 设置一个数字，如果要设置为 `true`，需要配合样式 `.ant-table td { white-space: nowrap; }` | { x: number \| true, y: number } | - | | +| scroll | 表格是否可滚动，也可以指定滚动区域的宽、高，[配置项](#scroll) | object | - | | | showHeader | 是否显示表头 | boolean | true | | +| showSorterTooltip | 表头是否显示下一次排序的 tooltip 提示。当参数类型为对象时，将被设置为 Tooltip 的属性 | boolean \| [Tooltip props](/components/tooltip/) | true | 3.0 | | size | 表格大小 | default \| middle \| small | default | | -| title | 表格标题 | Function(currentPageData)\|v-slot | | | +| sortDirections | 支持的排序方式，取值为 `ascend` `descend` | Array | \[`ascend`, `descend`] | | +| sticky | 设置粘性头部和滚动条 | boolean \| `{offsetHeader?: number, offsetScroll?: number, getContainer?: () => HTMLElement}` | - | 3.0 | +| tableLayout | 表格元素的 [table-layout](https://developer.mozilla.org/zh-CN/docs/Web/CSS/table-layout) 属性，设为 `fixed` 表示内容不会影响列的布局 | - \| 'auto' \| 'fixed' | 无
固定表头/列或使用了 `column.ellipsis` 时，默认值为 `fixed` | 1.5.0 | +| title | 表格标题 | Function(currentPageData)\|v-slot:title="currentPageData" | | | +| indentSize | 展示树形数据时，每层缩进的宽度，以 px 为单位 | number | 15 | | +| rowExpandable | 设置是否允许行展开 | (record) => boolean | - | 3.0 | | customHeaderRow | 设置头部行属性 | Function(column, index) | - | | | customRow | 设置行属性 | Function(record, index) | - | | -| getPopupContainer | 设置表格内各类浮层的渲染节点，如筛选菜单 | (triggerNode) => HTMLElement | `() => TableHtmlElement` | 1.5.0 | +| headerCell | 个性化头部单元格 | v-slot:headerCell="{title, column}" | - | 3.0 | +| bodyCell | 个性化单元格 | v-slot:bodyCell="{text, record, index, column}" | - | 3.0 | +| customFilterDropdown | 自定义筛选菜单，需要配合 `column.customFilterDropdown` 使用 | v-slot:customFilterDropdown="[FilterDropdownProps](#FilterDropdownProps)" | - | 3.0 | +| customFilterIcon | 自定义筛选图标 | v-slot:customFilterIcon="{filtered, column}" | - | 3.0 | | transformCellText | 数据渲染前可以再次改变，一般用户空数据的默认配置，可以通过 [ConfigProvider](/components/config-provider-cn/) 全局统一配置 | Function({ text, column, record, index }) => any | - | 1.5.4 | +- `expandFixed` + - 当设置为 true 或 `left` 且 `expandIconColumnIndex` 未设置或为 0 时，开启固定 + - 当设置为 true 或 `right` 且 `expandIconColumnIndex` 设置为表格列数时，开启固定 + ### 事件 | 事件名称 | 说明 | 回调参数 | @@ -142,46 +155,48 @@ cover: https://gw.alipayobjects.com/zos/alicdn/f-SbcX2Lx/Table.svg | 参数 | 说明 | 类型 | 默认值 | 版本 | | --- | --- | --- | --- | --- | -| align | 设置列内容的对齐方式 | 'left' \| 'right' \| 'center' | 'left' | | -| ellipsis | 超过宽度将自动省略，暂不支持和排序筛选一起使用。
设置为 `true` 时，表格布局将变成 `tableLayout="fixed"`。 | boolean | false | 1.5.0 | +| align | 设置列的对齐方式 | `left` \| `right` \| `center` | `left` | | | colSpan | 表头列合并,设置为 0 时，不渲染 | number | | | -| dataIndex | 列数据在数据项中对应的 key，支持 `a.b.c` 的嵌套写法 | string | - | | +| dataIndex | 列数据在数据项中对应的路径，支持通过数组查询嵌套路径 | string \| string\[] | - | | | defaultFilteredValue | 默认筛选值 | string\[] | - | 1.5.0 | -| filterDropdown | 可以自定义筛选菜单，此函数只负责渲染图层，需要自行编写各种交互 | VNode \| v-slot | - | | +| defaultSortOrder | 默认排序顺序 | `ascend` \| `descend` | - | | +| ellipsis | 超过宽度将自动省略，暂不支持和排序筛选一起使用。
设置为 `true` 或 `{ showTitle?: boolean }` 时，表格布局将变成 `tableLayout="fixed"`。 | boolean \| { showTitle?: boolean } | false | showTitle: 3.0 | +| filterDropdown | 可以自定义筛选菜单，此函数只负责渲染图层，需要自行编写各种交互 | VNode | - | | +| customFilterDropdown | 启用 v-slot:customFilterDropdown，优先级低于 filterDropdown | boolean | false | 3.0 | | filterDropdownVisible | 用于控制自定义筛选菜单是否可见 | boolean | - | | | filtered | 标识数据是否经过过滤，筛选图标会高亮 | boolean | false | | | filteredValue | 筛选的受控属性，外界可用此控制列的筛选状态，值为已筛选的 value 数组 | string\[] | - | | -| filterIcon | 自定义 filter 图标。 | VNode \| ({filtered: boolean, column: Column}) => vNode \|slot | false | | +| filterIcon | 自定义 filter 图标。 | VNode \| ({filtered: boolean, column: Column}) => vNode | false | | | filterMultiple | 是否多选 | boolean | true | | | filters | 表头的筛选菜单项 | object\[] | - | | | fixed | 列是否固定，可选 `true`(等效于 left) `'left'` `'right'` | boolean\|string | false | | | key | Vue 需要的 key，如果已经设置了唯一的 `dataIndex`，可以忽略这个属性 | string | - | | -| customRender | 生成复杂数据的渲染函数，参数分别为当前行的值，当前行数据，行索引，@return 里面可以设置表格行/列合并,可参考 demo 表格行/列合并 | Function({text, record, index}) {}\|v-slot | - | | +| customRender | 生成复杂数据的渲染函数，参数分别为当前行的值，当前行数据，行索引，@return 里面可以设置表格行/列合并,可参考 demo 表格行/列合并 | Function({text, record, index, column}) {} | - | | +| responsive | 响应式 breakpoint 配置列表。未设置则始终可见。 | [Breakpoint](https://github.com/ant-design/ant-design/blob/015109b42b85c63146371b4e32b883cf97b088e8/components/_util/responsiveObserve.ts#L1)\[] | - | 4.2.0 | +| showSorterTooltip | 表头显示下一次排序的 tooltip 提示, 覆盖 table 中 `showSorterTooltip` | boolean \| [Tooltip props](/components/tooltip/#API) | true | | | sorter | 排序函数，本地排序使用一个函数(参考 [Array.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) 的 compareFunction)，需要服务端排序可设为 true | Function\|boolean | - | | | sortOrder | 排序的受控属性，外界可用此控制列的排序，可设置为 `'ascend'` `'descend'` `false` | boolean\|string | - | | | sortDirections | 支持的排序方式，取值为 `'ascend'` `'descend'` | Array | `['ascend', 'descend']` | 1.5.0 | -| title | 列头显示文字 | string\|slot | - | | +| title | 列头显示文字 | string | - | | | width | 列宽度 | string\|number | - | | | customCell | 设置单元格属性 | Function(record, rowIndex) | - | | | customHeaderCell | 设置头部单元格属性 | Function(column) | - | | | onFilter | 本地模式下，确定筛选的运行函数, 使用 template 或 jsx 时作为`filter`事件使用 | Function | - | | | onFilterDropdownVisibleChange | 自定义筛选菜单可见变化时调用，使用 template 或 jsx 时作为`filterDropdownVisibleChange`事件使用 | function(visible) {} | - | | -| slots | 使用 columns 时，可以通过该属性配置支持 slot 的属性，如 `slots: { filterIcon: 'XXX'}` | object | - | | ### ColumnGroup -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| title | 列头显示文字 | string\|slot | - | -| slots | 使用 columns 时，可以通过该属性配置支持 slot 的属性，如 `slots: { title: 'XXX'}` | object | - | +| 参数 | 说明 | 类型 | 默认值 | +| ----- | ------------ | ------------ | ------ | +| title | 列头显示文字 | string\|slot | - | ### pagination 分页的配置项。 -| 参数 | 说明 | 类型 | 默认值 | -| -------- | ------------------ | --------------------------- | -------- | -| position | 指定分页显示的位置 | 'top' \| 'bottom' \| 'both' | 'bottom' | +| 参数 | 说明 | 类型 | 默认值 | +| --- | --- | --- | --- | +| position | 指定分页显示的位置， 取值为`topLeft` \| `topCenter` \| `topRight` \|`bottomLeft` \| `bottomCenter` \| `bottomRight` | Array | \[`bottomRight`] | 更多配置项，请查看 [`Pagination`](/components/pagination/)。 @@ -189,15 +204,18 @@ cover: https://gw.alipayobjects.com/zos/alicdn/f-SbcX2Lx/Table.svg 选择功能的配置。 -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| columnWidth | 自定义列表选择框宽度 | string\|number | - | -| columnTitle | 自定义列表选择框标题 | string\|VNode | - | -| fixed | 把选择框列固定在左边 | boolean | - | -| getCheckboxProps | 选择框的默认属性配置 | Function(record) | - | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| --- | --- | --- | --- | --- | +| checkStrictly | checkable 状态下节点选择完全受控（父子数据选中状态不再关联） | boolean | true | 4.4.0 | +| columnWidth | 自定义列表选择框宽度 | string\|number | - | | +| columnTitle | 自定义列表选择框标题 | string\|VNode | - | | +| fixed | 把选择框列固定在左边 | boolean | - | | +| getCheckboxProps | 选择框的默认属性配置 | Function(record) | - | | +| hideSelectAll | 隐藏全选勾选框与自定义选择项 | boolean | false | 3.0 | +| preserveSelectedRowKeys | 当数据被删除时仍然保留选项的 `key` | boolean | - | 3.0 | | hideDefaultSelections | 去掉『全选』『反选』两个默认选项 | boolean | false | | selectedRowKeys | 指定选中项的 key 数组，需要和 onChange 进行配合 | string\[] | \[] | -| selections | 自定义选择配置项, 设为 `true` 时使用默认选择项 | object\[]\|boolean | - | +| selections | 自定义选择项 [配置项](#selection), 设为 `true` 时使用默认选择项 | object\[] \| boolean | true | | | type | 多选/单选，`checkbox` or `radio` | string | `checkbox` | | onChange | 选中项发生变化时的回调 | Function(selectedRowKeys, selectedRows) | - | | onSelect | 用户手动选择/取消选择某列的回调 | Function(record, selected, selectedRows, nativeEvent) | - | @@ -206,11 +224,11 @@ cover: https://gw.alipayobjects.com/zos/alicdn/f-SbcX2Lx/Table.svg ### scroll -| 参数 | 说明 | 类型 | 默认值 | 版本 | -| --- | --- | --- | --- | --- | -| x | 设置横向滚动，也可用于指定滚动区域的宽和高，可以设置为像素值，百分比，true 和 ['max-content'](https://developer.mozilla.org/zh-CN/docs/Web/CSS/width#max-content) | number \| true | - | | -| y | 设置纵向滚动，也可用于指定滚动区域的宽和高，可以设置为像素值，百分比，true 和 ['max-content'](https://developer.mozilla.org/zh-CN/docs/Web/CSS/width#max-content) | number \| true | - | | -| scrollToFirstRowOnChange | 当分页、排序、筛选变化后是否滚动到表格顶部 | boolean | - | 1.5.0 | +| 参数 | 说明 | 类型 | 默认值 | +| --- | --- | --- | --- | +| scrollToFirstRowOnChange | 当分页、排序、筛选变化后是否滚动到表格顶部 | boolean | - | +| x | 设置横向滚动，也可用于指定滚动区域的宽，可以设置为像素值，百分比，true 和 ['max-content'](https://developer.mozilla.org/zh-CN/docs/Web/CSS/width#max-content) | string \| number \| true | - | +| y | 设置纵向滚动，也可用于指定滚动区域的高，可以设置为像素值 | string \| number | - | ### selection @@ -222,6 +240,21 @@ cover: https://gw.alipayobjects.com/zos/alicdn/f-SbcX2Lx/Table.svg | text | 选择项显示的文字 | string\|VNode | - | | onSelect | 选择项点击回调 | Function(changeableRowKeys) | - | +### FilterDropdownProps + +```ts +interface FilterDropdownProps { + prefixCls: string; + setSelectedKeys: (selectedKeys: Key[]) => void; + selectedKeys: Key[]; + confirm: (param?: FilterConfirmProps) => void; + clearFilters?: () => void; + filters?: ColumnFilterItem[]; + visible: boolean; + column: ColumnType; +} +``` + ## 注意 在 Table 中，`dataSource` 和 `columns` 里的数据值都需要指定 `key` 值。对于 `dataSource` 默认将每列数据的 `key` 属性作为唯一的标识。 @@ -234,3 +267,9 @@ return ; // 或 return
record.uid} />; ``` + +## 从 v1 / v2 升级到 v3 + +Table 废弃了 `column.slots`, 新增 `v-slot:bodyCell`、`v-slot:headerCell`，自定义单元格，新增 `column.customFilterDropdown` `v-slot:customFilterDropdown`，自定义筛选菜单，新增了 `v-slot:customFilterIcon` 自定义筛选按钮，但 `column.slots` 还可用，我们会在下一个大版本时移除。 + +此外，比较重大的改动为 `dataIndex` 从支持路径嵌套如 `user.age` 改成了数组路径如 `['user', 'age']`。以解决过去属性名带 `.` 需要额外的数据转化问题。 diff --git a/components/table/interface.tsx b/components/table/interface.tsx index da8a49b10..eb92b5907 100644 --- a/components/table/interface.tsx +++ b/components/table/interface.tsx @@ -73,7 +73,7 @@ export interface FilterConfirmProps { closeDropdown: boolean; } -export interface FilterDropdownProps { +export interface FilterDropdownProps { prefixCls: string; setSelectedKeys: (selectedKeys: Key[]) => void; selectedKeys: Key[]; @@ -81,6 +81,7 @@ export interface FilterDropdownProps { clearFilters?: () => void; filters?: ColumnFilterItem[]; visible: boolean; + column: ColumnType; } export interface ColumnType extends RcColumnType { @@ -102,7 +103,7 @@ export interface ColumnType extends RcColumnType // Filter filtered?: boolean; filters?: ColumnFilterItem[]; - filterDropdown?: VueNode | ((props: FilterDropdownProps) => VueNode); + filterDropdown?: VueNode | ((props: FilterDropdownProps) => VueNode); filterMultiple?: boolean; filteredValue?: FilterValue | null; defaultFilteredValue?: FilterValue | null;