Bootstrap Combobox

Provides combobox as a Twitter Bootstrap component, based on dropdown (which is compatible down to IE7).

See demo.

Get started

Files of this component can be download from the source repository: js/

> It requires jQuery 1.10+ & Twitter Bootstrap 3+.

It's also available as a NPM package: npm install bootstrap-combobox

Setup

Combobox plugin can be applied on select elements, to turn them into comboboxes.

``html






class="optional overall classes"
data-btn-class="option toggle classes">





`

API reference

$3

.btComboBox('selectedOption')

Returns selected option ([val, label, element]) or null (if none).

`javascript
var o = $('.btn-group').btComboBox('selectedOption');
var val = o[0], label = o[1], elem = o[2];
`

$3

.btComboBox('value')

Returns value of selected option.

`javascript
var v = $('.btn-group').btComboBox('value')
`

$3

.btComboBox({'action':"select",'value':"V"})

Selects option matching given value (if one).

`javascript
$('.btn-group).btComboBox({'action':"select",'value':"value_to_select"})
`

$3

.btComboBox('clear')

Removes all options and unselect value.

`javascript
$('.btn-group').btComboBox('clear')
`

$3

.btComboBox({'action':"load", parameters})

Appends options, using given parameters properties.

* pairs: Array of option to be appended; Each array element
should be either [val,label], or anything else if next extractor
property is provided. If pair is ['_',null] it will be a divider.
* extractor (optional, required if elements of pairs array
aren't [val,label]): Function (element of pairs) => [value, label].

`javascript
$('.btn-group').btComboBox({
'action':"load",
'pairs': [["val1", "label1"], ["val2", "label2"]]
});

// OR
$('.btn-group').btComboBox({
'action':"load",
'pairs': [{v:"val1", l:"label1"}, {v:"val2", l:"label2"}],
'extractor': function(o) { return [o.v, o.l] }
})
`

$3

.btComboBox({'action':"reset", parameters})

Reset options, using same parameters as load method.
Keep value selection (if value is still available in new options).

$3

.btComboBox('values')

Returns values from all available options.

`javascript
var vs = $('.btn-group').btComboBox('values')
`

$3

.btComboBox('disable') / .btComboBox('enable')

Disable/enable combobox.

`javascript
$('.btn-group').btComboBox('disable');
$('.btn-group').btComboBox('enable');
`

Events

change

Fired when combobox value is changed.

`javascript
$("#combobox").on('change', function() { / ... / })
``