Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/AllenFang/react-bootstrap-table

A Bootstrap table built with React.js
https://github.com/AllenFang/react-bootstrap-table

bootstrap-table react react-table table

Last synced: 3 months ago
JSON representation

A Bootstrap table built with React.js

Lists

README 

        
# react-bootstrap-table



## [`react-bootstrap-table2`](https://github.com/react-bootstrap-table/react-bootstrap-table2) already released, this project will stop development after 2018Q2



[![Join the chat at https://gitter.im/AllenFang/react-bootstrap-table](https://badges.gitter.im/AllenFang/react-bootstrap-table.svg)](https://gitter.im/AllenFang/react-bootstrap-table?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)



[![NPM version][npm-badge]][npm] [![Build Status][travis-ci-image]][travis-ci-url]



[![Dependency Status][deps-badge]][deps]

[![devDependency Status][dev-deps-badge]][dev-deps]

[![peerDependency Status][peer-deps-badge]][peer-deps]   

It's a [react.js](http://facebook.github.io/react/) table for bootstrap, named react-bootstrap-table. It's a configurable, functional table component and make you build a Bootstrap Table more efficiency and easy in your React application, However ```react-bootstrap-table``` support these features:



- Striped, borderless, condensed table

- Column align, hidden, width, sort, title, styling, customization

- Table scrolling

- Cell format

- Pagination

- Row selection

- Table Search, Column filter

- Cell editor

- Insert & delete Row

- Export to CSV

- Rich function hooks

- Header column span

- Remote mode

- Row expand

- Key board navigation



![Example](http://i.imgur.com/Ov1wMse.png)

See more about [react-bootstrap-table](http://allenfang.github.io/react-bootstrap-table/index.html) and explore more examples on [examples](https://github.com/AllenFang/react-bootstrap-table/tree/master/examples/js) folder

Check the CHANGELOG for more detail release notes.



## Notes



***`v4.0.0` released, this release mainly replace `react-toastr` with `react-s-alert`***

1. Replace `react-toastr` by `react-s-alert`

2. Use `prop-types`

3. Support `bootstrap@4` and `bootstrap@3` both. If you use 4, please add `version='4'` on ``

4. No important features were implemented, most of bug fixes and improvement



***After ```v2.4.4```, we move the css files to ```dist``` folder for allowing this repo can be hosted on [cdnjs](https://github.com/cdnjs/cdnjs)
***



## Development

```react-bootstrap-table``` dependencies on react.js and Bootstrap 3, also written by ES6 and use gulp and browserify for building and bundling.



You can use the following commands to prepare development

```bash

$ git clone https://github.com/AllenFang/react-bootstrap-table.git

$ cd react-bootstrap-table

$ npm install

```

See the examples for `react-bootstrap-table`

```bash

$ npm start # see all examples, go to localhost:3004

```



## Usage

### a.Install

```bash

npm install react-bootstrap-table --save

```



### b.Import Module

To use react-bootstrap-table in your react app, you should import it first.

You can do this in two ways:



##### With a module bundler

With a module bundler like [webpack](https://webpack.github.io/) that supports either CommonJS or ES2015 modules, use as you would anything else.  

You can include source maps on your build system to debug on development. Don't forget to Uglify on production.



```js

// in ECMAScript 6

import { BootstrapTable, TableHeaderColumn } from 'react-bootstrap-table';

// or in ECMAScript 5

var ReactBSTable = require('react-bootstrap-table');  

var BootstrapTable = ReactBSTable.BootstrapTable;

var TableHeaderColumn = ReactBSTable.TableHeaderColumn;

```

##### Browser global(window object)

In the `dist` folder you have a UMD bundle with source maps (`react-bootstrap-table.js`) as well as a minified version (`react-bootstrap-table.min.js`).



```html



  var ReactBsTable = window.BootstrapTable;

  //...



```



The UMD build is also available on [npmcdn](https://npmcdn.com):



```html

// source maps: https://npmcdn.com/react-bootstrap-table/dist/react-bootstrap-table.js.map



// or use the min version



```



### c.Import CSS

Finally, you need to import the css file to your app:

```html



```

The CSS files you can find in the css folder.



### Quick Demo

```js

// products will be presented by react-bootstrap-table

var products = [{

      id: 1,

      name: "Item name 1",

      price: 100

  },{

      id: 2,

      name: "Item name 2",

      price: 100

  },........];

// It's a data format example.

function priceFormatter(cell, row){

  return ' ' + cell;

}



React.render(

  

      Product ID

      Product Name

      Product Price

  ,

	document.getElementById("app")

);

```

### More react-bootstrap-table examples

The example source codes are in the [examples folder](https://github.com/AllenFang/react-bootstrap-table/tree/master/examples) folder. Run  the following commands for a live demo.

```bash

$ git clone https://github.com/AllenFang/react-bootstrap-table.git

$ cd react-bootstrap-table

$ npm install

$ npm start # after start, open browser and go to http://localhost:3004

```



### [Documentation](http://allenfang.github.io/react-bootstrap-table/docs.html)



### Thanks

**[luqin](https://github.com/luqin)**  

Help this project to integrate a better examples demo, add travis & badge, code formatting, give a lot of suggestions and bugs report.   

**[Whien](https://github.com/madeinfree)**  

Implement a lots of awesome new feature and also fix some bugs and enhancements.   

**[Parth Prajapati](https://github.com/prajapati-parth)**  

Help to check issues and give great and useful instructions.   

**[khinlatt](https://github.com/khinlatt)**  

Contribute export csv, multi-search and bug fixing.  

**[dana](https://github.com/dana2208)**  

Contribute a new colum-filter design and great feedback given.  

**[tbaeg](https://github.com/tbaeg)**  

Bugs report and give some bootstrap and css suggestions actively.  

**[bluedarker](https://github.com/bluedarker)**  

Contribute the edit format & validation on cell editing and row insertion. Improve the custom styling.  

**[Sofia Silva](https://github.com/staminaloops)**  

Bug reports and fixing actively.  

**[frontsideair](https://github.com/frontsideair)**  

Fixing bugs and give improvement for functionality.  

**[aaronhayes](https://github.com/aaronhayes)**  

Bugs report and enhance the cell formatting.  

**[Reggino](https://github.com/Reggino)**  

Implement the TableDataSet component.  



[npm-badge]: http://badge.fury.io/js/react-bootstrap-table.svg

[npm]: http://badge.fury.io/js/react-bootstrap-table



[deps-badge]: https://david-dm.org/AllenFang/react-bootstrap-table.svg

[deps]: https://david-dm.org/AllenFang/react-bootstrap-table



[dev-deps-badge]: https://david-dm.org/AllenFang/react-bootstrap-table/dev-status.svg

[dev-deps]: https://david-dm.org/AllenFang/react-bootstrap-table#info=devDependencies



[peer-deps-badge]: https://david-dm.org/AllenFang/react-bootstrap-table/peer-status.svg

[peer-deps]: https://david-dm.org/AllenFang/react-bootstrap-table#info=peerDependencies



[travis-ci-image]: https://travis-ci.org/AllenFang/react-bootstrap-table.svg

[travis-ci-url]: https://travis-ci.org/AllenFang/react-bootstrap-table