public/assets/bootstrap-combobox-1-1-7/README.md

   1 # Bootstrap Combobox
   2
   3 We had need of a combobox at work and after looking around at the available options I was not happy with any of them.  The project had all it's styling based on Twitter's Bootstrap, so building on that made sense.
   4
   5 ## How to install it
   6
   7 You can install this plugin one of two ways.
   8
   9 #### 1. Manual download
  10
  11 Previously, this was the only way to install the plugin. You will need two files included in your HTML in order for this to work:
  12
  13 1. js/bootstrap-combobox.js
  14 2. css/bootstrap-combobox.css
  15
  16 #### 2. Bower install
  17
  18 This plugin is now in bower! If you've already installed bower on your machine, simply use the command:
  19
  20 ```
  21 bower install bootstrap-combobox
  22 ```
  23
  24 This will install the plugin to your bower_components folder. For more information please see http://bower.io/
  25
  26 ## How to use it
  27
  28 The dependencies are the Bootstrap stylesheet(CSS or LESS).  Include it and then the stylesheet(CSS or LESS) and javascript.
  29
  30 Then just activate the plugin on a normal select box(suggest having a blank option first):
  31
  32     <select class="combobox">
  33       <option></option>
  34       <option value="PA">Pennsylvania</option>
  35       <option value="CT">Connecticut</option>
  36       <option value="NY">New York</option>
  37       <option value="MD">Maryland</option>
  38       <option value="VA">Virginia</option>
  39     </select>
  40
  41     <script type="text/javascript">
  42       $(document).ready(function(){
  43         $('.combobox').combobox();
  44       });
  45     </script>
  46
  47 ### Options
  48
  49 When activating the plugin, you may include an object containing options for the combobox
  50
  51     $('.combobox').combobox({bsVersion: '2'});
  52
  53 `menu`: Custom markup for the dropdown menu list element.
  54
  55 `item`: Custom markup for the dropdown menu list items.
  56
  57 `matcher`: Custom function with one `item` argument that compares the item to the input. Defaults to matching on the query being a substring of the item, case insenstive
  58
  59  `sorter`: Custom function that sorts a list `items` for display in the dropdown
  60
  61  `highlighter`: Custom function for highlighting an `item`. Defaults to bolding the query within a matched item
  62
  63  `template`: Custom function that returns markup for the combobox.
  64
  65  `bsVersion`: Version of bootstrap being used. This is used by the default `template` function to generate markup correctly. Defaults to '3'. Set to '2' for compatibility with Bootstrap 2
  66
  67  `appendId`: The desired id of the transformed combobox. This will become the id attr and can be mapped to a label using the for attribute. Useful for accessibility.
  68
  69
  70 ## Dependencies
  71 Uses the latest 1.X version of jQuery and the latest 2.X or 3.X of bootstrap.
  72
  73 ## Live Example
  74
  75 ### Bootstrap 2.0 Version
  76 http://dl.dropbox.com/u/21368/bootstrap-combobox/index.html
  77
  78 ### Bootstrap 3.0 Version
  79 http://bootstrap-combobox-test.herokuapp.com/
  80
  81 ## License
  82
  83 Licensed under the Apache License, Version 2.0