innov
/
bee-table
1
0
Fork 0
Code Issues Pull Requests 3 Projects Releases Wiki Activity

修改api文档

This commit is contained in:
huayj 2019-08-26 17:19:59 +08:00
parent e14f1135c9
commit f516bf2147
1 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/api.md
View File

@ -80,7 +80,7 @@ import 'bee-table/build/Table.css';
| bodyDisplayInRow | 设置表体的内容显示一行，超出显示省略号 | bool | | bodyDisplayInRow | 设置表体的内容显示一行，超出显示省略号 | bool |
| size | 表格大小 | `sm / md / lg` | 'md' | | size | 表格大小 | `sm / md / lg` | 'md' |
| hideHeaderScroll | 表体无数据时，表头下是否显示滚动条，默认显示 | bool | false | | hideHeaderScroll | 表体无数据时，表头下是否显示滚动条，默认显示 | bool | false |
| $\color{red}{*}$showRowNum | 展示序号功能，false时不展示，true时展示默认情况，可传入自定义配置信息 | bool / obj:{name: '序号', key: '_index', // 在数据中存储的key值width: 50,base: 0,// 排序的基准值,为数字或者字母type:'number', // 排序类型,默认为number类型,支持单字母排序(type='ascii')} | false | | [v2.2.2新增]showRowNum | 展示序号功能，false时不展示，true时展示默认情况，可传入自定义配置信息 | bool / obj:{name: '序号', key: '_index', // 在数据中存储的key值width: 50,base: 0,// 排序的基准值,为数字或者字母type:'number', // 排序类型,默认为number类型,支持单字母排序(type='ascii')} | false |
> 快捷键部分参考示例 (快捷键在table中的简单使用应用) > 快捷键部分参考示例 (快捷键在table中的简单使用应用)
@ -127,20 +127,18 @@ import 'bee-table/build/Table.css';
| filterDropdownType | 下拉条件类型，分为 string 和 number 条件类型 | string | string | filterDropdownType | 下拉条件类型，分为 string 和 number 条件类型 | string | string
| filterDropdownIncludeKeys | 能够设置指定的下拉条件项，通过设置keys 其中string条件可设置:LIKE,ULIKE,EQ,UEQ,START,END.number条件可设置:GT,GTEQ,LT,LTEQ,EQ,UEQ | array | [] 不设置此属性为显示所有 | filterDropdownIncludeKeys | 能够设置指定的下拉条件项，通过设置keys 其中string条件可设置:LIKE,ULIKE,EQ,UEQ,START,END.number条件可设置:GT,GTEQ,LT,LTEQ,EQ,UEQ | array | [] 不设置此属性为显示所有
| filterInputNumberOptions | 数值框接收的props，具体属性参考bee-input-number | object | null | filterInputNumberOptions | 数值框接收的props，具体属性参考bee-input-number | object | null
<<<<<<< HEAD
| textAlign | 内容对齐方式，默认是左对齐（'left、right、center'） | string | | textAlign | 内容对齐方式，默认是左对齐（'left、right、center'） | string |
| mergeEndIndex | 大数据量滚动加载场景，合并表格行时，设置合并结束位置的行 index 值，设置在列 render 函数中的 props 属性上 | Number | | mergeEndIndex | 大数据量滚动加载场景，合并表格行时，设置合并结束位置的行 index 值，设置在列 render 函数中的 props 属性上 | Number |
=======
| textAlign | 列对齐方式，默认是左对齐（'left、right、center'） | string | | textAlign | 列对齐方式，默认是左对齐（'left、right、center'） | string |
| $\color{red}{*}$sortEnable | 开启默认排序,根据fieldType属性确定排序规则，默认按字符串排序;优先级低于sorter属性;需配合高阶函数`multiSelect`使用 | bool | false | | [v2.2.2新增]sortEnable | 开启默认排序,根据fieldType属性确定排序规则，默认按字符串排序;优先级低于sorter属性;需配合高阶函数`multiSelect`使用 | bool | false |
| $\color{red}{*}$fieldType | 列类型，可选`string`,`number`,`currency`,`bool`,`link` | string | 'string' | | [v2.2.2新增]fieldType | 列类型，可选`string`,`number`,`currency`,`bool`,`link` | string | 'string' |
| $\color{red}{*}$fontColor | 列文本颜色 | string | - | | [v2.2.2新增]fontColor | 列文本颜色 | string | - |
| $\color{red}{*}$bgColor | 列背景颜色 | string | - | | [v2.2.2新增]bgColor | 列背景颜色 | string | - |
| $\color{red}{*}$titleAlign | 标题对齐方式 | 'left'\|'center'\|'right' | 'left' | | [v2.2.2新增]titleAlign | 标题对齐方式 | 'left'\|'center'\|'right' | 'left' |
| $\color{red}{*}$contentAlign | 内容对齐方式 | 'left'\|'center'\|'right' | 'left' | | [v2.2.2新增]contentAlign | 内容对齐方式 | 'left'\|'center'\|'right' | 'left' |
| $\color{red}{*}$required | 必填项,列标题展示红色星号 | bool | false | | [v2.2.2新增]required | 必填项,列标题展示红色星号 | bool | false |
#### [新增]fieldType #### [v2.2.2新增]fieldType
fieldType属性控制了不同类型数据的渲染方式,其优先级低于render属性。目前，已有`string`,`number`,`currency`,`bool`,`link`,`date`类型，支持自定义配置(`string`类型为默认类型)。 fieldType属性控制了不同类型数据的渲染方式,其优先级低于render属性。目前，已有`string`,`number`,`currency`,`bool`,`link`,`date`类型，支持自定义配置(`string`类型为默认类型)。
@ -192,7 +190,6 @@ fieldType属性控制了不同类型数据的渲染方式,其优先级低于rend
|:--|:---|:--|:---| |:--|:---|:--|:---|
|moment|传入的moment对象,必需|object|-| |moment|传入的moment对象,必需|object|-|
|format|渲染的时间格式|string|'YYYY-MM-DD'| |format|渲染的时间格式|string|'YYYY-MM-DD'|
>>>>>>> dev4iuap5.0
*需要单独安装[moment.js](http://momentjs.cn/),并将moment对象传入* *需要单独安装[moment.js](http://momentjs.cn/),并将moment对象传入*