doc(data-table): refine some descriptions

This commit is contained in:
07akioni 2020-03-27 17:48:05 +08:00
parent 68424055d5
commit b20061c878
2 changed files with 9 additions and 9 deletions

View File

@ -55,8 +55,8 @@ These methods can help you control table in an uncontrolled manner. However, it'
|Name|Type|Description|
|-|-|-|
|filters|`(filters: { [string \| number]: Array<string \| number> }) => void`|Key is the key of the column, value is the filterOptionValues.|
|sort|`(columnKey: string \| null, order: 'ascend' \| 'descend' \| false) => void`|If columnKey set to `null`, it is same as clearSorter|
|filters|`(filters: { [string \| number]: Array<string \| number> }) => void`|Set the active filters of the table.|
|sort|`(columnKey: string \| null, order: 'ascend' \| 'descend' \| false) => void`|If columnKey set to `null`, it is the same as clearSorter.|
|page|`(page: number) => void`||
|clearFilters|`() => void`||
|clearSorter|`() => void`||
@ -65,15 +65,15 @@ These methods can help you control table in an uncontrolled manner. However, it'
## Events
|Name|Parameters|Description|
|-|-|-|
|filters-change|`(filters: { [string \| number]: Array<string \| number> }, initiatorColumn: object)`||
|filters-change|`(filters: { [string \| number]: Array<string \| number> }, initiatorColumn: Column)`||
|sorter-change|`({ columnKey: string \| number, sorter: 'default' \| function \| boolean, order: 'ascend' \| 'descend' \| false } \| null)`|If there won't be a active sorter after change, sorter-change will emit `null`|
|page-change|`(page: number)`||
|page-size-change|`(pageSize: number)`||
|checked-row-keys-change|`(keys: Array<string \| number>)`||
## API
### Column
|Property|Type|Default|Description|
### Column Properties
|Name|Type|Default|Description|
|-|-|-|-|
|render|`(h, rowData: object) => VNode \| Array<VNode>`|`null`|Render function of column row cell|
|type|`'default' \| 'selection'`|`default`||

View File

@ -55,7 +55,7 @@ ajaxUsage
|名称|参数|说明|
|-|-|-|
|filters|`(filters: { [string \| number]: Array<string \| number> }) => void`| Key 是列的 key, value 是 filterOptionValues.|
|filters|`(filters: { [string \| number]: Array<string \| number> }) => void`|设定表格当前的过滤器|
|sort|`(columnKey: string \| null, order: 'ascend' \| 'descend' \| false) => void`|如果 columnKey 设为 `null`,那它和 clearSorter 效果一致|
|page|`(page: number) => void`||
|clearFilters|`() => void`||
@ -65,15 +65,15 @@ ajaxUsage
## Events
|名称|参数|说明|
|-|-|-|
|filters-change|`(filters: { [string \| number]: Array<string \| number> }, initiatorColumn: object)`||
|filters-change|`(filters: { [string \| number]: Array<string \| number> }, initiatorColumn: Column)`||
|sorter-change|`({ columnKey: string \| number, sorter: 'default' \| function \| boolean, order: 'ascend' \| 'descend' \| false } \| null)`|如果在变动后没有激活的排序,那么 sorter-change 将发出 `null`|
|page-change|`(page: number)`||
|page-size-change|`(pageSize: number)`||
|checked-row-keys-change|`(keys: Array<string \| number>)`||
## API
### Column Type
|属性|类型|默认值|说明|
### Column Properties
|名称|类型|默认值|说明|
|-|-|-|-|
|render|`(h, rowData: object) => VNode \| Array<VNode>`|`null`|渲染函数,渲染这一列的每一行的单元格|
|type|`'default' \| 'selection'`|`default`||