Blame view

resource/lib/bootstrap-select/README.md 3.14 KB
c2bb199a   Andy   add tools doc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
  bootstrap-select
  ================
  
  [![Latest release](https://img.shields.io/github/release/silviomoreto/bootstrap-select.svg?style=flat)](https://github.com/silviomoreto/bootstrap-select/releases/latest)
  [![Bower](https://img.shields.io/bower/v/bootstrap-select.svg)]()
  [![npm](https://img.shields.io/npm/v/bootstrap-select.svg)]()
  [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](LICENSE)
  [![Dependency Status](https://david-dm.org/silviomoreto/bootstrap-select.svg)](https://david-dm.org/silviomoreto/bootstrap-select)
  [![devDependency Status](https://david-dm.org/silviomoreto/bootstrap-select/dev-status.svg)](https://david-dm.org/silviomoreto/bootstrap-select#info=devDependencies)
  
  A custom select / multiselect for Bootstrap using button dropdown, designed to behave like regular Bootstrap selects.
  
  ## Demo and Documentation
  
  See a Bootstrap 3 example [here](http://silviomoreto.github.io/bootstrap-select).
  
  ## Authors
  
  [Silvio Moreto](https://github.com/silviomoreto),
  [Ana Carolina](https://github.com/anacarolinats),
  [caseyjhol](https://github.com/caseyjhol),
  [Matt Bryson](https://github.com/mattbryson), and
  [t0xicCode](https://github.com/t0xicCode).
  
  ## Usage
  
  Create your `<select>` with the `.selectpicker` class.
  ```html
  <select class="selectpicker">
    <option>Mustard</option>
    <option>Ketchup</option>
    <option>Barbecue</option>
  </select>
  ```
  
  If you use a 1.6.3 or newer, you don't need to do anything else, as the data-api automatically picks up the `<select>`s with the `selectpicker` class.
  
  If you use an older version, you need to add the following either at the bottom of the page (after the last selectpicker), or in a [`$(document).ready()`](http://api.jquery.com/ready/) block.
  ```js
  // To style only <select>s with the selectpicker class
  $('.selectpicker').selectpicker();
  ```
  Or
  ```js
  // To style all <select>s
  $('select').selectpicker();
  ```
  
  Checkout the [documentation](http://silviomoreto.github.io/bootstrap-select) for further information.
  
  ## CDN
  
  **N.B.**: The CDN is updated after the release is made public, which means that there is a delay between the publishing of a release and its availability on the CDN. Check [the GitHub page](https://github.com/silviomoreto/bootstrap-select/releases) for the latest release.
  
  * [//cdnjs.cloudflare.com/ajax/libs/bootstrap-select/1.6.5/css/bootstrap-select.min.css](//cdnjs.cloudflare.com/ajax/libs/bootstrap-select/1.6.5/css/bootstrap-select.min.css)
  * [//cdnjs.cloudflare.com/ajax/libs/bootstrap-select/1.6.5/js/bootstrap-select.min.js](//cdnjs.cloudflare.com/ajax/libs/bootstrap-select/1.6.5/js/bootstrap-select.min.js)
  * //cdnjs.cloudflare.com/ajax/libs/bootstrap-select/1.6.5/js/i18n/defaults-*.min.js (The translation files)
  
  ## Bugs and feature requests
  
  Anyone and everyone is welcome to contribute. **Please take a moment to
  review the [guidelines for contributing](CONTRIBUTING.md)**. Make sure you're using the latest version of bootstrap-select before submitting an issue.
  
  * [Bug reports](CONTRIBUTING.md#bug-reports)
  * [Feature requests](CONTRIBUTING.md#feature-requests)
  
  ## Copyright and license
  
  Copyright (C) 2013-2015 bootstrap-select
  
  Licensed under [the MIT license](LICENSE).