bootstrap-table README

The project's README from github.com/wenzhixin/bootstrap-table. As one markdown file: README.md.

Bootstrap Table

Build Status GitHub version Donate Backers on Open Collective Sponsors on Open Collective Package Quality

An extended Bootstrap table with radio, checkbox, sort, pagination, extensions and other added features.

To get started, check out:

List of donators

LICENSE

NOTE: Bootstrap Table is licensed under The MIT 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.

Features

How to get it

Manual download

Use Releases page or the source.

Yarn

yarn add bootstrap-table

Npm

npm install bootstrap-table

CDN

You can source bootstrap-table directly from a CDN like CDNJS or bootcss or jsdelivr.

Contributing

For feature requests, bug reports or submitting pull requests, please ensure you first read CONTRIBUTING.md.

Reporting Issues

As stated above, please read CONTRIBUTING.md, especially Bug Reports

And as stated there, please provide an Online Example when creating issues!

It's really saves much time.

You can also use our examples template via Load Examples button:

Online Editor

Your feedback is very appreciated!

Acknowledgements

Thanks to everyone who have given feedback and submitted pull requests. A list of all the contributors can be found here. This project exists thanks to all the people who contribute. [Contribute].

Release History

Look at the Change Log

Local develop

To develop bootstrap-table locally please run:

mkdir bootstrap-table-dev
cd bootstrap-table-dev
git clone https://github.com/wenzhixin/bootstrap-table
git clone https://github.com/wenzhixin/bootstrap-table-examples

yarn add http-server
npx http-server

And then open: http://localhost:8081/bootstrap-table-examples

Local build

Be sure to use a current version of yarn/npm. To build bootstrap-table locally please run:

Yarn

yarn install
yarn build

Npm

npm install
npm run build

Result will appear in dist directory.

PayPal Sponsors

Write my essay services from Edubirdie

OpenCollective Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

OpenCollective Backers

Support this project by becoming a backer. Your image will show up here with a link to your website. [Become a backer]

bootstrap-table (wenzhixin/bootstrap-table)

Searching Database…

What is this?A front-end JavaScript plugin that turns plain HTML tables into feature-rich ones, adding radio and checkbox selection, sorting, pagination and extensions on top of CSS frameworks like Bootstrap.
Is it a standalone app or something I plug into my own web pages?It is a client-side plugin for your own web pages, not a standalone app: you include it next to your CSS framework and it enhances the tables in your markup. No server is involved.
How do I add it to a project?Install it with npm or Yarn, load it from a CDN such as CDNJS or jsdelivr, or download it manually from the GitHub Releases page.
Does it lock me into Bootstrap, or does it work with other CSS frameworks too?It was created for Twitter Bootstrap and supports all Bootstrap versions, and it also integrates with Semantic UI, Bulma, Material Design, Foundation and Vue.js.
What can these tables do out of the box?Click a column header to sort it, select single or multiple rows, page through data with powerful pagination, and switch to card or detail views. Columns, headers and footers can be shown or hidden, plus responsive design, localization and a set of extensions.
How much JavaScript do I need to write to use it?Very little: tables are fully configurable via data attributes, and data can be pulled in JSON format using AJAX.
Can I try it online before installing?Yes — there are live examples online, and an Online Editor with a Load Examples button gives you ready-made templates you can tweak in the browser.
Is it free to use, even commercially?Yes. It is MIT-licensed and the README states it is completely free to use and modify arbitrarily.
Creator
wenzhixin
Size
51.7 MB
Stars
11.8K
Age
13y
Commits · 90 Days