mirror of
https://github.com/gosticks/react-bootstrap-table2.git
synced 2025-10-16 11:55:39 +00:00
53 lines
2.4 KiB
Markdown
53 lines
2.4 KiB
Markdown
# react-bootstrap-table2
|
|
|
|
[](https://travis-ci.org/react-bootstrap-table/react-bootstrap-table2)
|
|
Rebuild of [react-bootstrap-table](https://github.com/AllenFang/react-bootstrap-table)
|
|
|
|
> Note that `react-bootstrap-table2`'s npm module name is [**`react-bootstrap-table-next`**](https://www.npmjs.com/package/react-bootstrap-table-next) due to the name being already taken.
|
|
|
|
`react-bootstrap-table2` separates some functionalities from its core modules to other modules as listed in the following:
|
|
|
|
- [`react-bootstrap-table-next`](https://www.npmjs.com/package/react-bootstrap-table-next)
|
|
- [`react-bootstrap-table2-filter`](https://www.npmjs.com/package/react-bootstrap-table2-filter)
|
|
- [`react-bootstrap-table2-editor`](https://www.npmjs.com/package/react-bootstrap-table2-editor)
|
|
- [`react-bootstrap-table2-paginator`](https://www.npmjs.com/package/react-bootstrap-table2-paginator)
|
|
- [`react-bootstrap-table2-overlay`](https://www.npmjs.com/package/react-bootstrap-table2-overlay)
|
|
- [`react-bootstrap-table2-toolkit`](https://www.npmjs.com/package/react-bootstrap-table2-toolkit)
|
|
|
|
Not only does this reduce the bundle size of your apps but also helps us have a cleaner design to avoid handling too much logic in the kernel module(SRP).
|
|
|
|
## Migration
|
|
|
|
If you are coming from the legacy [`react-bootstrap-table`](https://github.com/AllenFang/react-bootstrap-table/), please check out the [migration guide](./docs/migration.md).
|
|
|
|
## Usage
|
|
|
|
See [getting started](https://react-bootstrap-table.github.io/react-bootstrap-table2/docs/getting-started.html).
|
|
|
|
## Online Demo
|
|
|
|
See `react-bootstrap-table2` [storybook](https://react-bootstrap-table.github.io/react-bootstrap-table2/storybook/index.html).
|
|
|
|
## Development
|
|
|
|
Please check the [development guide](./docs/development.md).
|
|
|
|
## Running storybook example on your local machine
|
|
|
|
```sh
|
|
# Clone the repo
|
|
$ git clone https://github.com/react-bootstrap-table/react-bootstrap-table2.git
|
|
|
|
# change dir to the cloned repo
|
|
$ cd react-bootstrap-table2
|
|
|
|
# Install all dependencies with yarn
|
|
$ yarn install
|
|
|
|
# Start the stroybook server, then go to localhost:6006
|
|
$ yarn storybook
|
|
|
|
```
|
|
|
|
**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)**
|