# 表格 Table ## 何时使用 - 当有大量结构化的数据需要展现时，可使用 `Table` 组件； - `Table` 组件拥有多种可自由组合使用的功能特性，包括： 1. 大数据渲染 2. 拖拽交换、拖拽改变列宽 3. 行选择（单选/多选） 4. 表体滚动 5. 数据操作 6. 支持多种表格编辑形式 7. 列锁定 8. 列过滤 9. 列隐藏 10. 列排序 - `Grid` 组件聚合了 `Table` 组件的所有功能特性，并在此基础上封装了导出数据、工具栏、分页、数据关联等高级功能。可达到随用随取、开箱即用的体验。当需要使用多种功能组合的 `Table` 展示时，推荐使用[Grid组件](https://design.yonyoucloud.com/tinper-acs/bee-complex-grid)。 ## 如何使用 ``` import { Table } from 'tinper-bee'; or import Table from 'bee-table'; import 'bee-table/build/Table.css'; ``` ## 代码演示 ## API ### Table | 参数 | 说明 | 类型 | 默认值 | | :--------------------- | :--------------------------------------- | :------------------------------------- | :-------------- | | data | 传入的表格数据（key值必需，否则会导致部分功能出现问题。建议使用唯一的值，如id） | array | [] | | bordered | 是否展示外边框和列边框 | boolean | false | | columns | 列的配置表，具体配置见下表 | array | - | | defaultExpandAllRows | 默认是否展开所有行 | bool | false | | expandedRowKeys | 展开的行，控制属性 | array | - | | defaultExpandedRowKeys | 初始扩展行键 | array | [] | | bodyStyle | 添加到tablebody上的style | object | {} | | style | 添加到table上的style | object | {} | | rowKey | 如果rowKey是字符串，`record [rowKey]`将被用作键。如果rowKey是function，`rowKey（record, index）`的返回值将被用作键。 | string or Function(record, index):string | 'key' | | rowClassName | 获取行的classname | Function(record, index, indent):string | () => '' | | expandedRowClassName | 获取展开行的className | Function(recode, index, indent):string | () => '' | | onExpand | 展开行时的钩子函数 | Function(expanded, record) | () => '' | | onExpandedRowsChange | 函数在扩展行更改时调用 | Function(expandedRows) | () => '' | | indentSize | indentSize为每个级别的data.i.children，更好地使用column.width指定 | number | 15 | | onRowClick | 行的点击事件钩子函数 | Function(record, index, event) | () => '' | | onRowDoubleClick | 行的双击事件钩子函数 | Function(record, index, event) | () => '' | | expandIconAsCell | 是否将expandIcon作为单元格 | bool | false | | expandIconColumnIndex | expandIcon的索引，当expandIconAsCell为false时，将插入哪个列 | number | 0 | | showHeader | 是否显示表头 | bool | true | | title | 表格标题 | Function | - | | footer | 表格尾部 | Function | - | | emptyText | 无数据时显示的内容 | Function | () => 'No Data' | | scroll | 横向或纵向支持滚动，也可用于指定滚动区域的宽高度 | `{ x: number / true / 百分比 , y: number }` | {} | | rowRef | 获取行的ref | Function(record, index, indent):string | () => null | | getBodyWrapper | 添加对table body的包装 | Function(body) | body => body | | expandedRowRender | 额外的展开行 | Function(record, index, indent):node | - | | expandIconAsCell | 展开按钮是否单独作为一个单元格 | bool | false | | expandRowByClick | 设置展开行是否通过点击行触发，此参数需要与上面参数搭配使用（默认是通过点击行前面的加号展开行 | bool | false | | footerScroll | 表尾和body是否公用同一个横向滚动条。（ 如果footer中也是一个table组件，并且也具有滚动条，那么也需要加入footerScroll参数，内层表格的footerScroll设置成false。 ） | bool | false | | loading | 表格是否加载中 | bool|object(详情可以参考上面示例) | false | | haveExpandIcon | 控制是否显示行展开icon.**注：该参数只有在和expandedRowRender同时使用才生效** | Function(record, index):bool | () =>false | | filterable | 是否开启根据条件来过滤数据 | bool | false | filterDelay | 触发过滤输入的时候的ms延迟时间 | number | 300 | onFilterChange | 触发过滤输入操作以及下拉条件的回调 | function | (field,value,condition) => () | onFilterClear | 清除过滤条件的回调函数，回调参数为清空的字段 | function | (field) => () | headerScroll | 表头下是否显示滚动条 | bool| false | sort | 排序的属性 | object| { mode:'single'//单列排序, backSource:false //默认是前端排序，值为true为后端排序 } mode:multiple-多列排序 | syncHover | 是否同步Hover状态到左侧Checkbox，关闭此功能有助于提升性能 | bool| true | loadBuffer | 使用BigData高阶组件实现大数据加载时，上下加载的缓存 | number| 5 | resetScroll | 将表格横向滚动条位置还原 | bool| false | hoverContent | hover某行时，动态渲染行菜单元素，此方法需返回行菜单元素的内容 | Function| | onRowHover | 行hover时的回调函数 | Function| | heightConsistent | 当固定列内容高度超出非固定列时，内容互错行，当此属性为true会将高度同步，当行过多时会有性能影响，所以建议非固定高度如果过高时，超出内容可以显示成省略号 | bool|false | height | 自定义表格行高 | number | - | | headerHeight | 自定义表头行高 | number | - | | size | 表格大小 | `sm / md / lg` | 'md' | | headerDisplayInRow | 设置表头的内容显示一行，超出显示省略号 | bool | | bodyDisplayInRow | 设置表体的内容显示一行，超出显示省略号 | bool | | rowDraggAble | 是否增加行交换顺序功能 | boolean| false > 快捷键部分参考示例 (快捷键在table中的简单使用应用) *注意: data参数中的key值必需，否则会导致部分功能出现问题！建议使用唯一的值，如id* ### Column |参数|说明|类型|默认值| |:--|:---|:--|:---| |key|列的键|string|-| |className|传入列的classname|String |-| |colSpan|该列的colSpan，设置列合并|Number|-| |title|列的标题|node|-| |dataIndex| 显示数据记录的字段|String|-| |width|宽度的特定比例根据列的宽度计算|String/Number|-| |fixed| 当表水平滚动时，此列将被固定：true或'left'或'right'| true/'left'/'right'|-| |sorter|前端列排序方法，只要列上有此属性就说明这列可排序。**注：默认是前端排序,排序方法书写时注意有些字段的值可能是undefined的情况，需要转换成0**| function|-| |sorterClick|排序的回调函数|function|-| |render|cell的render函数有三个参数：这个单元格的文本，这行的记录，这行的索引，它返回一个对象：{children：value，props：{colSpan：1，rowSpan：1}} ==>'children'是这个单元格的文本，props是这个单元格的一些设置，可以设置单元格行/列合并|-| |onCellClick|单击列的单元格时调用|Function(row, event)|-| | order | 设置排序 | string（"descend"、"ascend"） | -| | filterType | 过滤下拉的类型.可选`text(文本框)`,`dropdown(下拉)`,`date(日期)`,`daterange(日期范围)`,`number(数值)` | string | text | | filterDropdown | 是否显示过滤下拉.可选`show`,`hide` | string | show | | format | 针对过滤下拉设置日期类的格式 | string | YYYY-MM-DD | | filterDropdownAuto | 设置下拉条件是否自动设置选项，`auto`自动根据当前数据生成，`manual`手动传入，可以使用`filterDropdownData`来传入自定义数据 | string | auto | | filterDropdownData | 下拉条件自定义数据，filterDropdownAuto=manual生效，传入格式：[{ key : "自定义", value : "自定义" }] | array | [] | | filterDropdownFocus | 触发点击下拉条件的回调，一般用于异步点击请求数据使用 | function | () => () | | filterDropdownType | 下拉条件类型，分为 string 和 number 条件类型 | string | string | filterDropdownIncludeKeys | 能够设置指定的下拉条件项，通过设置keys 其中string条件可设置:LIKE,ULIKE,EQ,UEQ,START,END.number条件可设置:GT,GTEQ,LT,LTEQ,EQ,UEQ | array | [] 不设置此属性为显示所有 | filterInputNumberOptions | 数值框接收的props，具体属性参考bee-input-number | object | null | textAlign | 内容对齐方式，默认是左对齐（'left、right、center'） | string | ### 高阶函数 Table拓展功能方法。注：拼接成复杂功能的table组件不能在render中定义，需要像此例子声明在组件的外侧，不然在操作state会导致功能出现异常 需要单独的去引用相应的js文件，目录在lib文件夹，示例如下： ```js import multiSelect from "tinper-bee/lib/multiSelect.js"; ``` ### multiSelect 多选功能 #### API Data 数组参数： | 参数 | 说明 | 类型 | 默认值 | | ------------------- | -------------------------- | -------- | -------- | | _checked | 设置是否选中当前数据 | boolean | true/false | | _disabled | 设置是否禁用当前数据 | boolean | true/false | Table 组件参数： | 参数 | 说明 | 类型 | 默认值 | | ------ | ---------- | -------- | ---- | | getSelectedDataFunc | 返回当前选中的数据数组 | Function | 无 | #### 使用 ```js import multiSelect from "tinper-bee/lib/multiSelect.js"; import { Table, Checkbox } from 'tinper-bee'; const MultiSelectTable = multiSelect(Table, Checkbox); ``` ### sort 排序功能 #### API column 数组参数： | 参数 | 说明 | 类型 | 默认值 | | ------ | ---------- | -------- | ---- | | sorter | 排序函数，可以自定义 | Function | 无 | | sorterClick | 排序钩子函数| Function | (coloum,type) | #### 使用 ```js import sort from "tinper-bee/lib/sort.js"; import { Table, Icon } from 'tinper-bee'; const SortTable = sort(Table, Icon); ``` ### sum 合计功能 #### API column 数组参数： | 参数 | 说明 | 类型 | 默认值 | | ------ | ---------- | -------- | ---- | | sumCol | 该列设置为合计列，合计行中会显示合计数据 | boolean | false | #### 使用 ```js import sum from "tinper-bee/lib/sum.js"; import { Table } from 'tinper-bee'; const SumTable = sum(Table); ``` ### dragColumn 拖拽列功能 #### API Table 组件参数： | 参数 | 说明 | 类型 | 默认值 | | ------ | ---------- | -------- | ---- | | dragborder | 拖拽调整列宽度 | boolean | false | | draggable | 拖拽交换列 | boolean | false | | onDrop | 拖拽释放回调函数(交换列) | function | () => {} | | onDropBorder | 拖拽释放回调函数(调整列宽) | function | (e) => {} | #### 使用 ```js import dragColumn from "tinper-bee/lib/dragColumn.js"; import { Table } from 'tinper-bee'; const DragColumnTable = dragColumn(Table); ``` ### filterColumn 过滤功能 #### API 无 #### 使用 ```js import filterColumn from "tinper-bee/lib/filterColumn.js"; import { Table, Checkbox, Popover, Icon } from 'tinper-bee'; const DragColumnTable = filterColumn(Table, Checkbox, Popover, Icon); ``` ### rendertype 在表格中提供了多种rendertype可以供选择，比如下拉框，输入框，日期等 需要单独的去引用相应的js文件，目录在render文件夹，示例如下： ```js import renderInput from "tinper-bee/lib/InputRender.js"; ``` ### InputRender 输入框类型render #### 依赖的组件 该render依赖于`Icon`,`FormControl`,`Form`,`Tooltip`。 #### 配置 | 参数 | 说明 | 类型 | 默认值 | | ----------------- | ---------------------------------------- | ---------- | ------ | | name | 该输入框获取数据时的key值，该值不能设置重复且必填 | string | - | | placeholder | 输入框的提示信息 | string | - | | value | 输入框中的显示值 | string | 无 | | isclickTrigger | 是否使用点击触发编辑状态 | boolean | false | | onChange | 当值发生改变的时候触发的方法 | Function | 无 | | format | 浏览态格式化类型，Currency:货币数字; | string | 无 | | formItemClassName | FormItem的class | string | - | | mesClassName | 校验错误信息的class | string | - | | isRequire | 是否必填 | bool | false | | check | 验证的回调函数，参数两个，第一个为校验是否成功`true/false` 第二个为验证结果对象`{name: "", verify: false, value: ""}` | function | - | | method | 校验方式，change/blur | string | - | | errorMessage | 错误提示信息 | dom/string | "校验失败" | | htmlType | 数值类型，目前支持 email/tel/IDCard/chinese/password'类型 | string | - | | reg | 校验正则，注：设置 htmlType 后 reg 无效 | regExp | - | #### 使用 ```js import renderInput from "tinper-bee/lib/InputRender.js"; import { Icon, Form , FormControl } from 'tinper-bee'; const InputRender = renderInput(Form, FormControl, Icon); ``` ### DateRender 日期类型render #### 依赖的组件 该render依赖于`moment`, `Datepicker`, `Icon` #### 配置 | 参数 | 说明 | 类型 | 默认值 | | ----------------- | ---------------------------------------- | ---------- | ------ | | isclickTrigger | 是否使用点击触发编辑状态 | boolean | false | | type | 控制日期的显示格式，DatePicker、MonthPicker或者WeekPicker，暂时不支持RangePicker | string | "DatePicker" | 注:其他参数参见Datepicker组件参数配置 #### DateRender:使用 ```js import renderDate from "tinper-bee/lib/DateRender.js"; import Datepicker from "tinper-bee/lib/Datepicker"; import { Icon } from 'tinper-bee'; const DateRender = renderDate(Datepicker, Icon); ``` ### SelectRender 下拉框类型render #### 依赖的组件 该render依赖于`Icon`,`Select` #### 配置 | 参数 | 说明 | 类型 | 默认值 | | -------------- | ---------------------------------------- | ------- | ----- | | isclickTrigger | 是否使用点击触发编辑状态 | boolean | false | | dataSource | 数据的键值对，在表格浏览态的时候能显示真实的key值。比如`[{key:"张三",value:"01"}]` | array | - | 注:其他参数参见Select组件参数配置 #### SelectRender:使用 ```js import renderSelect from "tinper-bee/lib/SelectRender.js"; import { Icon, Select } from 'tinper-bee'; const SelectRender = renderSelect(Select, Icon); ``` ### CheckboxRender 复选框类型render #### 依赖的组件 该render依赖于`Icon`,`Checkbox` #### 配置 | 参数 | 说明 | 类型 | 默认值 | | -------------- | ---------------------------------------- | ------- | ----- | | onChange | 修改后触发回调函数 | function | () => {} | | value | 设置是否选中值 | boolean | false | 注:其他参数参见Checkbox组件参数配置 #### 使用 ```js import renderCheckbox from "tinper-bee/lib/CheckboxRender.js"; import { Icon, Checkbox } from 'tinper-bee'; const CheckboxRender = renderCheckbox(Checkbox, Icon); ``` ### 快捷键API | 快捷键 | 快捷键说明 | 类型 | 默认值 | | --- | :--- | --- |--- | | focusable | 是否开启快捷键功能 | bool | - | onKeyTab | tab快捷键，可以处理默认选中第一条数据 | function| - | onKeyUp | ↑(上箭) 快捷键，可以处理table的上一条数据 | function| - | onKeyDown | ↓(下箭)快捷键，可以处理table的下一条数据 | function| - | onTableKeyDown | 触发table的所有快捷键 | function| - | tabIndex | 设置焦点顺序 | number | 0 ## 注意事项 - 如果使用了固定列，请给固定的列设定固定宽度既width属性。 - 在使用expandedRowRender属性扩展表格时，如果同时使用了固定列。 需要给expandedRowRender中返回的对象添加`style=\{{height: xxx}\}`,来使扩展后的固定列扩展成一样高度。 > 当表格场景比较复杂时，可以使用[复杂表格ComplexGrid](http://bee.tinper.org/bee-complex-grid#bee-complex-grid)。ComplexGrid将常用的过滤、多选、分页、列交换、列拖拽等功能集成在一起。使用起来超级方便。 ## 更新日志