UNPKG

6.8 kBMarkdownView Raw
1# [Bootstrap Table](https://bootstrap-table.com)
2
3[![Build Status](https://travis-ci.org/wenzhixin/bootstrap-table.svg)](https://travis-ci.org/wenzhixin/bootstrap-table)
4[![GitHub version](https://badge.fury.io/gh/wenzhixin%2Fbootstrap-table.svg)](http://badge.fury.io/gh/wenzhixin%2Fbootstrap-table)
5[![Bower version](https://badge.fury.io/bo/bootstrap-table.svg)](http://badge.fury.io/bo/bootstrap-table)
6[![jsDelivr Hits](https://data.jsdelivr.com/v1/package/npm/bootstrap-table/badge?style=rounded)](https://www.jsdelivr.com/package/npm/bootstrap-table)
7[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZDHP676FQDUT6)
8[![Backers on Open Collective](https://opencollective.com/bootstrap-table/backers/badge.svg)](#backers)
9[![Sponsors on Open Collective](https://opencollective.com/bootstrap-table/sponsors/badge.svg)](#sponsors)
10
11[![](https://graphs.waffle.io/wenzhixin/bootstrap-table/throughput.svg)](https://graphs.waffle.io/wenzhixin/bootstrap-table/throughput.svg)
12
13An extended Bootstrap table with radio, checkbox, sort, pagination, extensions and other added features.
14
15To get started, check out:
16
17* [Docs](https://bootstrap-table.com)
18* [Examples](https://github.com/wenzhixin/bootstrap-table-examples)
19* [Questions/Helps](http://stackoverflow.com/questions/tagged/bootstrap-table)
20* [问题/帮助](http://segmentfault.com/t/bootstrap-table)
21
22
23[**List of donators**](https://github.com/wenzhixin/bootstrap-table/blob/master/DONATORS.md)
24
25## LICENSE
26
27**NOTE:** Bootstrap Table is licensed under [The MIT License](https://github.com/wenzhixin/bootstrap-table/blob/master/LICENSE). Completely free, you can arbitrarily use and modify this plugin. If this plugin is useful to you, you can **Star** this repo, your support is my biggest motive force, thanks.
28
29## Features
30
31* Created for Twitter Bootstrap (All versions supported)
32* Responsive web design
33* Scrollable Table with fixed headers
34* Fully configurable
35* Via data attributes
36* Show/Hide columns
37* Show/Hide headers
38* Show/Hide footers
39* Get data in JSON format using AJAX
40* Simple column sorting with a click
41* Format column
42* Single or multiple row selection
43* Powerful pagination
44* Card view
45* Detail view
46* Localization
47* Extensions
48
49## How to get it
50
51### Manual download
52
53Use [Releases page](https://github.com/wenzhixin/bootstrap-table/releases) or [the source](https://github.com/wenzhixin/bootstrap-table/archive/master.zip).
54
55### Bower
56
57```
58bower install bootstrap-table
59```
60
61### Npm
62
63```
64npm install bootstrap-table
65```
66
67### CDN
68
69You can source bootstrap-table directly from a CDN like [CDNJS](http://www.cdnjs.com/libraries/bootstrap-table) or [bootcss](http://open.bootcss.com/bootstrap-table/) or [jsdelivr](http://www.jsdelivr.com/#!bootstrap.table).
70
71
72## Contributing
73
74For feature requests, bug reports or submitting pull requests, please ensure you first read [CONTRIBUTING.md](https://github.com/wenzhixin/bootstrap-table/blob/master/CONTRIBUTING.md).
75
76
77## Reporting Issues
78
79As stated above, please read [CONTRIBUTING.md](https://github.com/wenzhixin/bootstrap-table/blob/master/CONTRIBUTING.md), especially [Bug Reports](https://github.com/wenzhixin/bootstrap-table/blob/master/CONTRIBUTING.md#bug-reports)
80
81And as stated there, please provide an [Online Example](https://live.bootstrap-table.com) when creating issues!
82
83It's really saves much time.
84
85You can also use our examples template via Load Examples button:
86
87[Online Editor](https://live.bootstrap-table.com/)
88
89Your feedback is very appreciated!
90
91
92## Acknowledgements
93
94Thanks to everyone who have given feedback and submitted pull requests. A list of all the contributors can be found [here](https://github.com/wenzhixin/bootstrap-table/graphs/contributors).
95This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
96<a href="graphs/contributors"><img src="https://opencollective.com/bootstrap-table/contributors.svg?width=890" /></a>
97
98## Release History
99
100Look at the [Change Log](https://github.com/wenzhixin/bootstrap-table/blob/master/CHANGELOG.md)
101
102## Local build
103
104To build bootstrap-table locally please run:
105
106```
107npm run build
108```
109
110Result will appear in `dist` directory.
111
112## PayPal Sponsors
113
114<a href="https://edubirdie.com/write-my-essay" target="_blank"><img height="64" src="https://bootstrap-table.com/assets/images/edu-birdie.png" alt="Write my essay services from Edubirdie"></a>
115
116## OpenCollective Sponsors
117
118Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/bootstrap-table#sponsor)]
119
120<a href="https://opencollective.com/bootstrap-table/sponsor/0/website" target="_blank"><img src="https://opencollective.com/bootstrap-table/sponsor/0/avatar.svg"></a>
121<a href="https://opencollective.com/bootstrap-table/sponsor/1/website" target="_blank"><img src="https://opencollective.com/bootstrap-table/sponsor/1/avatar.svg"></a>
122<a href="https://opencollective.com/bootstrap-table/sponsor/2/website" target="_blank"><img src="https://opencollective.com/bootstrap-table/sponsor/2/avatar.svg"></a>
123<a href="https://opencollective.com/bootstrap-table/sponsor/3/website" target="_blank"><img src="https://opencollective.com/bootstrap-table/sponsor/3/avatar.svg"></a>
124<a href="https://opencollective.com/bootstrap-table/sponsor/4/website" target="_blank"><img src="https://opencollective.com/bootstrap-table/sponsor/4/avatar.svg"></a>
125<a href="https://opencollective.com/bootstrap-table/sponsor/5/website" target="_blank"><img src="https://opencollective.com/bootstrap-table/sponsor/5/avatar.svg"></a>
126<a href="https://opencollective.com/bootstrap-table/sponsor/6/website" target="_blank"><img src="https://opencollective.com/bootstrap-table/sponsor/6/avatar.svg"></a>
127<a href="https://opencollective.com/bootstrap-table/sponsor/7/website" target="_blank"><img src="https://opencollective.com/bootstrap-table/sponsor/7/avatar.svg"></a>
128<a href="https://opencollective.com/bootstrap-table/sponsor/8/website" target="_blank"><img src="https://opencollective.com/bootstrap-table/sponsor/8/avatar.svg"></a>
129<a href="https://opencollective.com/bootstrap-table/sponsor/9/website" target="_blank"><img src="https://opencollective.com/bootstrap-table/sponsor/9/avatar.svg"></a>
130<a href="https://opencollective.com/bootstrap-table/sponsor/10/website" target="_blank"><img src="https://opencollective.com/bootstrap-table/sponsor/10/avatar.svg"></a>
131
132## OpenCollective Backers
133
134Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/bootstrap-table#backer)]
135
136<a href="https://opencollective.com/bootstrap-table#backers" target="_blank"><img src="https://opencollective.com/bootstrap-table/backers.svg?width=890"></a>