vhad/react-bootstrap-table2
1
0
Fork 0
mirror of https://github.com/gosticks/react-bootstrap-table2.git synced 2026-08-16 21:50:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve CONTRIBUTING doc

Browse Source 
* Improve CONTRIBUTING doc

* Correct some typos and grammar errors

* Improve docs/README.md
This commit is contained in:
Joshua
2017-10-26 01:36:13 -05:00
committed by Allen
parent 985a1713ae
commit cf142d3b39
2 changed files with 24 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README.md
+12 -12
View File
@@ -1,6 +1,6 @@
# Documents
# Documentation
## Props on BootstrapTable
## BootstrapTable Props
#### Required
* [keyField (**required**)](#keyField)
@@ -17,28 +17,28 @@
* [selectRow](#selectRow)
### <a name='keyField'>keyField(**required**) - [String]</a>
`keyField` is a prop to tell `react-bootstrap-table2` which column is unigue key.
Tells `react-bootstrap-table2` which column is unique.
### <a name='data'>data(**required**) - [Array]</a>
Assign your table data via `data` prop. It only accept an Array object.
Provides data for your table. It accepts a single Array object.
### <a name='columns'>columns(**required**) - [Object]</a>
`columns` props accept an Array object, please see [columns definition](./columns.md) for more detail.
Accepts a single Array object, please see [columns definition](./columns.md) for more detail.
### <a name='caption'>caption - [String | Node]</a>
Same as [caption tag](https://www.w3schools.com/TAgs/tag_caption.asp) in HTML. You can give a String or a React JSX.
Same as HTML [caption tag](https://www.w3schools.com/TAgs/tag_caption.asp), you can set it as String or a React JSX.
### <a name='striped'>striped - [Bool]</a>
Same as `.table-striped` class for adding zebra-stripes to a table
Same as bootstrap `.table-striped` class for adding zebra-stripes to a table.
### <a name='bordered'>bordered - [Bool]</a>
Same as `.table-bordered` class for adding borders on all sides of the table and cells
Same as bootstrap `.table-bordered` class for adding borders to a table and table cells.
### <a name='hover'>hover - [Bool]</a>
Same as `.table-hover` class for adding a hover effect (grey background color) on table rows
Same as bootstrap `.table-hover` class for adding mouse hover effect (grey background color) on table rows.
### <a name='condensed'>condensed - [Bool]</a>
Same as `.table-condensed` class for makeing a table more compact by cutting cell padding in half
Same as bootstrap `.table-condensed` class for making a table more compact by cutting cell padding in half.
### <a name='cellEdit'>cellEdit - [Object]</a>
`cellEdit` allow you to enable cell editing on table, please see [cellEdit definition](./cell-edit.md) for more detail.
Makes table cells editable, please see [cellEdit definition](./cell-edit.md) for more detail.
### <a name='selectRow'>selectRow - [Object]</a>
`selectRow` allow you to have a mechanism to select rows, please see [selectRow definition](./row-selection.md) for more detail.
Makes table rows selectable, please see [selectRow definition](./row-selection.md) for more detail.