|
1 | 1 | # react-bootstrap-table2 |
2 | 2 | Rebuilt [react-bootstrap-table](https://github.com/AllenFang/react-bootstrap-table) |
3 | 3 |
|
4 | | -## The problems/features I want to solve |
5 | | -* Performance |
6 | | -* Fully compatiable with bootstrap 3 and 4(`react-bootstrap-table@4.0.0` already done) |
7 | | -* Clean Code and Testing |
8 | | -* Decrease the size of bundled file |
9 | | -* **Split module/functionality from core module, make core module more lightweight** |
10 | | -* Use [`storybook`](https://github.com/storybooks/storybook) to build examples |
11 | | -* Support the aggregation(summary) view |
12 | | -* Support the table footer |
13 | | -* Support column/row span on header and body |
14 | | -* Support sticky header |
15 | | -* Support table section([react-bootstrap-table#721](https://github.com/AllenFang/react-bootstrap-table/pull/721)) |
16 | | -* Handle events well |
17 | | -* Fix unalign issues |
18 | | -* Make **stateless** table more easy to use(`react-bootstrap-table` alread have `remote` mode but have some bugs) |
19 | | -* Customizable table |
20 | | -* Support the nested data([react-bootstrap-table#50](https://github.com/AllenFang/react-bootstrap-table/issues/50◊)) |
21 | | -* Consider to support column resize |
22 | | -* Consider to make animation on `react-bootstrap-table2` more easy |
23 | | - |
24 | | -## The feature may lost on react-bootstrap-table |
25 | | -* Have a great chance that I don't support the vertical scrollbar on table |
| 4 | +> `react-bootstrap-table2`'s npm module name is [**`react-bootstrap-table-next`**](https://www.npmjs.com/package/react-bootstrap-table-next) due to some guys already used it ;( |
| 5 | +
|
| 6 | +`react-bootstrap-table2` separate some functionalities from core modules to other modules like following: |
| 7 | + |
| 8 | +* [`react-bootstrap-table2-next`](https://www.npmjs.com/package/react-bootstrap-table-next) |
| 9 | + * Core table module, include sorting and row selection |
| 10 | +* [`react-bootstrap-table2-filter`](https://www.npmjs.com/package/react-bootstrap-table2-filter) |
| 11 | + * Column filter Addons |
| 12 | +* [`react-bootstrap-table2-editor`](https://www.npmjs.com/package/react-bootstrap-table2-editor) |
| 13 | + * Cell Editing Addons |
| 14 | +* [`react-bootstrap-table2-paginator`](https://www.npmjs.com/package/react-bootstrap-table2-paginator) |
| 15 | + * Pagination Addons |
| 16 | +* [`react-bootstrap-z-overlay`](https://www.npmjs.com/package/react-bootstrap-table2-overlay) |
| 17 | + * Overlay/Loading Addons |
| 18 | + |
| 19 | +This can help your application with less bundled size and also help us have clean design to avoid handling to much logic in kernal module(SRP). |
| 20 | + |
| 21 | +## Migration |
| 22 | +If you are the user from legacy [`react-bootstrap-table`](https://github.com/AllenFang/react-bootstrap-table/), please have a look on [this](./docs/migration.md). |
| 23 | + |
| 24 | +## Usage |
| 25 | +See [getting started](https://react-bootstrap-table.github.io/react-bootstrap-table2/docs/getting-started.html). |
| 26 | + |
| 27 | +## Online Demo |
| 28 | +See `react-bootstrap-table2` [storybook](https://react-bootstrap-table.github.io/react-bootstrap-table2/storybook/index.html). |
| 29 | + |
| 30 | +## Roadmap |
| 31 | +See [release plans](https://react-bootstrap-table.github.io/react-bootstrap-table2/blog/2018/01/24/release-plan.html). |
| 32 | + |
| 33 | +## Development |
| 34 | +Please check [development guide](./docs/development.md). |
| 35 | + |
| 36 | +## How should I run storybook example in my local? |
| 37 | + |
| 38 | +```sh |
| 39 | +$ git clone https://github.com/react-bootstrap-table/react-bootstrap-table2.git |
| 40 | +$ cd react-bootstrap-table2 |
| 41 | +$ yarn install |
| 42 | +$ yarn storybook |
| 43 | +$ Go to localhost:6006 |
| 44 | +``` |
| 45 | + |
| 46 | +**Storybook examples: [`packages/react-bootstrap-table2-example/examples`](https://github.com/react-bootstrap-table/react-bootstrap-table2/tree/master/packages/react-bootstrap-table2-example/examples)** |
0 commit comments