From 2aab4301dde148c23cecfdf7a9786b2e1870bbe0 Mon Sep 17 00:00:00 2001 From: AllenFang Date: Sat, 9 Mar 2019 23:01:21 +0800 Subject: [PATCH] fix #835 --- .../react-bootstrap-table2-paginator/README.md | 13 +++++++++++++ .../react-bootstrap-table2-toolkit/README.md | 17 +++++++++++++++++ 2 files changed, 30 insertions(+) diff --git a/packages/react-bootstrap-table2-paginator/README.md b/packages/react-bootstrap-table2-paginator/README.md index ede9040..e5dc52b 100644 --- a/packages/react-bootstrap-table2-paginator/README.md +++ b/packages/react-bootstrap-table2-paginator/README.md @@ -190,6 +190,19 @@ import paginationFactory, { That's it!! The benifit for using standalone is you can much easier to render the standalone component in any posistion. In the future, we will implement more featue like applying `style`, `className` etc on standalone components. +##### Customizable props for `PaginationListStandalone` +* N/A + +##### Customizable props for `SizePerPageDropdownStandalone` +* `open`: `true` to make dropdown show. +* `hidden`: `true` to hide the size per page dropdown. +* `btnContextual`: Set the button contextual +* `variation`: Variation for dropdown, available value is `dropdown` and `dropup`. +* `className`: Custom the class on size per page dropdown + +##### Customizable props for `SizePerPageDropdownStandalone` +* N/A + #### 4.2 Customization Everything If you choose to custom the pagination component by yourself, the `paginationProps` will be important for you. Becasue you have to know for example how to change page or what's the current page etc. Hence, following is all the props in `paginationProps` object: diff --git a/packages/react-bootstrap-table2-toolkit/README.md b/packages/react-bootstrap-table2-toolkit/README.md index 78fb3a0..c85accc 100644 --- a/packages/react-bootstrap-table2-toolkit/README.md +++ b/packages/react-bootstrap-table2-toolkit/README.md @@ -67,6 +67,19 @@ const { SearchBar } = Search; 3. You should render `SearchBar` with `searchProps` as well. The position of `SearchBar` is depends on you. +### `SearchBar` Props +#### className - [string] +Custom the class on input element. + +#### placeholder - [string] +Custom the placeholder on input element. + +#### style - [object] +Custom the style on input element. + +#### delay = [number] +milionsecond for debounce user input. + ### Search Options #### defaultSearch - [string] @@ -127,6 +140,8 @@ const { SearchBar, ClearSearchButton } = Search; ``` +----- + ## Export CSV There are two steps to enable the export CSV functionality: @@ -176,6 +191,8 @@ Default is `true`. `false` will only export current data which display on table. #### onlyExportSelection - [bool] Default is `false`. `true` will only export the data which is selected. +----- + ## Column Toggle Let's see how to render the column toggle in your react component: