GitHub
/
ant-design
6
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

docs: update Table english doc (#7432) 

Fixed numerous typos
pull/7438/head
Khalifa Lame 7 years ago
committed by Benjy Cui
parent
319fa7c82d
commit
99a998afb5
1 changed files with 17 additions and 17 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 34
      components/table/index.en-US.md

34
components/table/index.en-US.md
View File

@ -14,7 +14,7 @@ A table displays rows data.
## How To Use ## How To Use
Specify `dataSource` of Table whose value is an array of data. Specify `dataSource` of Table as an array of data.
```jsx ```jsx
const dataSource = [{ const dataSource = [{
@ -53,11 +53,11 @@ const columns = [{
| Property | Description | Type | Default | | Property | Description | Type | Default |
|---------------|--------------------------|-----------------|--------------| |---------------|--------------------------|-----------------|--------------|
| rowSelection | row selection [config](#rowSelection) | object | null | | rowSelection | row selection [config](#rowSelection) | object | null |
| pagination | pagination [config](/components/pagination/), hide it via setting to `false` | object | | | pagination | pagination [config](/components/pagination/), hide it by setting it to `false` | object | |
| size | size of table: `default`, `middle` or `small` | string | `default` | | size | size of table: `default`, `middle` or `small` | string | `default` |
| dataSource | data record array to be rendered | any[] | | | dataSource | data record array to be rendered | any[] | |
| columns | columns of table | [ColumnProps](https://git.io/vMMXC)[] | - | | columns | columns of table | [ColumnProps](https://git.io/vMMXC)[] | - |
| rowKey | get row's key, could be a string or function | string\|Function(record):string | 'key' | | rowKey | get row's key, could be a string or function that returns a string | string\|Function(record):string | 'key' |
| rowClassName | get row's className | Function(record, index):string | - | | rowClassName | get row's className | Function(record, index):string | - |
| expandedRowRender | expanded container render for each row | Function | - | | expandedRowRender | expanded container render for each row | Function | - |
| defaultExpandedRowKeys | initial expanded row keys | string[] | - | | defaultExpandedRowKeys | initial expanded row keys | string[] | - |
@ -68,14 +68,14 @@ const columns = [{
| onChange | callback that is called when pagination, filters, sorter is changed | Function(pagination, filters, sorter) | | | onChange | callback that is called when pagination, filters, sorter is changed | Function(pagination, filters, sorter) | |
| loading | loading status of table | boolean\|[object](https://ant.design/components/spin-cn/#API) ([more](https://github.com/ant-design/ant-design/issues/4544#issuecomment-271533135)) | false | | loading | loading status of table | boolean\|[object](https://ant.design/components/spin-cn/#API) ([more](https://github.com/ant-design/ant-design/issues/4544#issuecomment-271533135)) | false |
| locale | i18n text include filter, sort, empty text...etc | object | filterConfirm: 'Ok' <br> filterReset: 'Reset' <br> emptyText: 'No Data' <br> [Default](https://github.com/ant-design/ant-design/issues/575#issuecomment-159169511) | | locale | i18n text include filter, sort, empty text...etc | object | filterConfirm: 'Ok' <br> filterReset: 'Reset' <br> emptyText: 'No Data' <br> [Default](https://github.com/ant-design/ant-design/issues/575#issuecomment-159169511) |
| indentSize | index pixel size of tree data | number | 15 | | indentSize | indent size in pixels of tree data | number | 15 |
| onRowClick | callback that is called when click a row | Function(record, index, event) | - | | onRowClick | callback that is called when a row is clicked | Function(record, index, event) | - |
| onRowDoubleClick| callback that is called when double click a row | Function(record, index, event) | - | | onRowDoubleClick| callback that is called when a row is double clicked | Function(record, index, event) | - |
| bordered | whether to show table border completely | boolean | false | | bordered | whether to show all table borders | boolean | false |
| showHeader | whether to show table header | boolean | true | | showHeader | whether to show table header | boolean | true |
| footer | table footer renderer | Function(currentPageData) | | | footer | table footer renderer | Function(currentPageData) | |
| title | table title renderer | Function(currentPageData) | | | title | table title renderer | Function(currentPageData) | |
| scroll | whether table can be scroll in x/y direction, `x` or `y` can be a number that indicated the width and height of table body | object | - | | scroll | whether table can be scroll in x/y direction, `x` or `y` can be a number that indicates the width and height of table body | object | - |
### Column ### Column
@ -86,9 +86,9 @@ One of Property `columns` for describing column, Column has the same API.
| title | title of this column | string\|ReactNode | - | | title | title of this column | string\|ReactNode | - |
| key | key of this column, you can ignore this prop if you've set a unique `dataIndex` | string | - | | key | key of this column, you can ignore this prop if you've set a unique `dataIndex` | string | - |
| dataIndex | display field of the data record, could be set like `a.b.c` | string | - | | dataIndex | display field of the data record, could be set like `a.b.c` | string | - |
| render | renderer of table cell, has three params: text, record and index of this row. The render value should be a ReactNode, or a object for [colSpan/rowSpan config](#components-table-demo-colspan-rowspan) | Function(text, record, index) {} | - | | render | renderer of table cell, has three params: text, record and index of this row. The render value should be a ReactNode, or an object for [colSpan/rowSpan config](#components-table-demo-colspan-rowspan) | Function(text, record, index) {} | - |
| filters | filter menu config | object[] | - | | filters | filter menu config | object[] | - |
| onFilter | callback that is called when when click confirm filter button | Function | - | | onFilter | callback that is called when when confirm filter button is clicked | Function | - |
| filterMultiple | whether to select multiple filtered item | boolean | true | | filterMultiple | whether to select multiple filtered item | boolean | true |
| filterDropdown | customized filter overlay | ReactNode | - | | filterDropdown | customized filter overlay | ReactNode | - |
| filterDropdownVisible | whether filterDropdown is visible | boolean | - | | filterDropdownVisible | whether filterDropdown is visible | boolean | - |
@ -96,12 +96,12 @@ One of Property `columns` for describing column, Column has the same API.
| filteredValue | controlled filtered value, filter icon will highlight. | string[] | - | | filteredValue | controlled filtered value, filter icon will highlight. | string[] | - |
| filtered | whether the dataSource is filtered | boolean | false | | filtered | whether the dataSource is filtered | boolean | false |
| filterIcon | customized filter icon | ReactNode | false | | filterIcon | customized filter icon | ReactNode | false |
| sorter | sort function for local sort, see [Array.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort)'s compareFunction. If you need sort buttons only, set it `true` | Function\|boolean | - | | sorter | sort function for local sort, see [Array.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort)'s compareFunction. If you need sort buttons only, set to `true` | Function\|boolean | - |
| colSpan | span of this column's title | number | | | colSpan | span of this column's title | number | |
| width | width of this column | string\|number | - | | width | width of this column | string\|number | - |
| className | className of this column | string | - | | className | className of this column | string | - |
| fixed | set column to be fixed: `true`(same as left) `'left'` `'right'` | boolean\|string | false | | fixed | set column to be fixed: `true`(same as left) `'left'` `'right'` | boolean\|string | false |
| sortOrder | controlled sorted value: `'ascend'` `'descend'` `false` | boolean\|string | - | | sortOrder | order of sorted values: `'ascend'` `'descend'` `false` | boolean\|string | - |
| onCellClick | callback when click cell | Function(record, event) | - | | onCellClick | callback when click cell | Function(record, event) | - |
### ColumnGroup ### ColumnGroup
@ -123,7 +123,7 @@ Properties for selection.
| onSelect | callback that is called when select/deselect one row | Function(record, selected, selectedRows) | - | | onSelect | callback that is called when select/deselect one row | Function(record, selected, selectedRows) | - |
| onSelectAll | callback that is called when select/deselect all | Function(selected, selectedRows, changeRows) | - | | onSelectAll | callback that is called when select/deselect all | Function(selected, selectedRows, changeRows) | - |
| onSelectInvert | callback that is called when select invert | Function(selectedRows) | - | | onSelectInvert | callback that is called when select invert | Function(selectedRows) | - |
| selections | custom selection [config](#rowSelection), only display default selections when set to `true` | object[]\|boolean | - | | selections | custom selection [config](#rowSelection), only displays default selections when set to `true` | object[]\|boolean | - |
| hideDefaultSelections | remove the default `Select All` and `Select invert` selections | boolean | false | | hideDefaultSelections | remove the default `Select All` and `Select invert` selections | boolean | false |
### selection ### selection
@ -131,8 +131,8 @@ Properties for selection.
| Property | Description | Type | Default | | Property | Description | Type | Default |
|---------------|--------------------------|-----------------|--------------| |---------------|--------------------------|-----------------|--------------|
| key | key of this selection | string | - | | key | key of this selection | string | - |
| text | display text is this selection | string\|React.ReactNode | - | | text | display text of this selection | string\|React.ReactNode | - |
| onSelect | callback when click this selection | Function(changeableRowKeys) | - | | onSelect | callback when this selection is clicked | Function(changeableRowKeys) | - |
## Using in TypeScript ## Using in TypeScript
@ -170,9 +170,9 @@ class NameColumn extends Table.Column<IUser> {}
## Note ## Note
According to [React documentation](https://facebook.github.io/react/docs/lists-and-keys.html#keys), every child in array should be assigned a unique key. The value inside `dataSource` and `columns` should follow this in Table, and `dataSource[i].key` would be treated as key value default for `dataSource`. According to [React documentation](https://facebook.github.io/react/docs/lists-and-keys.html#keys), every child in array should be assigned a unique key. The values inside `dataSource` and `columns` should follow this in Table, and `dataSource[i].key` would be treated as key value default for `dataSource`.
If `dataSource[i].key` is not existed, then you should specify the primary key of dataSource value via `rowKey`. If not, warnings like above will show in browser console. If `dataSource[i].key` is not provided, then you should specify the primary key of dataSource value via `rowKey`. If not, warnings like above will show in browser console.
![](https://os.alipayobjects.com/rmsportal/luLdLvhPOiRpyss.png) ![](https://os.alipayobjects.com/rmsportal/luLdLvhPOiRpyss.png)

Write Preview
Loading…
Cancel
Save