diff --git a/docs/README.md b/docs/README.md index dc9b54d..2178334 100644 --- a/docs/README.md +++ b/docs/README.md @@ -9,6 +9,7 @@ #### Optional * [remote](#remote) +* [loading](#loading) * [caption](#caption) * [striped](#striped) * [bordered](#bordered) @@ -46,6 +47,33 @@ In above case, only pagination will be handled on remote. > Note: when remote is enable, you are suppose to give [`onTableChange`](#onTableChange) prop on `BootstrapTable` > It's the only way to communicate to your remote server and update table states. +### loading - [Bool] +Telling if table is loading or not, for example: waiting data loading, filtering etc. It's **only** valid when [`remote`](#remote) is enabled. +When `loading` is `true`, `react-bootstrap-table` will attend to render a overlay on table via [`overlay`](#overlay) prop, if [`overlay`](#overlay) prop is not given, `react-bootstrap-table` will ignore the overlay rendering. + +### overlay - [Function] +`overlay` accept a factory funtion which should returning a higher order component. By default, `react-bootstrap-table-overlay` can be a good option for you: + +```sh +$ npm install react-bootstrap-table-overlay +``` +```js +import overlayFactory from 'react-bootstrap-table-overlay'; + + +``` + +Actually, `react-bootstrap-table-overlay` is depends on [`react-loading-overlay`](https://github.com/derrickpelletier/react-loading-overlay) and `overlayFactory` just a factory function and you can pass any props which available for `react-loading-overlay`: + +```js +overlay={ overlayFactory({ spinner: true, background: 'rgba(192,192,192,0.3)' }) } +``` + ### caption - [String | Node] Same as HTML [caption tag](https://www.w3schools.com/TAgs/tag_caption.asp), you can set it as String or a React JSX.