tweak docs

This commit is contained in:
AllenFang 2018-01-21 23:55:02 +08:00
parent 234a446a4f
commit ac53dfd5d1
9 changed files with 49 additions and 5 deletions

View File

@ -6,7 +6,8 @@ sidebar_label: Cell Edit
`react-bootstrap-table2` separate the cell edit code base to [`react-bootstrap-table2-editor`](https://github.com/react-bootstrap-table/react-bootstrap-table2/tree/develop/packages/react-bootstrap-table2-editor), so there's a little bit different when you use cell edit than `react-bootstrap-table`. In the following, we are going to show you how to enable the cell edit
**[Live Demo For Cell Edit](../storybook/index.html?selectedKind=Cell%20Editing)**
**[Live Demo For Cell Edit](../storybook/index.html?selectedKind=Cell%20Editing)**
**[API & Props Definition](./cell-edit-props.html)**
-----

View File

@ -7,7 +7,8 @@ sidebar_label: Work on Column
Firstly, legacy `react-bootstrap-table` is hard to customize the DOM Event, Attributes on column or header column. In the `react-bootstrap-table2`, we make those bad design become more easy and flexible.
**[Live Demo For Column](../storybook/index.html?selectedKind=Work%20on%20Columns)**
**[Live Demo For Header Column](../storybook/index.html?selectedKind=Work%20on%20Header%20Columns)**
**[Live Demo For Header Column](../storybook/index.html?selectedKind=Work%20on%20Header%20Columns)**
**[API & Props Definition](./column-props.html)**
-----

View File

@ -6,7 +6,8 @@ sidebar_label: Column Filter
`react-bootstrap-table2` separate the filter core code base to [`react-bootstrap-table2-filter`](https://github.com/react-bootstrap-table/react-bootstrap-table2/tree/develop/packages/react-bootstrap-table2-filter), so there's a little bit different when you use column filter than `react-bootstrap-table`. In the following, we are going to show you how to enable the column filter:
**[Live Demo For Column Filter](../storybook/index.html?selectedKind=Column%20Filter)**
**[Live Demo For Column Filter](../storybook/index.html?selectedKind=Column%20Filter)**
**[API & Props Definition](./filter-props.html)**
-----

View File

@ -6,7 +6,8 @@ sidebar_label: Pagination
`react-bootstrap-table2` separate the pagination code base to [`react-bootstrap-table2-pagination`](https://github.com/react-bootstrap-table/react-bootstrap-table2/tree/develop/packages/react-bootstrap-table2-paginator), so there's a little bit different when you use pagination. In the following, we are going to show you how to enable and configure the a pagination table
**[Live Demo For Pagination](../storybook/index.html?selectedKind=Pagination)**
**[Live Demo For Pagination](../storybook/index.html?selectedKind=Pagination)**
**[API & Props Definition](./pagination-props.html)**
-----

View File

@ -8,6 +8,8 @@ sidebar_label: Work on Remote
By default, `react-bootstrap-table2` always handle the data changes internally, such as sorting, paging, filtering etc. However, you may want to handle those logic or sync up to backend or Redux store so that `remote` can help you on it as well.
**[Live Demo for Remote Table](../storybook/index.html?selectedKind=Remote)**
-----
## How

View File

@ -6,7 +6,8 @@ sidebar_label: Row Selection
For the table row selection functionality, the usage is almost same as `react-bootstrap-table`. If you are a user from legacy `react-bootstrap-table`, you can consider to skip this part.
**[Live Demo For Row Selection](../storybook/index.html?selectedKind=Row%20Selection)**
**[Live Demo For Row Selection](../storybook/index.html?selectedKind=Row%20Selection)**
**[API & Props Definition](./row-select-props.html)**
-----

View File

@ -2,6 +2,19 @@
id: cell-edit-props
title: Cell Editing Props
---
Following we list all props for `cellEditFactory` from [`react-bootstrap-table2-editor`](https://www.npmjs.com/package/react-bootstrap-table2-editor).
```js
import cellEditFactory from 'react-bootstrap-table2-editor';
const cellEdit = cellEditFactory({
mode: 'click',
...
});
<BootstrapTable cellEdit={ cellEdit } ... />
```
## Required
* [mode (**required**)](#celleditmode-string)

View File

@ -3,6 +3,19 @@ id: pagination-props
title: Pagination Props
---
Following we list all props for `paginationFactory` from [`react-bootstrap-table2-paginator`](https://www.npmjs.com/package/react-bootstrap-table2-paginator).
```js
import paginationFactory from 'react-bootstrap-table2-paginator';
const pagination = paginationFactory({
page: 2,
...
});
<BootstrapTable pagination={ pagination } ... />
```
## Required
**NONE**

View File

@ -3,6 +3,17 @@ id: row-select-props
title: Row Selection Props
---
Following we list all props for [`selectRow` props](./table-props.html#selectrow-object)
```js
const selectRow = {
mode: 'checkbox',
...
});
<BootstrapTable selectRow={ selectRow } ... />
```
## Required
* [mode (**required**)](#selectrowmode-string)