更新api文档

This commit is contained in:
huayj 2019-08-26 14:52:12 +08:00
parent 9b727449d9
commit cdc19d51c0
1 changed files with 50 additions and 3 deletions

View File

@ -127,10 +127,57 @@ import 'bee-table/build/Table.css';
| 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 |
| textAlign | 对齐方式,默认是左对齐('left、right、center' | string |
| $\color{red}{*}$sortEnable | 开启默认排序,根据fieldType属性确定排序规则默认按字符串排序;优先级低于sorter属性 | bool | false |
| $\color{red}{*}$linkConfig | 链接信息fieldType为link时可用;自定义render时无效 | object | null |
| $\color{red}{*}$fieldType | 列类型,可选`number`,`link` | string | null |
| $\color{red}{*}$fieldType | 列类型,可选`string`,`number`,`currency`,`bool`,`link` | string | 'string' |
| $\color{red}{*}$fontColor | 列文本颜色 | string | - |
| $\color{red}{*}$bgColor | 列背景颜色 | string | - |
| $\color{red}{*}$titleAlign | 标题对齐方式 | 'left'\|'center'\|'right' | 'left' |
| $\color{red}{*}$contentAlign | 内容对齐方式 | 'left'\|'center'\|'right' | 'left' |
| $\color{red}{*}$required | 必填项,展示红色星号 | bool | false |
#### [新增]fieldType
fieldType属性控制了不同类型数据的渲染方式,其优先级低于render属性。目前已有`string`,`number`,`currency`,`bool`,`link`类型,支持自定义配置。
- 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优先级更高*
### 高阶函数
Table内部封装了七个高阶组件接收基础 Table 组件作为输入,输出一个新的复杂 Table 组件。高阶组件让代码更具有复用性、逻辑性与抽象特征。