bootstrap-combobox

WebJar for bootstrap-combobox

License	MIT
GroupId	org.webjars.npm
ArtifactId	bootstrap-combobox
Last Version	1.0.2
Release Date	Sep 2, 2015
Type	jar
Description	bootstrap-combobox WebJar for bootstrap-combobox
Project URL	http://webjars.org
Source Code Management	https://github.com/cchantep/bootstrap-combobox

Download bootstrap-combobox

Filename	Size
bootstrap-combobox-1.0.2.pom
bootstrap-combobox-1.0.2.jar	6 KB
bootstrap-combobox-1.0.2-sources.jar	22 bytes
bootstrap-combobox-1.0.2-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/bootstrap-combobox/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>bootstrap-combobox</artifactId>
    <version>1.0.2</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/bootstrap-combobox/
implementation 'org.webjars.npm:bootstrap-combobox:1.0.2'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/bootstrap-combobox/
implementation ("org.webjars.npm:bootstrap-combobox:1.0.2")

Apache Buildr

'org.webjars.npm:bootstrap-combobox:jar:1.0.2'

Apache Ivy

<dependency org="org.webjars.npm" name="bootstrap-combobox" rev="1.0.2">
  <artifact name="bootstrap-combobox" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='bootstrap-combobox', version='1.0.2')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "bootstrap-combobox" % "1.0.2"

Leiningen

[org.webjars.npm/bootstrap-combobox "1.0.2"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.webjars.npm : jquery	jar	[1.10,)
org.webjars.npm : bootstrap	jar	[3,)

Project Modules

There are no modules declared in this project.

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.

<!-- Dependencies -->
<script src="//url/to/jquery-1.10.2.min.js"></script>
<script src="//url/to/bootstrap.js"></script>
<script src="//url/to/bootstrap-combobox.min.js"></script>

<!-- UI dependencies -->
<link href="//url/to/bootstrap.min.css" rel="stylesheet" />

<!-- HTML to be rendered as a combobox -->
<select id="uniqueId" name="fieldName"
  class="optional overall classes"
  data-btn-class="option toggle classes">
  <!-- ... -->
</select>

<!-- Install combobox UI on the select -->
<script>$('select').btComboBox()</script>

API reference

selectedOption

.btComboBox('selectedOption')

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

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

value

.btComboBox('value')

Returns value of selected option.

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

select

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

Selects option matching given value (if one).

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

clear

.btComboBox('clear')

Removes all options and unselect value.

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

load

.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].

$('.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] }
})

reset

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

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

values

.btComboBox('values')

Returns values from all available options.

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

disable/enable

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

Disable/enable combobox.

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

Events

change

Fired when combobox value is changed.

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

Versions

Version
1.0.2 Sep 2, 2015