bee-table/docs/api.md

表格 Table

何时使用

• 当有大量结构化的数据需要展现时，可使用 Table 组件；
• Table 组件拥有多种可自由组合使用的功能特性，包括：
  1. 大数据渲染
  2. 拖拽交换、拖拽改变列宽
  3. 行选择（单选/多选）
  4. 表体滚动
  5. 数据操作
  6. 支持多种表格编辑形式
  7. 列锁定
  8. 列过滤
  9. 列隐藏
  10. 列排序
• Grid 组件聚合了 Table 组件的所有功能特性，并在此基础上封装了导出数据、工具栏、分页、数据关联等高级功能。可达到随用随取、开箱即用的体验。当需要使用多种功能组合的 Table 展示时，推荐使用Grid组件。

如何使用

import { Table } from 'tinper-bee';

or

import Table from 'bee-table';
import 'bee-table/build/Table.css';

代码演示

API

Table props

参数	说明	类型	默认值
data	传入的表格数据（key值必需，否则会导致部分功能出现问题。建议使用唯一的值，如id）	array	[]
columns	列的配置表，具体配置见下表	array	-
columnKey	如果columnKey是字符串，column [columnKey]将被作为主键。	string	'key'
bordered	是否展示外边框和列边框	boolean	false
defaultExpandAllRows	默认是否展开所有行	bool	false
defaultExpandedRowKeys	初始扩展行键	array	[]
rowRef	获取行的ref	Function(record, index, indent):string	() => null
rowKey	如果rowKey是字符串，record [rowKey]将被用作键。如果rowKey是function，rowKey（record, index）的返回值将被用作键。树形表格时作为每条数据的唯一标示，如果唯一标示不是"key"键的值，则必须传入，例如 rowKey='id'	string or Function(record, index):string	'key'
expandedRowKeys	展开的行，控制属性	array	-
rowClassName	获取行的classname	Function(record, index, indent):string	() => ''
expandedRowClassName	获取展开行的className	Function(recode, index, indent):string	() => ''
indentSize	indentSize为每个级别的data.i.children，更好地使用column.width指定	number	15
expandIconAsCell	展开按钮是否单独作为一个单元格	bool	false
expandIconColumnIndex	expandIcon的索引，当expandIconAsCell为false时，将插入哪个列	number	0
expandedRowRender	额外的展开行	Function(record, index, indent):node	-
haveExpandIcon	控制是否显示行展开icon.注：该参数只有在和expandedRowRender同时使用才生效	Function(record, index):bool	() =>false
expandedIcon	嵌套表格场景中展开子表时的展开图标
collapsedIcon	嵌套表格场景中关闭子表时的关闭图标
expandRowByClick	设置展开行是否通过点击行触发，此参数需要与上面参数搭配使用（默认是通过点击行前面的加号展开行	bool	false
rowDraggAble	是否增加行交换顺序功能	boolean	false
useDragHandle	通过行手柄进行拖拽排序，在 rowDraggAble 为 true 时有效	boolean	false
showHeader	是否显示表头	bool	true
title	表格标题	Function	-
footer	表格尾部	Function	-
emptyText	无数据时显示的内容	Function	() => 'No Data'
loading	表格是否加载中	bool	object(详情可以参考上面示例)
getBodyWrapper	添加对table body的包装	Function(body)	body => body
bodyStyle	添加到tablebody上的style	object	{}
style	添加到table上的style	object	{}
scroll	横向或纵向支持滚动，也可用于指定滚动区域的宽高度	{ x: number / 百分比 , y: number }	{}
headerScroll	表头下是否显示滚动条	bool	false
footerScroll	表尾和body是否公用同一个横向滚动条。（ 如果footer中也是一个table组件，并且也具有滚动条，那么也需要加入footerScroll参数，内层表格的footerScroll设置成false。 ）	bool	false
resetScroll	将表格横向滚动条位置还原	bool	false
filterable	是否开启根据条件来过滤数据	bool	false
filterDelay	触发过滤输入的时候的ms延迟时间	number	300
sort	排序的属性	object	{ mode:'single'//单列排序, backSource:false //默认是前端排序，值为true为后端排序 } mode:multiple-多列排序
syncHover	是否同步Hover状态到左侧Checkbox，关闭此功能有助于提升性能	bool	true
loadBuffer	使用BigData高阶组件实现大数据加载时，上下加载的缓存	number	5
hoverContent	hover某行时，动态渲染行菜单元素，此方法需返回行菜单元素的内容	Function
heightConsistent	当固定列内容高度超出非固定列时，内容互错行，当此属性为true会将高度同步，当行过多时会有性能影响，所以建议非固定高度如果过高时，超出内容可以显示成省略号	bool	false
height	自定义表格行高	number	-
headerHeight	自定义表头行高	number	-
headerDisplayInRow	设置表头的内容显示一行，超出显示省略号	bool	true
bodyDisplayInRow	设置表体的内容显示一行，超出显示省略号，注意：不要和 height 属性一起使用，该属性优先级高于 height	bool	true
size	表格大小	sm / md / lg	'md'
hideHeaderScroll	表体无数据时，表头下是否显示滚动条，默认显示	bool	false
[v2.2.2新增]showRowNum	展示序号功能，false时不展示，true时展示默认情况，可传入自定义配置信息	bool / obj:{name: '序号', key: '_index', // 在数据中存储的key值width: 50,base: 0,// 排序的基准值,为数字或者字母type:'number', // 排序类型,默认为number类型,支持单字母排序(type='ascii')}	false
[v2.2.8新增]autoCheckedByClickRows	设置为 false 时，表格行点击事件，不会自动勾选复选框	bool	true
[v2.2.8新增]autoSelect	树型表格勾选时，是否开启子节点的联动	bool	false
onPaste	粘贴的回调函数	func(event,positon)	-
onCopy	复制列的回调函数	func(data,event)	-
onBodyScroll	table body 滚动的回调	func(scrollTop)	-
syncRowHeight	滚动是否同步高度,关闭此功能有利于提高性能，注：树表和主子表不允许关闭	true	-
onBodyMouseLeave	移除表体的回调事件	func()	-

快捷键部分参考示例 (快捷键在table中的简单使用应用)

注意: data参数中的key值必需，否则会导致部分功能出现问题！建议使用唯一的值，如id

Table events

事件名	说明	类型	返回值
onExpand	展开行时的钩子函数	Function(expanded, record)	expanded : 当前的状态 record : 当前行的数据
onExpandedRowsChange	函数在扩展行更改时调用	Function(expandedRowKeys)	expandedRowKeys : 展开行的keys数组
onRowClick	行的点击事件钩子函数	Function(record, index, event)	record : 当前行的数据 index : 当前行的index event : 事件对象
onRowDoubleClick	行的双击事件钩子函数	Function(record, index, event)	record : 当前行的数据 index : 当前行的index event : 事件对象
onFilterChange	触发过滤输入操作以及下拉条件的回调	function(field,value,condition)	field : 字段名称 value : 字段值 condition : 判断条件
onFilterClear	清除过滤条件的回调函数，回调参数为清空的字段	function(field)	field : 字段名称
onRowHover	行hover时的回调函数	function(index,record)	index : 当前行的index record : 当前行的数据
onDragRowStart	行拖拽开始时的回调函数	function(record,index)	record : 当前行的数据 index : 当前行的index
onDropRow	行拖拽结束后的回调函数	function(data,record)	data : 拖拽后的新data数组 record : 拖拽行的数据

Data

参数	说明	类型	默认值
style	该行的样式，严格按照react的样式书写规则，即对象内每一个属性的键为小写驼峰式，值为字符串	object	-

Column

参数	说明	类型	默认值
key	列的键	string	-
className	传入列的classname	String	-
colSpan	表头列合并,设置为 0 时，不渲染	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是这个单元格的一些设置，可以设置单元格行/列合并。2.2.48及以后版本新增第四个参数options为column设置的属性	-
onCellClick	单击列的单元格时调用	Function(row, event)	-
onHeadCellClick	单击表头的单元格时调用	Function(row, event)	row 当前行的数据
order	设置排序	string（"descend"、"ascend"）	-
orderNum	多列排序时，用来设置排序优先级（1的优先级最高）	number	-
filterType	过滤下拉的类型.可选text(文本框),dropdown(下拉),date(日期),dateyear(日期-年),datemonth(日期-月),dateweek(日期-周),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
mergeEndIndex	大数据量滚动加载场景，合并表格行时，设置合并结束位置的行 index 值，设置在列 render 函数中的 props 属性上	Number
textAlign	列对齐方式，默认是左对齐（'left、right、center'）	string
[v2.2.2新增]sortEnable	开启默认排序,根据fieldType属性确定排序规则，默认按字符串排序;优先级低于sorter属性;需配合高阶函数multiSelect使用	bool	false
[v2.2.2新增]fieldType	列类型，可选string,number,currency,bool,link	string	'string'
[v2.2.2新增]fontColor	列文本颜色	string	-
[v2.2.2新增]bgColor	列背景颜色	string	-
[v2.2.2新增]titleAlign	标题对齐方式	'left'|'center'|'right'	'left'
[v2.2.2新增]contentAlign	内容对齐方式	'left'|'center'|'right'	'left'
[v2.2.2新增]required	必填项的列标题展示红色星号	bool	false
isShow	是否展示该列数据	bool	true
cellMenu	渲染单元格内操作按钮	object	-
style	该列的样式，严格按照react的样式书写规则，即对象内每一个属性的键为小写驼峰式，值为字符串	object	-
sumRender	自定义合计render函数	func(value)	-
getCellClassName	自定义单元格样式	func(record,index,column) record：当前行数据，index:行索引，column：当前列索引	-

[v2.2.x新增] cellMenu

属性的参数说明如下:

名称	说明	类型	必填	默认值
menu	自定义的操作列表	array	是	[]
icon	自定义图标	string/element	否	三圆点图标<Icon type='uf-3dot-h'/>
iconSize	自定义图标时可能会出现右侧对齐的问题,需要手动调整图标大小	number	否	21
trigger	控制下拉菜单的出现方式	'hover'|'click'	否	'hover'
className	下拉菜单的类名	string	否	-

其中,menu的配置如下:

名称	说明	类型	必填	默认值
key	每一项需要的唯一的key值	string	true	-
text	每一项的标题	string	false	-
icon	每一项的图标信息	string/element	false	-
callback	点击行后的回调函数	Function(text,record,index)	false	-

[v2.2.2新增]fieldType

fieldType属性控制了不同类型数据的渲染方式,其优先级低于render属性。目前，已有string,number,currency,bool,link,date,select,stringChinese类型，支持自定义配置(string类型为默认类型)。

• stringChinese类型的渲染同string,在配合高阶组件sort使用时,可支持中文拼音排序

• numberConfig

具体属性	说明	类型	默认值
thousand	是否展示千分符号	bool	true
preSymbol	数值的前缀	string	null
nextSymbol	数值的后缀	string	null

• currencyConfig

具体属性	说明	类型	默认值
thousand	是否展示千分符号	bool	true
preSymbol	数值的前缀	string	null
nextSymbol	数值的后缀	string	null
precision	精度	number	2
makeUp	末位是否补零	bool	true

• boolConfig

具体属性	说明	类型	默认值
trueText	数值为true时的展示文本	string	'是'
falseText	数值为false时的展示文本	string	'否'

• linkConfig

具体属性	说明	类型	默认值
url	获取url的函数	function(text,record,index)	null
urlIndex	数据内url字段的key值	string	null
desc	鼠标hover时展示的title值，为false时不展示，true时展示链接的url，为字符串时展示字符串，为函数时展示返回值,如(text,record,index)=>'text'	bool|string|func	true
descIndex	数据内desc字段的key值	string	null
linkType	打开窗口的方式	'_self'|'_blank'	'_blank'
linkColor	链接的字体颜色	string	'#0073E1'
underline	hover时是否展示下划线	bool	false
className	链接的className	string	null

url和urlIndex属性至少有一个，均存在时url优先级更高

desc和descIndex属性相比，desc优先级更高

• dateConfig

具体属性	说明	类型	默认值
moment	传入的moment对象,必需	object	-
format	渲染的时间格式	string	'YYYY-MM-DD'

需要单独安装moment.js,并将moment对象传入

• selectConfig

名称	说明	类型	必填项	默认值
options	下拉的key/value对应关系	object	是	-
defaultShow	找不到对应关系时的展示值	string	否	''

无options时按string类型渲染

高阶函数

Table内部封装了七个高阶组件，接收基础 Table 组件作为输入，输出一个新的复杂 Table 组件。高阶组件让代码更具有复用性、逻辑性与抽象特征。

注：不要在render方法内部使用高阶组件。这样不仅会有性能问题 – 重新挂载一个组件还会导致这个组件的状态和他所有的子节点的状态丢失。

使用时需要单独引用相应的js文件，目录在lib文件夹，以多选功能（multiSelect）为例：

import multiSelect from "tinper-bee/lib/multiSelect.js";

singleSelect 单选功能

如何使用

import singleSelect from "tinper-bee/lib/singleSelect.js";
import { Table, Radio } from 'tinper-bee';

const SingleSelectTable = singleSelect(Table, Radio);

API

Table 组件参数：

参数	说明	类型	默认值
getSelectedDataFunc	返回当前选中的数据数组	Function	无
selectedRowIndex	指定当前选中数据的 index	number	无

singleSelect 使用示例

• 单选功能

multiSelect 多选功能

如何使用

import multiSelect from "tinper-bee/lib/multiSelect.js";
import { Table, Checkbox } from 'tinper-bee';

const MultiSelectTable = multiSelect(Table, Checkbox);

API

Table 组件参数：

参数	说明	类型	返回值
getSelectedDataFunc	返回当前选中的数据数组	Function	selectedList : 当前选中的行数据集合 record : 当前操作行数据 index : 当前操作行索引
multiSelectConfig	自定义 Checkbox 属性，如设置复选框为红色填充	Object	-

Data 数组参数：

参数	说明	类型	默认值
_checked	设置是否选中当前数据	boolean	true/false
_disabled	设置是否禁用当前数据	boolean	true/false

multiSelect 使用示例

• 多选功能

sort 排序功能

如何使用

import sort from "tinper-bee/lib/sort.js";
import { Table, Icon } from 'tinper-bee';

const SortTable = sort(Table, Icon);

API

column 数组参数：

参数	说明	类型	默认值
sorter	排序函数，可以自定义	Function	无
sorterClick	排序钩子函数	Function	(coloum,type)

sort 使用示例

• 列排序
• 后端列排序
• 多列排序

sum 合计功能

如何使用

import sum from "tinper-bee/lib/sum.js";
import { Table } from 'tinper-bee';

const SumTable = sum(Table);

//[v2.2.49新增]precision为精度，默认为2
const SumTable = sum(Table,precision);

API

column 数组参数：

参数	说明	类型	默认值
sumCol	该列设置为合计列，合计行中会显示合计数据	boolean	false

sum 使用示例

• 列合计（总计）

dragColumn 拖拽列功能

如何使用

import dragColumn from "tinper-bee/lib/dragColumn.js";
import { Table } from 'tinper-bee';

const DragColumnTable = dragColumn(Table);

API

Table 组件参数：

参数	说明	类型	默认值
dragborder	拖拽调整列宽度	boolean	false
draggable	拖拽交换列	boolean	false
minColumnWidth	拖拽列宽度的最小限制	number	80
onDrop	拖拽释放回调函数(交换列)	function	() => {}
onDropBorder	拖拽释放回调函数(调整列宽)	function	(e,width) => {}
onDraggingBorder	调整列宽过程中触发的回调函数	function	(e,width) => {}

dragColumn 使用示例

• 拖拽改变列顺序
• 拖拽改变列宽度

filterColumn 过滤功能

如何使用

import filterColumn from "tinper-bee/lib/filterColumn.js";
import { Table, Checkbox, Popover, Icon } from 'tinper-bee';

const FilterColumnTable = filterColumn(Table, Checkbox, Popover, Icon);

API

无

filterColumn 示例

• 按条件、值过滤
• 复杂表格中行过滤

bigData 大数据渲染

如何使用

import bigData from "tinper-bee/lib/bigData.js";
import { Table } from 'tinper-bee';

const BigDataTable = bigData(Table);

API

Table 组件参数：

参数	说明	类型	返回值
onBodyScroll	表体滚动加载时触发的回调函数	function(endIndex)	endIndex : 可视区最后一条数据的 index 序号

bigData 使用示例

• 万行以上数据渲染
• 嵌套子表格滚动加载
• 多功能表格滚动加载
• 层级树大数据场景

rendertype

在表格中提供了多种rendertype可以供选择，比如下拉框，输入框，日期等

需要单独的去引用相应的js文件，目录在render文件夹，示例如下：

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	-

使用

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组件参数配置

使用

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组件参数配置

使用

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组件参数配置

使用

import renderCheckbox from "tinper-bee/lib/CheckboxRender.js";
import { Icon, Checkbox } from 'tinper-bee';
const CheckboxRender = renderCheckbox(Checkbox, Icon);

快捷键API

快捷键	快捷键说明	类型	默认值
focusable	是否开启快捷键功能	bool	false
onKeyTab	tab快捷键，可以处理默认选中第一条数据	function	() => {}
onKeyUp	↑(上箭) 快捷键，可以处理table的上一条数据	function	() => {}
onKeyDown	↓(下箭)快捷键，可以处理table的下一条数据	function	() => {}
onTableKeyDown	触发table的所有快捷键	function	() => {}
tabIndex	设置焦点顺序	number	0

注意事项

• 如果使用了固定列，请给固定的列设定固定宽度既width属性。

• 在使用expandedRowRender属性扩展表格时，如果同时使用了固定列。 需要给expandedRowRender中返回的对象添加style=\{{height: xxx}\},来使扩展后的固定列扩展成一样高度。

当表格场景比较复杂时，可以使用复杂表格ComplexGrid。ComplexGrid将常用的过滤、多选、分页、列交换、列拖拽等功能集成在一起。使用起来超级方便。

更新日志