1928 lines
101 KiB
HTML
1928 lines
101 KiB
HTML
---
|
|
layout: main
|
|
title: Select2 Latest
|
|
group: navigation
|
|
version: 3.4.6
|
|
milestone: 16
|
|
---
|
|
|
|
<link href="select2-master/select2.css?ts={{ site.time | date_to_xmlschema | cgi_escape}}" rel="stylesheet"/>
|
|
<script src="select2-master/select2.js?ts={{ site.time | date_to_xmlschema | cgi_escape}}"></script>
|
|
|
|
<script id="script_e1">
|
|
|
|
$(function() {
|
|
var opts=$("#source").html(), opts2="<option></option>"+opts;
|
|
$("select.populate").each(function() { var e=$(this); e.html(e.hasClass("placeholder")?opts2:opts); });
|
|
$(".examples article:odd").addClass("zebra");
|
|
});
|
|
|
|
$(document).ready(function() {
|
|
$("#e1").select2();
|
|
});
|
|
</script>
|
|
|
|
<script id="script_e3">
|
|
$(document).ready(function() {
|
|
$("#e3").select2({
|
|
minimumInputLength: 2
|
|
});
|
|
});
|
|
</script>
|
|
|
|
<script id="script_e4">
|
|
$(document).ready(function() {
|
|
function format(state) {
|
|
if (!state.id) return state.text; // optgroup
|
|
return "<img class='flag' src='images/flags/" + state.id.toLowerCase() + ".png'/>" + state.text;
|
|
}
|
|
$("#e4").select2({
|
|
formatResult: format,
|
|
formatSelection: format,
|
|
escapeMarkup: function(m) { return m; }
|
|
});
|
|
});
|
|
</script>
|
|
|
|
|
|
<script id="script_e5">
|
|
$(document).ready(function() {
|
|
$("#e5").select2({
|
|
minimumInputLength: 1,
|
|
query: function (query) {
|
|
var data = {results: []}, i, j, s;
|
|
for (i = 1; i < 5; i++) {
|
|
s = "";
|
|
for (j = 0; j < i; j++) {s = s + query.term;}
|
|
data.results.push({id: query.term + i, text: s});
|
|
}
|
|
query.callback(data);
|
|
}
|
|
});
|
|
});
|
|
</script>
|
|
|
|
<script>
|
|
|
|
function movieFormatResult(movie) {
|
|
var markup = "<table class='movie-result'><tr>";
|
|
if (movie.posters !== undefined && movie.posters.thumbnail !== undefined) {
|
|
markup += "<td class='movie-image'><img src='" + movie.posters.thumbnail + "'/></td>";
|
|
}
|
|
markup += "<td class='movie-info'><div class='movie-title'>" + movie.title + "</div>";
|
|
if (movie.critics_consensus !== undefined) {
|
|
markup += "<div class='movie-synopsis'>" + movie.critics_consensus + "</div>";
|
|
}
|
|
else if (movie.synopsis !== undefined) {
|
|
markup += "<div class='movie-synopsis'>" + movie.synopsis + "</div>";
|
|
}
|
|
markup += "</td></tr></table>";
|
|
return markup;
|
|
}
|
|
|
|
function movieFormatSelection(movie) {
|
|
return movie.title;
|
|
}
|
|
|
|
</script>
|
|
|
|
<script id="script_e6">
|
|
$(document).ready(function() {
|
|
$("#e6").select2({
|
|
placeholder: "Search for a movie",
|
|
minimumInputLength: 1,
|
|
ajax: { // instead of writing the function to execute the request we use Select2's convenient helper
|
|
url: "http://api.rottentomatoes.com/api/public/v1.0/movies.json",
|
|
dataType: 'jsonp',
|
|
data: function (term, page) {
|
|
return {
|
|
q: term, // search term
|
|
page_limit: 10,
|
|
apikey: "ju6z9mjyajq2djue3gbvv26t" // please do not use so this example keeps working
|
|
};
|
|
},
|
|
results: function (data, page) { // parse the results into the format expected by Select2.
|
|
// since we are using custom formatting functions we do not need to alter remote JSON data
|
|
return {results: data.movies};
|
|
}
|
|
},
|
|
initSelection: function(element, callback) {
|
|
// the input tag has a value attribute preloaded that points to a preselected movie's id
|
|
// this function resolves that id attribute to an object that select2 can render
|
|
// using its formatResult renderer - that way the movie name is shown preselected
|
|
var id=$(element).val();
|
|
if (id!=="") {
|
|
$.ajax("http://api.rottentomatoes.com/api/public/v1.0/movies/"+id+".json", {
|
|
data: {
|
|
apikey: "ju6z9mjyajq2djue3gbvv26t"
|
|
},
|
|
dataType: "jsonp"
|
|
}).done(function(data) { callback(data); });
|
|
}
|
|
},
|
|
formatResult: movieFormatResult, // omitted for brevity, see the source of this page
|
|
formatSelection: movieFormatSelection, // omitted for brevity, see the source of this page
|
|
dropdownCssClass: "bigdrop", // apply css that makes the dropdown taller
|
|
escapeMarkup: function (m) { return m; } // we do not want to escape markup since we are displaying html in results
|
|
});
|
|
});
|
|
</script>
|
|
|
|
<script id="script_e7">
|
|
$(document).ready(function() {
|
|
$("#e7").select2({
|
|
placeholder: "Search for a movie",
|
|
minimumInputLength: 3,
|
|
ajax: {
|
|
url: "http://api.rottentomatoes.com/api/public/v1.0/movies.json",
|
|
dataType: 'jsonp',
|
|
quietMillis: 100,
|
|
data: function (term, page) { // page is the one-based page number tracked by Select2
|
|
return {
|
|
q: term, //search term
|
|
page_limit: 10, // page size
|
|
page: page, // page number
|
|
apikey: "ju6z9mjyajq2djue3gbvv26t" // please do not use so this example keeps working
|
|
};
|
|
},
|
|
results: function (data, page) {
|
|
var more = (page * 10) < data.total; // whether or not there are more results available
|
|
|
|
// notice we return the value of more so Select2 knows if more results can be loaded
|
|
return {results: data.movies, more: more};
|
|
}
|
|
},
|
|
formatResult: movieFormatResult, // omitted for brevity, see the source of this page
|
|
formatSelection: movieFormatSelection, // omitted for brevity, see the source of this page
|
|
dropdownCssClass: "bigdrop", // apply css that makes the dropdown taller
|
|
escapeMarkup: function (m) { return m; } // we do not want to escape markup since we are displaying html in results
|
|
});
|
|
});
|
|
</script>
|
|
|
|
<script id="script_e9">
|
|
$(document).ready(function() {
|
|
$("#e9").select2();
|
|
});
|
|
</script>
|
|
|
|
<script id="script_e10">
|
|
$(document).ready(function() {
|
|
|
|
$("#e10").select2({
|
|
data:[{id:0,text:'enhancement'},{id:1,text:'bug'},{id:2,text:'duplicate'},{id:3,text:'invalid'},{id:4,text:'wontfix'}]
|
|
});
|
|
|
|
var data=[{id:0,tag:'enhancement'},{id:1,tag:'bug'},{id:2,tag:'duplicate'},{id:3,tag:'invalid'},{id:4,tag:'wontfix'}];
|
|
function format(item) { return item.tag; }
|
|
|
|
$("#e10_2").select2({
|
|
data:{ results: data, text: 'tag' },
|
|
formatSelection: format,
|
|
formatResult: format
|
|
});
|
|
|
|
$("#e10_3").select2({
|
|
data:{ results: data, text: function(item) { return item.tag; } },
|
|
formatSelection: format,
|
|
formatResult: format
|
|
});
|
|
$("#e10_4").select2({
|
|
data:function() { return { text:'tag', results: data }; },
|
|
formatSelection: format,
|
|
formatResult: format
|
|
});
|
|
|
|
});
|
|
</script>
|
|
|
|
<!-- unreleased --><div class="row">
|
|
<!-- unreleased --> <div class="span12">
|
|
<!-- unreleased --> <div class="alert alert-block alert-error">
|
|
<!-- unreleased --> <h4 class="alert-heading">Warning!</h4>
|
|
<!-- unreleased --> This page refers to an unreleased <em>{{ page.version }}</em> version of Select2 which may be unstable. For the latest stable
|
|
<!-- unreleased --> and previous versions please see links at the top. The code for this version is only available in the
|
|
<!-- unreleased --> <a href="https://github.com/ivaynberg/select2">master branch</a>.
|
|
<!-- unreleased --> </div>
|
|
<!-- unreleased --> </div>
|
|
<!-- unreleased --></div>
|
|
|
|
|
|
<header class="jumbotron subhead">
|
|
<div class="subnav">
|
|
<ul class="nav nav-pills">
|
|
<li><a href="#changelog">Changelog</a></li>
|
|
<li class="dropdown">
|
|
<a class="dropdown-toggle" data-toggle="dropdown" href="#">Examples <b class="caret"></b></a>
|
|
<ul class="dropdown-menu">
|
|
<li><a href="#basics">Basics</a></li>
|
|
<li><a href="#multi">Multi-Value</a></li>
|
|
<li><a href="#placeholders">Placeholders</a></li>
|
|
<li><a href="#minimum">Minimum Input Length</a></li>
|
|
<li><a href="#templating">Templating</a></li>
|
|
<li><a href="#data">Loading Data</a></li>
|
|
<li><a href="#data_array">Array Data</a></li>
|
|
<li><a href="#ajax">Remote/AJAX Data</a></li>
|
|
<li><a href="#infinite">Infinite Scrolling of Remote/AJAX data</a></li>
|
|
<li><a href="#tags">Tagging Support</a></li>
|
|
<li><a href="#programmatic">Programmatic control</a></li>
|
|
<li><a href="#events">Events</a></li>
|
|
<li><a href="#event_ext_change">Events: Reacting to External Changes</a></li>
|
|
<li><a href="#disabled">Disabled Mode</a></li>
|
|
<li><a href="#matcher">Custom Matcher Function</a></li>
|
|
<li><a href="#sort_results">Sorting Displayed Results</a></li>
|
|
<li><a href="#responsive">Responsive Design</a></li>
|
|
<li><a href="#diacritics">Diacritics Support</a></li>
|
|
<li><a href="#allow_duplicated_tags">Allow duplicated tags</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#documentation">Documentation</a></li>
|
|
<li><a href="#about">About</a></li>
|
|
</ul>
|
|
</div>
|
|
</header>
|
|
|
|
|
|
<section id="changelog">
|
|
<h2>Changelog <span id="milestones"><small>(Loading...)</small></span> <span id="totalissues"></span></h2>
|
|
<div class="row"><div class="span12">
|
|
<a href="#changelog" style="display:none" class="details">show/hide details</a>
|
|
<ul style="display:none">
|
|
<li>Loading...</li>
|
|
<script>
|
|
$(function() {
|
|
var url="https://api.github.com/repos/ivaynberg/select2/issues?state=closed&milestone={{ page.milestone }}&per_page=100";
|
|
$.ajax({
|
|
url: url,
|
|
dataType: "jsonp"
|
|
}).done(function(issues) {
|
|
var list=$("#changelog ul");
|
|
var template="<li><a href='$url'><span>#$num</span> </a>$title</li>";
|
|
list.empty();
|
|
$.each(issues.data, function() {
|
|
var markup=template
|
|
.replace(/\$url/g, this.html_url)
|
|
.replace(/\$num/g, this.number)
|
|
.replace(/\$title/g, this.title.replace("<", "<"));
|
|
list.append(markup);
|
|
});
|
|
|
|
$("#totalissues").html("("+issues.data.length+")");
|
|
|
|
var milestones=$.map(issues.data, function(e) {
|
|
return e.milestone.title;
|
|
});
|
|
|
|
for (var i=1;i<milestones.length;i++) {
|
|
if (milestones[i-1]===milestones[i]) {
|
|
milestones.splice(i, 1);
|
|
i--;
|
|
}
|
|
}
|
|
$("#milestones").html(milestones.join(", "));
|
|
$("#changelog .details").show();
|
|
|
|
}).fail(function() {
|
|
$("#changelog ul").empty().append("<li class='alert alert-error'>Error retrieving changelog</li>");
|
|
});
|
|
$("#changelog .details").on("click", function() { $("#changelog ul").toggle(); });
|
|
});
|
|
</script>
|
|
</ul>
|
|
</div></div>
|
|
</section>
|
|
<section>
|
|
<h2>Browser Compatibility</h2>
|
|
<ul>
|
|
<li>IE 8+</li>
|
|
<li>Chrome 8+</li>
|
|
<li>Firefox 10+</li>
|
|
<li>Safari 3+</li>
|
|
<li>Opera 10.6+</li>
|
|
</ul>
|
|
</section>
|
|
|
|
<section class="examples">
|
|
<div class="row">
|
|
<div class="span12">
|
|
<h2>Examples</h2>
|
|
<hr/>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<article class="row" id="basics">
|
|
<div class="span4">
|
|
<h3>The Basics</h3>
|
|
<p>Select2 can take a regular select box like this:</p>
|
|
<p><select style="width:300px" id="source">
|
|
<optgroup label="Alaskan/Hawaiian Time Zone">
|
|
<option value="AK">Alaska</option>
|
|
<option value="HI">Hawaii</option>
|
|
</optgroup>
|
|
<optgroup label="Pacific Time Zone">
|
|
<option value="CA">California</option>
|
|
<option value="NV">Nevada</option>
|
|
<option value="OR">Oregon</option>
|
|
<option value="WA">Washington</option>
|
|
</optgroup>
|
|
<optgroup label="Mountain Time Zone">
|
|
<option value="AZ">Arizona</option>
|
|
<option value="CO">Colorado</option>
|
|
<option value="ID">Idaho</option>
|
|
<option value="MT">Montana</option><option value="NE">Nebraska</option>
|
|
<option value="NM">New Mexico</option>
|
|
<option value="ND">North Dakota</option>
|
|
<option value="UT">Utah</option>
|
|
<option value="WY">Wyoming</option>
|
|
</optgroup>
|
|
<optgroup label="Central Time Zone">
|
|
<option value="AL">Alabama</option>
|
|
<option value="AR">Arkansas</option>
|
|
<option value="IL">Illinois</option>
|
|
<option value="IA">Iowa</option>
|
|
<option value="KS">Kansas</option>
|
|
<option value="KY">Kentucky</option>
|
|
<option value="LA">Louisiana</option>
|
|
<option value="MN">Minnesota</option>
|
|
<option value="MS">Mississippi</option>
|
|
<option value="MO">Missouri</option>
|
|
<option value="OK">Oklahoma</option>
|
|
<option value="SD">South Dakota</option>
|
|
<option value="TX">Texas</option>
|
|
<option value="TN">Tennessee</option>
|
|
<option value="WI">Wisconsin</option>
|
|
</optgroup>
|
|
<optgroup label="Eastern Time Zone">
|
|
<option value="CT">Connecticut</option>
|
|
<option value="DE">Delaware</option>
|
|
<option value="FL">Florida</option>
|
|
<option value="GA">Georgia</option>
|
|
<option value="IN">Indiana</option>
|
|
<option value="ME">Maine</option>
|
|
<option value="MD">Maryland</option>
|
|
<option value="MA">Massachusetts</option>
|
|
<option value="MI">Michigan</option>
|
|
<option value="NH">New Hampshire</option><option value="NJ">New Jersey</option>
|
|
<option value="NY">New York</option>
|
|
<option value="NC">North Carolina</option>
|
|
<option value="OH">Ohio</option>
|
|
<option value="PA">Pennsylvania</option><option value="RI">Rhode Island</option><option value="SC">South Carolina</option>
|
|
<option value="VT">Vermont</option><option value="VA">Virginia</option>
|
|
<option value="WV">West Virginia</option>
|
|
</optgroup>
|
|
</select>
|
|
</p>
|
|
<p>and turns it into:</p>
|
|
<p>
|
|
<select id="e1" class="populate" style="width:300px"></select>
|
|
</p>
|
|
<p>with support for quick option filtering via a search box.</p>
|
|
</div>
|
|
<div class="span8">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e1">
|
|
<head>
|
|
<link href="select2.css" rel="stylesheet"/>
|
|
<script src="select2.js"></script>
|
|
<script>
|
|
$(document).ready(function() { $("#e1").select2(); });
|
|
</script>
|
|
</head>
|
|
<body>
|
|
<select id="e1">
|
|
<option value="AL">Alabama</option>
|
|
...
|
|
<option value="WY">Wyoming</option>
|
|
</select>
|
|
</body>
|
|
</pre>
|
|
</div>
|
|
</article>
|
|
|
|
<article class="row" id="multi">
|
|
<div class="span4">
|
|
<h3>Multi-Value Select Boxes</h3>
|
|
<p>Select2 also supports multi-value select boxes. The <code>select</code> below is declared with the <code>multiple</code> attribute. Select2 automatically picks up on this:</p>
|
|
<p>
|
|
<select multiple name="e9" id="e9" style="width:300px" class="populate"></select>
|
|
</p>
|
|
</div>
|
|
<div class="span8">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e9">
|
|
</pre>
|
|
</div>
|
|
</article>
|
|
|
|
|
|
<article class="row" id="placeholders">
|
|
<script id="script_e2">
|
|
$(document).ready(function() {
|
|
$("#e2").select2({
|
|
placeholder: "Select a State",
|
|
allowClear: true
|
|
});
|
|
$("#e2_2").select2({
|
|
placeholder: "Select a State"
|
|
});
|
|
});
|
|
</script>
|
|
<div class="span4">
|
|
<h3>Placeholders</h3>
|
|
<p>A placeholder value can be defined and will be displayed until a selection is made:</p>
|
|
<p>
|
|
<select id="e2" style="width:300px" class="populate placeholder"></select><br/>
|
|
</p>
|
|
<p>
|
|
<select id="e2_2" multiple="multiple" style="width:300px" class="populate placeholder"></select><br/>
|
|
</p>
|
|
<p>The placeholder can be declared via a <code>data-placeholder</code> attribute attached to the <code>select</code>, or via the <code>placeholder</code> configuration element as seen in the example code.</p>
|
|
<p>When placeholder is used for a non-multi-value select box, it requires that you include an empty <code><option></option></code> tag as your first option.</p>
|
|
<p>Optionally, a clear button (visible once a selection is made) is available to reset the select box back to the placeholder value.</p>
|
|
|
|
</div>
|
|
<div class="span8">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e2">
|
|
</pre>
|
|
</div>
|
|
</article>
|
|
|
|
<article class="row" id="minimum">
|
|
<div class="span4">
|
|
<h3>Minimum Input</h3>
|
|
<p>Select2 supports a minimum input setting which is useful for large remote datasets where short search terms are not very useful:</p>
|
|
<p>
|
|
<select id="e3" style="width:300px" class="populate"></select><br/>
|
|
</p>
|
|
</div>
|
|
<div class="span8">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e3"></pre>
|
|
</div>
|
|
</article>
|
|
|
|
<article class="row" id="templating">
|
|
<div class="span4">
|
|
<h3>Templating</h3>
|
|
<p>Various display options of the Select2 component can be changed:</p>
|
|
<p>
|
|
<select id="e4" style="width:300px" class="populate"></select><br/>
|
|
</p>
|
|
</div>
|
|
<div class="span8">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e4"></pre>
|
|
<p>
|
|
You can set <code>data-</code> attributes to <code><option></code> (or <optgroup>) and use them inside templating functions:
|
|
</p>
|
|
<pre class="prettyprint linenums">
|
|
<select>
|
|
<option value="0" data-foo="bar">option one</option>
|
|
...
|
|
</select>
|
|
</pre>
|
|
<pre class="prettyprint linenums">
|
|
function format(state) {
|
|
var originalOption = state.element;
|
|
|
|
return "<img class='flag' src='images/flags/" + state.id.toLowerCase() + ".png' alt='" + $(originalOption).data('foo') + "' />" + state.text;
|
|
}
|
|
</pre>
|
|
</div>
|
|
</article>
|
|
|
|
<article class="row" id="data">
|
|
<div class="span4">
|
|
<h3>Loading Data</h3>
|
|
<p>Select2 uses a function to load result data. Here is a trivial example that creates choices that consist of user's input repeated a number of times:</p>
|
|
<p>
|
|
<input type="hidden" id="e5" style="width:300px"/>
|
|
</p>
|
|
<p>In order to take advantage of custom data loading Select2 should be attached to an <code>input type='hidden'</code> tag, otherwise data is parsed from <code>select</code>'s <code>option</code> tags.</p>
|
|
</div>
|
|
<div class="span8">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e5">
|
|
</pre>
|
|
</div>
|
|
</article>
|
|
|
|
|
|
<script id="script_e19">
|
|
$(document).ready(function() {
|
|
$("#e19").select2({ maximumSelectionSize: 3 });
|
|
});
|
|
</script>
|
|
<article class="row" id="maximumSelectionSize">
|
|
<div class="span4">
|
|
<h3>Maximum Selection Size</h3>
|
|
<p>Select2 allows the developer to limit the number of items that can be selected in a multi-select control.
|
|
In the example below only 3 or less items can be selected.</p>
|
|
<p>
|
|
<select multiple class="populate" id="e19" style="width:300px"></select>
|
|
</p>
|
|
</div>
|
|
<div class="span8">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e19">
|
|
</pre>
|
|
</div>
|
|
</article>
|
|
|
|
<article class="row" id="data_array">
|
|
<div class="span4">
|
|
<h3>Loading Array Data</h3>
|
|
<p>Select2 provides some shortcuts that make it easy to access local data stored in an array instead of having to write a <code>query</code> function mentioned in the example above.</p>
|
|
<p>Example below inlines the data by specifying an array in the <code>data</code> element. Items in such an array must have <code>id</code> and <code>text</code> keys.</p>
|
|
<p>
|
|
<input type="hidden" id="e10" style="width:300px"/>
|
|
</p>
|
|
<p>If your data does not have a <code>text</code> key, an alternative key can be specified as a string:</p>
|
|
<p>
|
|
<input type="hidden" id="e10_2" style="width:300px"/>
|
|
</p>
|
|
<p>or as a function:</p>
|
|
<p>
|
|
<input type="hidden" id="e10_3" style="width:300px"/>
|
|
</p>
|
|
<p><code>data</code> can also itself be a function that returns a results object:</p>
|
|
<p>
|
|
<input type="hidden" id="e10_4" style="width:300px"/>
|
|
</p>
|
|
|
|
</div>
|
|
<div class="span8">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e10">
|
|
</pre>
|
|
</div>
|
|
</article>
|
|
|
|
<article class="row" id="ajax">
|
|
<div class="span12">
|
|
<h3>Loading Remote Data</h3>
|
|
<p>Select2 comes with AJAX/JSONP support built in. In this example we will search for a movie using Rotten Tomatoes API:</p>
|
|
<p>
|
|
<input type="hidden" class="bigdrop" id="e6" style="width:600px" value="16340"/>
|
|
</p>
|
|
<p class="alert alert-warning">If this example does not work it is probably because the Rotten Tomatoes API key usage of 10000 requests per day has been exhausted. Please try again tomorrow.</p>
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e6"></pre>
|
|
<p>Select2 uses jQuery's <code>$.ajax</code> function to execute the remote call by default. An alternative <code>transport</code> function can be specified in the ajax settings, or an entirely custom implementation can be built by providing a custom <code>query</code> function instead of using the <code>ajax</code> helper.</p>
|
|
</div>
|
|
</article>
|
|
<article class="row" id="infinite">
|
|
<div class="span12">
|
|
<h3>Infinite Scroll with Remote Data</h3>
|
|
<p>Select2 supports lazy-appending of results when the result list is scrolled to the end.
|
|
In order to enable the remote service must support some sort of a paging mechanism and
|
|
the query function given to Select2 must take advantage of it. The following example demonstrates
|
|
how this can be set up. Search for some keyword and then scroll the result list to the end to
|
|
see more results load:</p>
|
|
<p>
|
|
<input type="hidden" class="bigdrop" id="e7" style="width:600px"/>
|
|
</p>
|
|
<p class="alert alert-warning">If this example does not work it is probably because the Rotten Tomatoes API key usage of 10000 requests per day has been exhausted. Please try again tomorrow.</p>
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e7"></pre>
|
|
</div>
|
|
</article>
|
|
|
|
<article class="row" id="programmatic">
|
|
<script id="script_e8">
|
|
$(document).ready(function() {
|
|
$("#e8").select2();
|
|
$("#e8_get").click(function () { alert("Selected value is: "+$("#e8").select2("val"));});
|
|
$("#e8_set").click(function () { $("#e8").select2("val", "CA"); });
|
|
$("#e8_cl").click(function() { $("#e8").select2("val", ""); });
|
|
$("#e8_get2").click(function () { var data = $("#e8").select2("data"); delete data.element; alert("Selected data is: "+JSON.stringify(data));});
|
|
$("#e8_set2").click(function () { $("#e8").select2("data", {id: "CA", text: "California"}); });
|
|
$("#e8_open").click(function () { $("#e8").select2("open"); });
|
|
$("#e8_close").click(function () { $("#e8").select2("close"); });
|
|
$("#e8_2").select2({placeholder: "Select a state"});
|
|
$("#e8_2_get").click(function () { alert("Selected value is: "+$("#e8_2").select2("val"));});
|
|
$("#e8_2_set").click(function () { $("#e8_2").select2("val", ["CA","MA"]); });
|
|
$("#e8_2_get2").click(function () { alert("Selected value is: "+JSON.stringify($("#e8_2").select2("data")));});
|
|
$("#e8_2_set2").click(function () { $("#e8_2").select2("data", [{id: "CA", text: "California"},{id:"MA", text: "Massachusetts"}]); });
|
|
$("#e8_2_cl").click(function() { $("#e8_2").select2("val", ""); });
|
|
$("#e8_2_open").click(function () { $("#e8_2").select2("open"); });
|
|
$("#e8_2_close").click(function () { $("#e8_2").select2("close"); });
|
|
});
|
|
</script>
|
|
<div class="span4">
|
|
<h3>Programmatic Access</h3>
|
|
<p>Select2 supports methods that allow programmatic control of the component:</p>
|
|
<p>
|
|
<input type="button" class="btn-primary" id="e8_get" value="Alert selected value"/>
|
|
<input type="button" class="btn-info" id="e8_set" value="Set to California"/>
|
|
<input type="button" class="btn-info" id="e8_cl" value="Clear"/>
|
|
<input type="button" class="btn-primary" id="e8_get2" value="Alert selected using data"/>
|
|
<input type="button" class="btn-info" id="e8_set2" value="Set to California using data"/>
|
|
<input type="button" class="btn-warning" id="e8_open" value="Open"/>
|
|
<input type="button" class="btn-warning" id="e8_close" value="Close"/>
|
|
</p>
|
|
<p>
|
|
<select id="e8" style="width:300px" class="populate"></select><br/>
|
|
</p>
|
|
<p>
|
|
<input type="button" class="btn-primary" id="e8_2_get" value="Alert selected value"/>
|
|
<input type="button" class="btn-info" id="e8_2_set" value="Set to California and Massachusetts"/>
|
|
<input type="button" class="btn-primary" id="e8_2_get2" value="Alert selected value using data"/>
|
|
<input type="button" class="btn-info" id="e8_2_set2" value="Set to California and Massachusetts using data"/>
|
|
<input type="button" class="btn-info" id="e8_2_cl" value="Clear"/>
|
|
<input type="button" class="btn-warning" id="e8_2_open" value="Open"/>
|
|
<input type="button" class="btn-warning" id="e8_2_close" value="Close"/>
|
|
</p>
|
|
<p>
|
|
<select id="e8_2" multiple style="width:300px" class="populate"><option></option></select><br/>
|
|
</p>
|
|
</div>
|
|
<div class="span8">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e8"></pre>
|
|
</div>
|
|
</article>
|
|
|
|
<article class="row" id="events">
|
|
<script id="script_e11">
|
|
$(document).ready(function () {
|
|
$("#e11").select2({
|
|
placeholder: "Select report type",
|
|
allowClear: true,
|
|
data: [{id: 0, text: 'story'},{id: 1, text: 'bug'},{id: 2, text: 'task'}]
|
|
});
|
|
$("#e11_2").select2({
|
|
createSearchChoice:function(term, data) { if ($(data).filter(function() { return this.text.localeCompare(term)===0; }).length===0) {return {id:term, text:term};} },
|
|
multiple: true,
|
|
data: [{id: 0, text: 'story'},{id: 1, text: 'bug'},{id: 2, text: 'task'}]
|
|
});
|
|
function log(e) {
|
|
var e=$("<li>"+e+"</li>");
|
|
$("#events_11").append(e);
|
|
e.animate({opacity:1}, 10000, 'linear', function() { e.animate({opacity:0}, 2000, 'linear', function() {e.remove(); }); });
|
|
}
|
|
$("#e11")
|
|
.on("change", function(e) { log("change "+JSON.stringify({val:e.val, added:e.added, removed:e.removed})); })
|
|
.on("select2-opening", function() { log("opening"); })
|
|
.on("select2-open", function() { log("open"); })
|
|
.on("select2-close", function() { log("close"); })
|
|
.on("select2-highlight", function(e) { log ("highlighted val="+ e.val+" choice="+ JSON.stringify(e.choice));})
|
|
.on("select2-selecting", function(e) { log ("selecting val="+ e.val+" choice="+ JSON.stringify(e.choice));})
|
|
.on("select2-removing", function(e) { log ("removing val="+ e.val+" choice="+ JSON.stringify(e.choice));})
|
|
.on("select2-removed", function(e) { log ("removed val="+ e.val+" choice="+ JSON.stringify(e.choice));})
|
|
.on("select2-loaded", function(e) { log ("loaded (data property omitted for brevity)");})
|
|
.on("select2-focus", function(e) { log ("focus");})
|
|
.on("select2-blur", function(e) { log ("blur");});
|
|
$("#e11_2")
|
|
.on("change", function(e) { log("change "+JSON.stringify({val:e.val, added:e.added, removed:e.removed})); })
|
|
.on("select2-opening", function() { log("opening"); })
|
|
.on("select2-open", function() { log("open"); })
|
|
.on("select2-close", function() { log("close"); })
|
|
.on("select2-highlight", function(e) { log ("highlighted val="+ e.val+" choice="+ JSON.stringify(e.choice));})
|
|
.on("select2-selecting", function(e) { log ("selecting val="+ e.val+" choice="+ JSON.stringify(e.choice));})
|
|
.on("select2-removing", function(e) { log ("removing val="+ e.val+" choice="+ JSON.stringify(e.choice));})
|
|
.on("select2-removed", function(e) { log ("removed val="+ e.val+" choice="+ JSON.stringify(e.choice));})
|
|
.on("select2-loaded", function(e) { log ("loaded (data property omitted for brevity)");})
|
|
.on("select2-focus", function(e) { log ("focus");})
|
|
.on("select2-blur", function(e) { log ("blur");});
|
|
});
|
|
</script>
|
|
<div class="span4">
|
|
<h3>Events</h3>
|
|
|
|
<p><code>change</code> event is triggered on the original element whenever its value is changed by
|
|
the user</p>
|
|
<p><code>open</code> event is triggered on the original element whenever the dropdown needs to be opened:</p>
|
|
|
|
<p><input type="hidden" id="e11" style="width:300px"/></p>
|
|
<p><input type="hidden" id="e11_2" style="width:300px"/></p>
|
|
|
|
</div>
|
|
<div class="span8">
|
|
<h3>Event Log</h3>
|
|
<ul id="events_11"></ul>
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e11">
|
|
</pre>
|
|
</div>
|
|
</article>
|
|
<article class="row" id="tags">
|
|
<script id="script_e12">
|
|
$(document).ready(function () {
|
|
$("#e12").select2({tags:["red", "green", "blue"]});
|
|
});
|
|
</script>
|
|
<div class="span4">
|
|
<h3>Tagging Support</h3>
|
|
|
|
<p>Select2 can be used to quickly set up fields used for tagging.</p>
|
|
|
|
<p><input type="hidden" id="e12" style="width:300px" value="brown, red, green"/></p>
|
|
<p>Note that when tagging is enabled the user can select from pre-existing tags or create a new tag by
|
|
picking the first choice which is what the user has typed into the search box so far.</p>
|
|
</div>
|
|
<div class="span8">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e12">
|
|
</pre>
|
|
</div>
|
|
</article>
|
|
<article class="row" id="maximum">
|
|
<script id="script_e23">
|
|
$(document).ready(function () {
|
|
$("#e23").select2({
|
|
tags:["red", "green", "blue"],
|
|
maximumInputLength: 10
|
|
});
|
|
});
|
|
</script>
|
|
<div class="span4">
|
|
<h3>Maximum Input Length</h3>
|
|
|
|
<p>Select2 can be set a limit on the number of characters that can be entered per tag.</p>
|
|
|
|
<p><input type="hidden" id="e23" style="width:300px" value="brown, red, green"/></p>
|
|
<p>You would not be able to enter any input of more than 10 characters long.</p>
|
|
</div>
|
|
<div class="span8">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e23">
|
|
</pre>
|
|
</div>
|
|
</article>
|
|
<article class="row" id="token">
|
|
<script id="script_e20">
|
|
$(document).ready(function () {
|
|
$("#e20").select2({
|
|
tags:["red", "green", "blue"],
|
|
tokenSeparators: [",", " "]});
|
|
});
|
|
</script>
|
|
<div class="span4">
|
|
<h3>Auto Tokenization</h3>
|
|
|
|
<p>Select2 supports ability to add choices automatically as the user is typing into the search field.
|
|
This is especially convenient in the tagging usecase where the user can quickly enter a number of tags
|
|
by separating them with a comma or a space. Try typing in the search field below and entering a space or a comma.</p>
|
|
|
|
<p><input type="hidden" id="e20" style="width:300px" value="brown"/></p>
|
|
<p>Note that the separators are defined in the <a href="#doc-tokenSeparators">tokenSeparators</a> option.</p>
|
|
<p>Note that this example uses the built in <a href="#doc-tokenizer">tokenizer</a> function, but a custom one can be provided in the options.</p>
|
|
</div>
|
|
<div class="span8">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e20">
|
|
</pre>
|
|
</div>
|
|
</article>
|
|
<article class="row" id="event_ext_change">
|
|
<script id="script_e13">
|
|
$(document).ready(function () {
|
|
$("#e13").select2();
|
|
$("#e13_ca").click(function() { $("#e13").val("CA").trigger("change"); });
|
|
$("#e13_ak_co").click(function() { $("#e13").val(["AK","CO"]).trigger("change"); });
|
|
});
|
|
</script>
|
|
<div class="span4">
|
|
<h3>Reacting to external value changes</h3>
|
|
|
|
<p>Select2 can react to external value changes and keep its selection in-sync. This feature allows
|
|
Select2 to work seamlessly with front-end frameworks that use data binding between ui components
|
|
and model values.</p>
|
|
<p><select id="e13" multiple style="width:300px" class="populate"></select><br/></p>
|
|
<p><input type="button" id="e13_ca" class="btn btn-primary" value="Select California"/> <input type="button" id="e13_ak_co" class="btn btn-primary"value="Select Alaska and Colorado"/></p>
|
|
<p class="alert alert-alert">This feature is only available when initSelection() function is provided in
|
|
the options. This function is needed to map the choice ids set on the element to objects used by
|
|
Select2. This function is set by default when Select2 is attached to a <code>select</code> or when
|
|
the <code>tags</code> helper function is used.</p>
|
|
</div>
|
|
<div class="span8">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e13">
|
|
</pre>
|
|
</div>
|
|
</article>
|
|
|
|
<article class="row" id="lifecycle">
|
|
<script id="script_e14">
|
|
$(document).ready(function () {
|
|
$("#e14").val(["AL","AZ"]).select2();
|
|
$("#e14_init").click(function() { $("#e14").select2(); });
|
|
$("#e14_destroy").click(function() { $("#e14").select2("destroy"); });
|
|
});
|
|
</script>
|
|
<div class="span4">
|
|
<h3>Select2 Lifecycle</h3>
|
|
|
|
<p>
|
|
|
|
</p>
|
|
<p><select id="e14" multiple style="width:300px" class="populate"></select><br/></p>
|
|
<p><input type="button" id="e14_init" class="btn btn-primary" value="Init"/> <input type="button" id="e14_destroy" class="btn btn-warning"value="Destroy"/></p>
|
|
</div>
|
|
<div class="span8">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e14">
|
|
</pre>
|
|
</div>
|
|
</article>
|
|
|
|
<article class="row" id="drag_drop">
|
|
<script id="script_e15">
|
|
$(document).ready(function () {
|
|
$("#e15").select2({tags:["red", "green", "blue", "orange", "white", "black", "purple", "cyan", "teal"]});
|
|
$("#e15").on("change", function() { $("#e15_val").html($("#e15").val());});
|
|
|
|
$("#e15").select2("container").find("ul.select2-choices").sortable({
|
|
containment: 'parent',
|
|
start: function() { $("#e15").select2("onSortStart"); },
|
|
update: function() { $("#e15").select2("onSortEnd"); }
|
|
});
|
|
});
|
|
</script>
|
|
<div class="span4">
|
|
<h3>Select2 Drag and Drop Sorting</h3>
|
|
<p>
|
|
Select2 supports drag and drop sorting of selected choices. Select2 does not, itself, provide the necessary code to perform dragging and dropping, instead it provides hooks that other libraries can use to provide the behavior. In this example we are using JQuery UI's <code>sortable()</code> plugin.
|
|
</p>
|
|
<p class="alert alert-info">The sorting is only available when Select2 is attached to a hidden <code>input</code> field.</p>
|
|
<p><input type="hidden" id="e15" style="width:300px;" value="red,green,blue,orange,white,black"/></p>
|
|
<p><div id="e15_val"></div></p>
|
|
</div>
|
|
<div class="span8">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e15">
|
|
</pre>
|
|
</div>
|
|
</article>
|
|
|
|
|
|
<article class="row" id="disabled">
|
|
<script id="script_e16">
|
|
$(document).ready(function () {
|
|
$("#e16").select2();
|
|
$("#e16_2").select2();
|
|
$("#e16_enable").click(function() { $("#e16,#e16_2").select2("enable", true); });
|
|
$("#e16_disable").click(function() { $("#e16,#e16_2").select2("enable", false); });
|
|
$("#e16_readonly").click(function() { $("#e16,#e16_2").select2("readonly", true); });
|
|
$("#e16_writable").click(function() { $("#e16,#e16_2").select2("readonly", false); });
|
|
|
|
});
|
|
</script>
|
|
<div class="span4">
|
|
<h3>Select2 Disabled Mode</h3>
|
|
<p><select disabled="disabled" id="e16" style="width:300px" class="populate"></select><br/></p>
|
|
<p><select disabled="disabled" id="e16_2" multiple style="width:300px" class="populate"></select><br/></p>
|
|
<p><input type="button" id="e16_enable" class="btn btn-primary" value="Enable"/> <input type="button" id="e16_disable" class="btn btn-warning"value="Disable"/></p>
|
|
<p><input type="button" id="e16_writable" class="btn btn-primary" value="Writable"/> <input type="button" id="e16_readonly" class="btn btn-warning"value="Readonly"/></p>
|
|
</div>
|
|
<div class="span8">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e16">
|
|
</pre>
|
|
</div>
|
|
</article>
|
|
|
|
<article class="row" id="matcher">
|
|
<script id="script_e17">
|
|
$(document).ready(function () {
|
|
$("#e17").select2({
|
|
matcher: function(term, text) { return text.toUpperCase().indexOf(term.toUpperCase())==0; }
|
|
});
|
|
// <select id="e17_2" style="width:300px">
|
|
// <option alt="pink">red</option>
|
|
// <option alt="cyan">blue</option>
|
|
// </select>
|
|
$("#e17_2").select2({
|
|
matcher: function(term, text, opt) {
|
|
return text.toUpperCase().indexOf(term.toUpperCase())>=0
|
|
|| opt.attr("alt").toUpperCase().indexOf(term.toUpperCase())>=0;
|
|
}
|
|
});
|
|
});
|
|
</script>
|
|
<div class="span4">
|
|
<h3>Custom Matcher</h3>
|
|
<p>Unlike other dropdowns on this page, this one matches options only if the term appears in the beginning of the string as opposed to anywhere:</p>
|
|
<p><select id="e17" style="width:300px" class="populate"></select><br/></p>
|
|
<p>The dropdown below matches on custom attributes of the <code>option</code> tag. For example, the `blue` option can be matched by entering either `blue` or `cyan`:</p>
|
|
<p><select id="e17_2" style="width:300px"><option alt="pink">red</option><option alt="cyan">blue</option></select></p>
|
|
</div>
|
|
<div class="span8">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e17">
|
|
</pre>
|
|
</div>
|
|
</article>
|
|
|
|
<article class="row" id="sort_results">
|
|
<script id="script_e22">
|
|
$(document).ready(function () {
|
|
$('#e22').select2({
|
|
sortResults: function(results, container, query) {
|
|
if (query.term) {
|
|
// use the built in javascript sort function
|
|
return results.sort(function(a, b) {
|
|
if (a.text.length > b.text.length) {
|
|
return 1;
|
|
} else if (a.text.length < b.text.length) {
|
|
return -1;
|
|
} else {
|
|
return 0;
|
|
}
|
|
});
|
|
}
|
|
return results;
|
|
}
|
|
});
|
|
});
|
|
</script>
|
|
<div class="span4">
|
|
<h3>Sorting Displayed Results</h3>
|
|
<p>Unlike other dropdowns on this page, this one filters results by query string normally, but returns the matched results sorted from shortest to longest by string length. Try typing 'e' and seeing how the results are sorted. This function is useful for sorting results by relevance to a user's query.</p>
|
|
<p>
|
|
<select id="e22" style="width:300px">
|
|
<option value="red">red</option>
|
|
<option value="green">green</option>
|
|
<option value="blue">blue</option>
|
|
</select><br/>
|
|
</p>
|
|
</div>
|
|
<div class="span8">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e22">
|
|
</pre>
|
|
</div>
|
|
</article>
|
|
|
|
<article class="row" id="responsive">
|
|
<script id="script_e18">
|
|
$(document).ready(function () {
|
|
$("#e18,#e18_2").select2();
|
|
});
|
|
</script>
|
|
<div class="span12">
|
|
<h3>Responsive Design - Percent Width</h3>
|
|
<p>Select2's width can be set to a percentage of its parent to support responsive design. The two Select2 boxes below are styled to 50% and 75% width respectively.</p>
|
|
<p><select id="e18" style="width:50%" class="populate"></select><br/></p>
|
|
<p><select multiple="multiple" id="e18_2" style="width:75%" placeholder="Select a state" class="populate placeholder"></select><br/></p>
|
|
<p class="alert alert-warning">Select2 will do its best to resolve the percent width specified via a css class, but it is not always possible. The best way to ensure that Select2 is using a percent based width is to inline the style declaration into the tag.</p>
|
|
</div>
|
|
<div class="span12">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e18">
|
|
</pre>
|
|
</div>
|
|
</article>
|
|
|
|
<article class="row" id="disabled-options">
|
|
<script id="script_e24">
|
|
|
|
$(document).ready(function () {
|
|
$('#e24').select2({
|
|
query: function (query){
|
|
var data = {
|
|
results: [
|
|
{ id: 1, text: "I'm selectable" },
|
|
{ id: 2, text: "I'm a disabled option", disabled: true },
|
|
{ id: 3, text: "I'm selectable too!" }
|
|
]
|
|
};
|
|
|
|
query.callback(data);
|
|
}
|
|
});
|
|
});
|
|
|
|
</script>
|
|
<div class="span12">
|
|
<h3>Disabled options</h3>
|
|
<p>
|
|
In case that you need to disable certain options so that they can't be selected by the select2 interface, you can now pass in <code>disabled: true</code> with your data. Please note: This also works for incoming values from ajax. When attached to a <code><select></code> element, Select2 will respect its <code><option></code> elements' <code>disabled</code> property.
|
|
</p>
|
|
<p>
|
|
<input type="hidden" id="e24" style="width:300px;"/>
|
|
</p>
|
|
</div>
|
|
<div class="span12">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e24">
|
|
</pre>
|
|
</div>
|
|
</article>
|
|
|
|
<article class="row" id="locked-selections">
|
|
<script id="script_e21">
|
|
|
|
var preload_data = [
|
|
{ id: 'user0', text: 'Disabled User', locked: true}
|
|
, { id: 'user1', text: 'Jane Doe'}
|
|
, { id: 'user2', text: 'John Doe', locked: true }
|
|
, { id: 'user3', text: 'Robert Paulson', locked: true }
|
|
, { id: 'user5', text: 'Spongebob Squarepants'}
|
|
, { id: 'user6', text: 'Planet Bob' }
|
|
, { id: 'user7', text: 'Inigo Montoya' }
|
|
];
|
|
|
|
$(document).ready(function () {
|
|
$('#e21').select2({
|
|
multiple: true
|
|
,query: function (query){
|
|
var data = {results: []};
|
|
|
|
$.each(preload_data, function(){
|
|
if(query.term.length == 0 || this.text.toUpperCase().indexOf(query.term.toUpperCase()) >= 0 ){
|
|
data.results.push({id: this.id, text: this.text });
|
|
}
|
|
});
|
|
|
|
query.callback(data);
|
|
}
|
|
});
|
|
$('#e21').select2('data', preload_data )
|
|
});
|
|
|
|
</script>
|
|
<div class="span12">
|
|
<h3>Lock selections</h3>
|
|
<p>
|
|
In the event that you need to lock certain selections so that they can't be removed by the select2 interface, you can now pass in <code>locked: true</code> with your data. Please note: This also works for incoming values from ajax.
|
|
</p>
|
|
<p>
|
|
<input type="hidden" id="e21" style="width:300px;"/>
|
|
</p>
|
|
</div>
|
|
<div class="span12">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e21">
|
|
</pre>
|
|
</div>
|
|
</article>
|
|
|
|
<article class="row" id="diacritics">
|
|
<div class="span12">
|
|
<h3>Diacritics Support</h3>
|
|
<p>Select2's default matcher will ignore diacritics, making it easier for users to filter results in international selects. Type "aero" into the select below:</p>
|
|
<p>
|
|
<select id="e30" multiple="multiple" style="width:300px;">
|
|
<option>Aeróbics</option>
|
|
<option>Aeróbics en Agua</option>
|
|
<option>Aerografía</option>
|
|
<option>Aeromodelaje</option>
|
|
<option>Águilas</option>
|
|
<option>Ajedrez</option>
|
|
<option>Ala Delta</option>
|
|
<option>Álbumes de Música</option>
|
|
<option>Alusivos</option>
|
|
<option>Análisis de Escritura a Mano</option>
|
|
</select>
|
|
<script>
|
|
$(function() {
|
|
$("#e30").select2();
|
|
})
|
|
</script>
|
|
</p>
|
|
</div>
|
|
</article>
|
|
|
|
<article class="row" id="allow_duplicated_tags">
|
|
<div class="span12">
|
|
<h3>Allow duplicated tags</h3>
|
|
<p>In multiple mode, select2 doesn't allow the same tag to be selected more than once. This default behavior can be overridden by implementing the <code>hideSelectionFromResult</code> function:</p>
|
|
<p>
|
|
<select id="e31" multiple="multiple" style="width:300px;">
|
|
<option>Red</option>
|
|
<option>Green</option>
|
|
<option>Blue</option>
|
|
</select>
|
|
</p>
|
|
<script id="script_e25">
|
|
|
|
function hideSelection(selectedObject) {
|
|
return false;
|
|
};
|
|
$('#e31').select2({
|
|
hideSelectionFromResult: hideSelection
|
|
});
|
|
|
|
</script>
|
|
<div class="span12">
|
|
<h3>Example Code</h3>
|
|
<pre class="prettyprint linenums" id="code_e25"></pre>
|
|
</div>
|
|
</div>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
<!-- -->
|
|
<!-- DOCUMENTATION -->
|
|
<!-- -->
|
|
|
|
|
|
<section id="documentation">
|
|
|
|
<div class="row" style="padding-top: 20px;">
|
|
<div class="span12"><h2>Documentation</h2><hr/></div>
|
|
</div>
|
|
|
|
<div class="row">
|
|
<div class="span12"><h3>Constructor</h3></div>
|
|
</div>
|
|
<table class="table table-bordered table-striped">
|
|
<tr>
|
|
<th>Parameter</th><th>Type</th><th>Description</th>
|
|
</tr>
|
|
<tr><td>width</td><td>string</td><td>
|
|
Controls the <code>width</code> style attribute of the Select2 container div. The following values are supported:
|
|
<dl>
|
|
<dt>off</dt><dd>No width attribute will be set. Keep in mind that the container div copies classes from the source element so setting the width attribute may not always be necessary.</dd>
|
|
<dt>element</dt><dd>Uses javascript to calculate the width of the source element.</dd>
|
|
<dt>copy</dt><dd>Copies the value of the width style attribute set on the source element.</dd>
|
|
<dt>resolve</dt><dd>First attempts to <u>copy</u> than falls back on <u>element</u>.</dd>
|
|
<dt>other values</dt><dd>if the width attribute contains a function it will be evaluated, otherwise the value is used verbatim.</dd>
|
|
</dl>
|
|
</td></tr>
|
|
<tr><td>minimumInputLength</td><td>int</td><td>Number of characters necessary to start a search.</td></tr>
|
|
<tr><td>maximumInputLength</td><td>int</td><td>Maximum number of characters that can be entered for an input.</td></tr>
|
|
<tr><td>minimumResultsForSearch</td><td>int</td><td>
|
|
<p>
|
|
The minimum number of results that must be initially (after opening the dropdown for the first time)
|
|
populated in order to keep the search field. This
|
|
is useful for cases where local data is used with just a few results, in which case the search box
|
|
is not very useful and wastes screen space.
|
|
</p>
|
|
<p>The option can be set to a <code>negative value</code> to permanently hide the search field.</p>
|
|
<p class="alert alert-info">Only applies to single-value select boxes</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td>maximumSelectionSize</td><td>int/function</td><td>
|
|
<p>
|
|
The maximum number of items that can be selected in a multi-select control. If this number is less than 1 selection is not limited.
|
|
</p>
|
|
<p>Once the number of selected items reaches the maximum specified the contents of the dropdown will be populated
|
|
by the <code>formatSelectionTooBig</code> function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td>placeholder</td><td>string</td><td>
|
|
<p>Initial value that is selected if no other selection is made.</p>
|
|
<p>The placeholder can also be specified as a <code>data-placeholder</code> attribute on the <code>select</code>
|
|
or <code>input</code> element that Select2 is attached to.
|
|
</p>
|
|
|
|
<p class="alert alert-warning">Note that because browsers assume the first <code>option</code> element
|
|
is selected in non-multi-value select boxes an empty first <code>option</code> element must be provided (<code><option></option></code>)
|
|
for the placeholder to work.
|
|
</p>
|
|
</td></tr>
|
|
<tr><td>placeholderOption</td><td>function/string</td><td>
|
|
<p>When attached to a <code>select</code> resolves the <code>option</code> that should be used as the placeholder.
|
|
Can either be a function which given the <code>select</code> element should return the <code>option</code>
|
|
element or a string <code>first</code> to indicate that the first option should be used.</p>
|
|
<p>This option is useful when Select2's default of using the first option only if it has no value and no text is not suitable.</p>
|
|
</td></tr>
|
|
<tr><td>separator</td><td>string</td><td>
|
|
<p>
|
|
Separator character or string used to delimit ids in <code>value</code> attribute of the multi-valued selects.
|
|
The default delimiter is the <code>,</code> character.
|
|
</p>
|
|
</td></tr>
|
|
<tr>
|
|
<td>allowClear</td>
|
|
<td>boolean</td>
|
|
<td>
|
|
<p>
|
|
Whether or not a clear button is displayed when the select box has a selection. The
|
|
button,
|
|
when clicked, resets the value of the select box back to the placeholder, thus this option is
|
|
only
|
|
available when the placeholder is specified.
|
|
</p>
|
|
<p>This option only works when the placeholder is specified.</p>
|
|
<p class="alert alert-warning">When attached to a <code>select</code> an <code>option</code> with an empty value must be provided.
|
|
This is the option that will be selected when the button is pressed since a select box requires
|
|
at least one selection <code>option</code>.</p>
|
|
<p>
|
|
Also, note that this option only works with
|
|
non-multi-value based selects because multi-value selects always provide such a button for every
|
|
selected option.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>multiple</td>
|
|
<td>boolean</td>
|
|
<td>
|
|
<p>
|
|
Whether or not Select2 allows selection of multiple values.
|
|
</p>
|
|
<p>When Select2 is attached to a <code>select</code> element this value will be ignored and <code>select</code>'s
|
|
<code>multiple</code> attribute will be used instead.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>closeOnSelect</td>
|
|
<td>boolean</td>
|
|
<td>
|
|
<p>
|
|
If set to false the dropdown is not closed after a selection is made, allowing for rapid selection of multiple items. By default this option is set to <code>true</code>.
|
|
</p>
|
|
|
|
<p class="alert alert-info">
|
|
Only applies when configured in multi-select mode.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>openOnEnter</td>
|
|
<td>boolean</td>
|
|
<td>
|
|
<p>
|
|
If set to true the dropdown is opened when the user presses the enter key and Select2 is closed. By default this option is enabled.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td>id</td><td>function</td><td>
|
|
Function used to get the id from the choice object or a string representing the key under which the id is stored.
|
|
<pre>id(object)</pre>
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>object</td><td>object</td><td>A choice object.</td></tr>
|
|
<tr><td><returns></td><td>string</td><td>the id of the object.</td></tr>
|
|
</table>
|
|
The default implementation expects the object to have a <code>id</code> property that is returned.
|
|
</td></tr>
|
|
<tr><td id="doc-matcher">matcher</td><td>function</td><td>
|
|
Used to determine whether or not the search term matches an option when a built-in query function is used.
|
|
The built in query function is used when Select2 is attached to a <code>select</code>, or the <code>local</code> or <code>tags</code> helpers are used.
|
|
<pre>matcher(term, text, option)</pre>
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>term</td><td>string</td><td>search term.</td></tr>
|
|
<tr><td>text</td><td>string</td><td>text of the option being matched.</td></tr>
|
|
<tr><td>option</td><td>jquery object</td>
|
|
<td>the <code>option</code> element we are trying to match. Only given when attached to <code>select</code>.
|
|
Can be used to match against custom attributes on the <code>option</code> tag in addition to matching on the <code>option</code>'s text.</td></tr>
|
|
<tr><td><returns></td><td>boolean</td><td><code>true</code> if search term matches the text, or <code>false</code> otherwise.</td></tr>
|
|
</table>
|
|
The default implementation is case insensitive and matches anywhere in the term:
|
|
<code>function(term, text) { return text.toUpperCase().indexOf(term.toUpperCase())>=0; }</code>
|
|
</td></tr>
|
|
<tr><td id="doc-sort-results">sortResults</td><td>function</td><td>
|
|
Used to sort the results list for searching right before display. Useful for sorting matches by relevance to the user's search term.
|
|
<pre>sortResults(results, container, query)</pre>
|
|
<table class="table table-bordered table-striped">
|
|
<tr><td>object</td><td>object</td><td>One of the result objects returned from the <code>query</code> function</td>.</tr>
|
|
<tr><td>container</td><td>jQuery object</td><td>jQuery wrapper of the node that should contain the representation of the result.</td></tr>
|
|
<tr><td>query</td><td>object</td><td>The query object used to request this set of results.</td></tr>
|
|
<tr><td><returns></td><td>object</td><td>A results object.</td></tr>
|
|
</table>
|
|
Defaults to no sorting:
|
|
<code>function(results, container, query) { return results; }</code>
|
|
</td></tr>
|
|
<tr><td>formatSelection</td><td>function</td><td>
|
|
Function used to render the current selection.
|
|
<pre>formatSelection(object, container)</pre>
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>object</td><td>object</td><td>The selected result object returned from the <code>query</code> function.</td></tr>
|
|
<tr><td>container</td><td>jQuery object</td><td>jQuery wrapper of the node to which the selection should be appended.</td></tr>
|
|
<tr><td>escapeMarkup</td><td>function</td><td>Function that can be used to escape html markup. This is the function defined in the <code>escapeMarkup</code>option, or the default.</td></tr>
|
|
<tr><td><returns></td><td>string (optional)</td><td>Html string, a DOM element, or a jQuery object that renders the selection.</td></tr>
|
|
</table>
|
|
<p>The default implementation expects the object to have a <code>text</code> property that is returned.</p>
|
|
<p>The implementation may choose to append elements directly to the provided <code>container</code> object, or return a single value and have it automatically appended.</p>
|
|
<br><br>
|
|
<p>
|
|
When attached to a <code>select</code> the original <code><option></code> (or <optgroup>) element is accessible inside the specified function through the property <code>item.element</code>:
|
|
<pre>
|
|
format(item) {
|
|
var originalOption = item.element;
|
|
return item.text
|
|
}
|
|
</pre>
|
|
</p>
|
|
</td></tr>
|
|
<tr><td>formatResult</td><td>function</td><td>
|
|
Function used to render a result that the user can select.
|
|
<pre>formatResult(object, container, query)</pre>
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>object</td><td>object</td><td>One of the result objects returned from the <code>query</code> function.</td></tr>
|
|
<tr><td>container</td><td>jQuery object</td><td>jQuery wrapper of the node that should contain the representation of the result.</td></tr>
|
|
<tr><td>query</td><td>object</td><td>The query object used to request this set of results.</td></tr>
|
|
<tr><td>escapeMarkup</td><td>function</td><td>Function used to escape markup in results. If you do not expect to render custom markup you should pass your text through this function to escape any markup that may have been accidentally returned. This function is configurable in options of select2.</td></tr>
|
|
<tr><td><returns></td><td>string (optional)</td><td>Html string, a DOM element, or a jQuery object that represents the result.</td></tr>
|
|
</table>
|
|
<p>The default implementation expects the object to have a <code>text</code> property that is returned.</p>
|
|
<p>The implementation may choose to append elements directly to the provided <code>container</code> object, or return a single value and have it automatically appended.</p>
|
|
<br><br>
|
|
<p>
|
|
When attached to a <code>select</code> the original <code><option></code> (or <optgroup>) element is accessible inside the specified function through the property <code>item.element</code>:
|
|
<pre>
|
|
format(item) {
|
|
var originalOption = item.element;
|
|
return item.text
|
|
}
|
|
</pre>
|
|
</p>
|
|
</td></tr>
|
|
<tr><td>formatResultCssClass</td><td>function</td><td>
|
|
Function used to add css classes to result elements.
|
|
<pre>formatResultCssClass(object)</pre>
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>object</td><td>object</td><td>One of the result objects returned from the <code>query</code> function.</td></tr>
|
|
<tr><td><returns></td><td>string (optional)</td><td>String containing css class names separated by a space.</td></tr>
|
|
</table>
|
|
<p class="alert alert-info">By default when attached to a <code>select</code> css classes from <code>option</code>s will be automatically copied.</p>
|
|
</td></tr>
|
|
<tr><td>formatNoMatches</td><td>string/function</td><td>
|
|
String containing "No matches" message, or<br />
|
|
Function used to render the message
|
|
<pre>formatNoMatches(term)</pre>
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>term</td><td>string</td><td>Search string entered by user.</td></tr>
|
|
<tr><td><returns></td><td>string</td><td>Message html.</td></tr>
|
|
</table>
|
|
</td></tr>
|
|
<tr><td>formatSearching</td><td>string/function</td><td>
|
|
String containing "Searching..." message, or<br />
|
|
Function used to render the message that is displayed while
|
|
search is in progress.
|
|
<pre>formatSearching()</pre>
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td><returns></td><td>string</td><td>Message html or <code>null</code>/<code>undefined</code> to disable the message.</td></tr>
|
|
</table>
|
|
</td></tr>
|
|
<tr><td>formatInputTooShort</td><td>string/function</td><td>
|
|
String containing "Search input too short" message, or<br />
|
|
Function used to render the message.
|
|
<pre>formatInputTooShort(term, minLength)</pre>
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>term</td><td>string</td><td>Search string entered by user.</td></tr>
|
|
<tr><td>minLength</td><td>int</td><td>Minimum required term length.</td></tr>
|
|
<tr><td><returns></td><td>string</td><td>Message html.</td></tr>
|
|
</table>
|
|
</td></tr>
|
|
<tr><td>formatInputTooLong</td><td>string/function</td><td>
|
|
String containing "Search input too long" message, or<br />
|
|
Function used to render the message.
|
|
<pre>formatInputTooLong(term, maxLength)</pre>
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>term</td><td>string</td><td>Search string entered by user.</td></tr>
|
|
<tr><td>maxLength</td><td>int</td><td>Maximum required term length.</td></tr>
|
|
<tr><td><returns></td><td>string</td><td>Message html.</td></tr>
|
|
</table>
|
|
</td></tr>
|
|
<tr><td>formatSelectionTooBig</td><td>string/function</td><td>
|
|
String containing "You cannot select any more choices" message, or<br />
|
|
Function used to render the message.
|
|
<pre>formatSelectionTooBig(maxSize)</pre>
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>maxSize</td><td>string</td><td>The maximum specified size of the selection.</td></tr>
|
|
<tr><td><returns></td><td>string</td><td>Message html.</td></tr>
|
|
</table>
|
|
</td></tr>
|
|
<tr><td>formatLoadMore</td><td>string/function</td><td>
|
|
String containing "Loading more results…" message, or<br />
|
|
Function used to render the message.
|
|
<pre>formatLoadMore(pageNumber)</pre>
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>pageNumber</td><td>string</td><td>The current page.</td></tr>
|
|
<tr><td><returns></td><td>string</td><td>Message html.</td></tr>
|
|
</table>
|
|
</td></tr>
|
|
<tr><td>createSearchChoice</td><td>function</td><td>
|
|
Creates a new selectable choice from user's search term. Allows creation of choices not available via the query
|
|
function. Useful when the user can create choices on the fly, eg for the 'tagging' usecase.
|
|
<pre>createSearchChoice(term)</pre>
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>term</td><td>string</td><td>Search string entered by user.</td></tr>
|
|
<tr><td><returns></td><td>object (optional)</td><td>Object representing the new choice.
|
|
Must at least contain an <code>id</code> attribute.</td></tr>
|
|
</table>
|
|
If the function returns <code>undefined</code> or <code>null</code> no choice will be created. If a new
|
|
choice is created it is displayed first in the selection list so that user may select it by simply pressing
|
|
<code>enter</code>.
|
|
|
|
<p class="alert alert-warning">When used in combination with <code>input[type=hidden]</code> tag care
|
|
must be taken to sanitize the <code>id</code> attribute of the choice object, especially stripping
|
|
<code>,</code> as it is used as a value separator.</p>
|
|
</td></tr>
|
|
<tr><td>createSearchChoicePosition</td><td>string|function</td><td>
|
|
Define the position where to insert element created by <code>createSearchChoice</code>. The following values are supported:
|
|
<dl>
|
|
<dt>top</dt><dd>Insert in the top of the list</dd>
|
|
<dt>bottom</dt><dd>Insert at the end of the list</dd>
|
|
<dt><function></dt>
|
|
<dd>
|
|
<p>A custom function. For example if you want to insert the new item in the second position:</p>
|
|
<pre class="prettyprint">
|
|
$("#tags").select2({
|
|
...
|
|
createSearchChoice: function(term) { ... },
|
|
createSearchChoicePosition: function(list, item) {
|
|
list.splice(1, 0, item);
|
|
}
|
|
});
|
|
</pre>
|
|
</dd>
|
|
</dl>
|
|
</td></tr>
|
|
<tr><td>initSelection</td><td>function</td><td>
|
|
Called when Select2 is created to allow the user to initialize the selection based on the value of the
|
|
element select2 is attached to.
|
|
<p>
|
|
Essentially this is an <code>id->object</code> mapping function.
|
|
</p>
|
|
<pre>initSelection(element, callback)</pre>
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>element</td><td>jQuery array</td><td>element Select2 is attached to.</td></tr>
|
|
<tr><td>callback</td><td>function</td><td>callback function that should be called with the data which is either an object in case of a single select or an array of objects in case of multi-select.</td></tr>
|
|
</table>
|
|
<p class="alert alert-info">This function will only be called when there is initial input to be processed.</p>
|
|
Here is an example implementation used for tags. Tags are the simplest form of data where the id is also
|
|
the text:
|
|
<pre class="prettyprint">
|
|
$("#tags").select2({
|
|
initSelection : function (element, callback) {
|
|
var data = [];
|
|
$(element.val().split(",")).each(function () {
|
|
data.push({id: this, text: this});
|
|
});
|
|
callback(data);
|
|
}
|
|
});
|
|
|
|
// Or for single select elements:
|
|
$("#select").select2({
|
|
initSelection : function (element, callback) {
|
|
var data = {id: element.val(), text: element.val()};
|
|
callback(data);
|
|
}
|
|
});
|
|
</pre>
|
|
</td></tr>
|
|
<tr id="doc-tokenizer"><td>tokenizer</td><td>function</td><td>
|
|
A tokenizer function can process the input typed into the search field after every keystroke and extract
|
|
and select choices. This is useful, for example, in tagging scenarios where the user can create tags quickly
|
|
by separating them with a comma or a space instead of pressing enter.
|
|
<p class="alert alert-info">Tokenizer only applies to multi-selects.</p>
|
|
<pre>tokenizer(input, selection, selectCallback, opts)</pre>
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>input</td><td>string</td><td>The text entered into the search field so far.</td></tr>
|
|
<tr><td>selection</td><td>array</td><td>Array of objects representing the current selection.
|
|
Useful if tokenizer needs to filter out duplicates.</td></tr>
|
|
<tr><td>selectCallback</td><td>function</td><td>Callback that can be used to add objects to the selection.</td></tr>
|
|
<tr><td>opts</td><td>object</td><td>Options with which Select2 was initialized. Useful if tokenizer needs to access some properties in the options.</td></tr>
|
|
<tr><td><returns></td><td>string (optional)</td><td>Returns the string to which the input of
|
|
the search field should be set to. Usually this is the remainder, of any, of the string after
|
|
the tokens have been stripped. If <code>undefined</code> or <code>null</code> is returned the
|
|
input of the search field is unchanged.</td></tr>
|
|
</table>
|
|
|
|
The default tokenizer will only be used if the <code>tokenSeparators</code> and <code>createSearchChoice</code>
|
|
options are specified. The default tokenizer will split the string using any separator in <code>tokenSeparators</code>
|
|
and will create and select choice objects using <code>createSearchChoice</code> option. It will also
|
|
ignore duplicates, silently swallowing those tokens.
|
|
</td></tr>
|
|
<tr id="doc-tokenSeparators"><td>tokenSeparators</td><td>array</td><td>
|
|
An array of strings that define token separators for the default <a href="doc-tokenizer">tokenizer</a>
|
|
function. By default, this option is set to an empty array which means tokenization using the default
|
|
tokenizer is disabled. Usually it is sensible to set this option to a value similar to <code>[',', ' ']</code>.
|
|
</td></tr>
|
|
|
|
<tr id="doc-query">
|
|
<td>query</td>
|
|
<td>function</td>
|
|
<td>
|
|
Function used to query results for the search term.
|
|
<pre>query(options)</pre>
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>options.element</td><td>jquery object</td><td>The element Select2 is attached to.</td></tr>
|
|
<tr><td>options.term</td><td>string</td><td>Search string entered by user.</td></tr>
|
|
<tr><td>options.page</td><td>int</td><td>1-based page number tracked by Select2 for use with infinite scrolling of results.</td></tr>
|
|
<tr><td>options.context</td><td>object</td><td>An object that persists across the lifecycle of queries for the same search term (the query to retrieve the initial results, and subsequent queries to retrieve more result pages for the same search term). When this function is first called for a new search term this object will be null. The user may choose to set any object in the <code>results.context</code> field - this object will then be used as the context parameter for all calls to the <code>query</code> method that will load more search results for the initial search term. The object will be reset back to null when a new search term is queried. This feature is useful when a page number is not easily mapped against the server side paging mechanism. For example, some server side paging mechanism may return a "continuation token" that needs to be passed back to them in order to retrieve the next page of search results.</td></tr>
|
|
<tr id="doc-query-options-callback"><td>options.callback</td><td>function</td>
|
|
<td>Callback function that should be called with the <code>result</code> object. The result object:
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>result.results</td><td>[object]</td><td>Array of result objects. The default renderers expect objects with <code>id</code> and <code>text</code> keys. The <code>id</code> property is required, even if custom renderers are used. The object may also contain a <code>children</code> key if hierarchical data is displayed. The object may also contain a <code>disabled</code> boolean property indicating whether this result can be selected.</td></tr>
|
|
<tr><td>result.more</td><td>boolean</td><td><code>true</code>if more results are available for the current search term.</td></tr>
|
|
<tr><td>results.context</td><td>object</td><td>A user-defined object that should be made available as the <code>context</code> parameter to the <code>query</code> function on subsequent queries to load more result pages for the same search term. See the description of <a href="#doc-query-options-context"><code>options.context</code></a> parameter.</td></tr>
|
|
</table>
|
|
</td></tr>
|
|
</table>
|
|
<p class="alert alert-warning">In order for this function to work Select2 should be attached to a <code>input type='hidden'</code> tag instead of a <code>select</code>.</p>
|
|
<p>
|
|
<h4>Example Data</h4>
|
|
<pre>
|
|
{
|
|
more: false,
|
|
results: [
|
|
{ id: "CA", text: "California" },
|
|
{ id: "AL", text: "Alabama" }
|
|
]
|
|
}
|
|
</pre>
|
|
</p>
|
|
<p>
|
|
<h4>Example Hierarchical Data</h4>
|
|
<pre>
|
|
{
|
|
more: false,
|
|
results: [
|
|
{ text: "Western", children: [
|
|
{ id: "CA", text: "California" },
|
|
{ id: "AZ", text: "Arizona" }
|
|
] },
|
|
{ text: "Eastern", children: [
|
|
{ id: "FL", text: "Florida" }
|
|
] }
|
|
]
|
|
}
|
|
</pre>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td>ajax</td><td>object</td><td>
|
|
Options for the built in ajax query function. This object acts as a shortcut for having to manually write a function that performs ajax requests. The built-in function supports more advanced features such as throttling and dropping out-of-order responses.
|
|
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>transport</td><td>function</td><td>Function that will be used to perform the ajax request. Must be parameter-compatible with <code>$.ajax</code>. Defaults to <code>$.ajax</code> if not specified.
|
|
Allows the use of various ajax wrapper libraries such as: <a href="http://www.protofunc.com/scripts/jquery/ajaxManager/">AjaxManager</a>. </td></tr>
|
|
<tr><td>url</td><td>string/function</td><td>String containing the ajax url or a function that returns such a string.</td></tr>
|
|
<tr><td>dataType</td><td>string</td><td>Data type for the request. <code>xml</code>, <code>json</code>, <code>jsonp</code>, other formats supported by jquery.</td></tr>
|
|
<tr><td>quietMillis</td><td>int</td><td>Number of milliseconds to wait for the user to stop typing before issuing the ajax request.</td></tr>
|
|
<tr><td>cache</td><td>boolean</td><td>If set to <code>false</code>, it will force requested pages not to be cached by the browser. Default is <code>false</code>.</td></tr>
|
|
<tr><td>jsonpCallback</td><td>string/function</td><td>The callback function name for a JSONP request. This value will be used instead of the random name automatically generated by jQuery. It is preferable to let jQuery generate a unique name as it'll make it easier to manage the requests and provide callbacks and error handling. You may want to specify the callback when you want to enable better browser caching of GET requests.</td></tr>
|
|
<tr><td>data</td><td>function</td><td>
|
|
Function to generate query parameters for the ajax request.
|
|
<pre>data(term, page)</pre>
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>term</td><td>string</td><td>Search term.</td></tr>
|
|
<tr><td>page</td><td>int</td><td>1-based page number tracked by Select2 for use with infinite scrolling of results.</td></tr>
|
|
<tr><td>context</td><td>object</td><td>See <a href="#doc-query-options-callback"><code>options.context</code></a> parameter to the <a href="#doc-query"><code>query</code></a> function above.</td></tr>
|
|
<tr><td><returns></td><td>object</td><td>Object containing url parameters.</td></tr>
|
|
</table>
|
|
</td></tr>
|
|
<tr><td>results</td><td>function</td><td>
|
|
Function used to build the query results object from the ajax response
|
|
<pre>results(data, page)</pre>
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>data</td><td>object</td><td>Retrieved data.</td></tr>
|
|
<tr><td>page</td><td>int</td><td>Page number that was passed into the <code>data</code> function above.</td></tr>
|
|
<tr><td>context</td><td>object</td><td>See <a href="#doc-query-options-callback"><code>options.context</code></a> parameter to the <a href="#doc-query"><code>query</code></a> function above.</td></tr>
|
|
<tr><td><returns></td><td>object</td><td>Results object. See "options.callback" in the "query" function for format.</td></tr>
|
|
</table>
|
|
</td></tr>
|
|
<tr><td>params</td><td>object/function</td><td>An object or a function that returns an object that contains extra parameters that will be passed to the transport. For example it can be used to set the content type: <code>{contentType: "application/json;charset=utf-8"}</code></td></tr>
|
|
|
|
</table>
|
|
<p class="alert alert-warning">In order for this function to work Select2 should be attached to a <code>input type='hidden'</code> tag instead of a <code>select</code>.</p>
|
|
<p class="alert alert-info">For documentation of the data format see the <a href="#doc-query">query</a> function.</p>
|
|
</td></tr>
|
|
<tr><td>data</td><td>array/object</td><td>
|
|
Options for the built in query function that works with arrays.
|
|
<p>If this element contains an array, each element in the array must contain <code>id</code> and <code>text</code> keys.</p>
|
|
<p>Alternatively, this element can be specified as an object in which <code>results</code> key must contain the data as an array and a <code>text</code> key can either be the name of the key in data items that contains text or a function that retrieves the text given a data element from the array.</p>
|
|
</td></tr>
|
|
<tr><td>tags</td><td>array/function</td><td>
|
|
Puts Select2 into 'tagging'mode where the user can add new choices and pre-existing tags are provided via
|
|
this options attribute which is either an <code>array</code> or a <code>function</code> that returns an
|
|
array of <code>objects</code> or <code>strings</code>. If <code>strings</code> are used instead of <code>objects</code>
|
|
they will be converted into an object that has an <code>id</code> and <code>text</code> attribute equal
|
|
to the value of the <code>string</code>.
|
|
</td></tr>
|
|
<tr><td>containerCss</td><td>function/object</td><td>
|
|
Inline css that will be added to select2's container. Either an object containing css property/value key pairs or a function that returns such an object.
|
|
</td></tr>
|
|
<tr><td>containerCssClass</td><td>function/string</td><td>
|
|
Css class that will be added to select2's container tag.
|
|
</td></tr>
|
|
<tr><td>dropdownCss</td><td>function/object</td><td>
|
|
Inline css that will be added to select2's dropdown container. Either an object containing css property/value key pairs or a function that returns such an object.
|
|
</td></tr>
|
|
<tr><td>dropdownCssClass</td><td>function/string</td><td>
|
|
Css class that will be added to select2's dropdown container.
|
|
</td></tr>
|
|
<tr><td>dropdownAutoWidth</td><td>boolean</td><td>
|
|
When set to <code>true</code> attempts to automatically size the width of the dropdown based on content inside.
|
|
</td></tr>
|
|
<tr><td>adaptContainerCssClass</td><td>function</td><td>
|
|
Function that filters/renames css classes as they are copied from the source tag to the select2 container tag.
|
|
<pre>adaptContainerCssClass(clazz)</pre>
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>clazz</td><td>string</td><td>Css class being copied.</td></tr>
|
|
<tr><td><returns></td><td>string</td><td>Css class to be applied or <code>null/undefined/''</code> to not apply it.</td></tr>
|
|
</table>
|
|
The default implementation applies all classes without modification.
|
|
</td></tr>
|
|
<tr><td>adaptDropdownCssClass</td><td>function</td><td>
|
|
Function that filters/renames css classes as they are copied from the source tag to the select2 dropdown tag.
|
|
<pre>adaptDropdownCssClass(clazz)</pre>
|
|
<table class="table table-bordered table-striped">
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>clazz</td><td>string</td><td>Css class being copied.</td></tr>
|
|
<tr><td><returns></td><td>string</td><td>Css class to be applied or <code>null/undefined/''</code> to not apply it.</td></tr>
|
|
</table>
|
|
The default implementation always returns <code>null</code> thereby filtering out all classes.
|
|
</td></tr>
|
|
<tr><td>escapeMarkup</td><td>function</td><td>
|
|
<code>String escapeMarkup(String markup)</code>
|
|
<p>Function used to post-process markup returned from formatter functions. By default this function escapes html entities to prevent javascript injection.</p>
|
|
</td></tr>
|
|
<tr><td>selectOnBlur</td><td>boolean</td><td>
|
|
<p>Set to <code>true</code> if you want Select2 to select the currently highlighted option when it is blurred.</p>
|
|
</td></tr>
|
|
<tr><td>loadMorePadding</td><td>integer</td><td>
|
|
Defines how many pixels need to be below the fold before the next page is loaded. The default value is <code>0</code> which means the result list needs to be scrolled all the way to the bottom for the next page of results to be loaded. This option can be used to trigger the load sooner, possibly resulting in a smoother user experience.
|
|
</td></tr>
|
|
<tr><td>nextSearchTerm</td><td>function</td><td>
|
|
<p>Function used to determine what the next search term should be.</p>
|
|
<table class="table table-bordered table-striped">
|
|
<tbody>
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>data</td><td>object</td><td>Retrieved data.</td></tr>
|
|
<tr><td>this.search.val()</td><td>string</td><td>Search term that yielded the current result set.</td></tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Here is an example implementation used to display the current search term when the dropdown is opened:</p>
|
|
<pre class="prettyprint">
|
|
function displayCurrentValue(selectedObject, currentSearchTerm) {
|
|
return currentSearchTerm;
|
|
}
|
|
|
|
$("#e1").select2({
|
|
nextSearchTerm: displayCurrentValue
|
|
});
|
|
</pre>
|
|
<p class="alert alert-info">Function can be used when the dropdown is configured in single and multi-select mode. It is triggered after selecting an item. In single mode it is also triggered after initSelection (when provided).</p>
|
|
</td></tr>
|
|
<tr><td>hideSelectionFromResult</td><td>function</td><td>
|
|
<p>Function that determines if the selected item should be displayed or hidden from the result list.</p>
|
|
<table class="table table-bordered table-striped">
|
|
<tbody>
|
|
<tr><th>Parameter</th><th>Type</th><th>Description</th></tr>
|
|
<tr><td>data</td><td>object</td><td>Selected data.</td></tr>
|
|
</tbody>
|
|
</table>
|
|
<p>By default, the selected item is visible in the result list in single mode and hidden in multi-select mode.
|
|
This behavior can be overridden by implementing the <code>hideSelectionFromResult</code> function.</p>
|
|
<p>For instance, in the case of a single select box it can be used to hide the selected item from the result list:</p>
|
|
<pre class="prettyprint">
|
|
function hideSelectedItem(selectedObject){
|
|
return true;
|
|
}
|
|
|
|
$("#e1").select2({
|
|
hideSelectionFromResult: hideSelectedItem
|
|
})
|
|
</pre>
|
|
<p>More complex behavior can be achieved by reading the text of the selected item:</p>
|
|
<pre class="prettyprint">
|
|
function hideAlaskaFromResult(selectedObject){
|
|
return selectedObject.data("select2-data").text == "Alaska" ? true : false;
|
|
}
|
|
|
|
$("#e1").select2({
|
|
hideSelectionFromResult: hideAlaskaFromResult
|
|
})
|
|
</pre>
|
|
<p class="alert alert-info">The return value of <code>hideSelectionFromResult</code> is a boolean. It returns undefined if it is not implemented.</p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
<div class="row">
|
|
<div class="span12"><h3>val</h3></div>
|
|
</div>
|
|
<p>Gets or sets the selection. If the <code>value</code> parameter is not specified, the <code>id</code> attribute of the currently selected element is returned. If the <code>value</code> parameter is specified it will become the current selection.</p>
|
|
<table class="table table-bordered table-striped">
|
|
<tr>
|
|
<th>Parameter</th><th>Type</th><th>Description</th>
|
|
</tr>
|
|
<tr><td>value (optional)</td><td>object</td><td>
|
|
|
|
<table>
|
|
<tr>
|
|
<th></th><th>Single-Valued</th><th>Multi-Valued</th>
|
|
</tr>
|
|
<tr>
|
|
<th>Attached to <code>select</code></th>
|
|
<td>Value of the <code>value</code> attribute of the <code>option</code> that should be selected.</td>
|
|
<td>Array of the <code>value</code> attributes of the <code>option</code>s that should be selected. <code>null</code> for empty.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Attached to <code>input[type=hidden]</code></th>
|
|
<td>Id of the object that should be selected. <code>""</code> to clear. Can only be used if <code>initSelection()</code> was specified.</td>
|
|
<td>An array of objects ids that should be selected. <code>""</code> to clear. Can only be used if <code>initSelection()</code> was specified.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td></tr>
|
|
<tr><td>triggerChange (optional)</td><td>boolean</td><td>Whether or not a <code>change</code> event should be triggered. <code>false</code> by default.</td></tr>
|
|
</table>
|
|
<p><code>val</code> method invoked on a single-select with an unset value will return <code>""</code>, while a <code>val</code> method invoked on an empty multi-select will return <code>[]</code>.</p>
|
|
|
|
Example: <pre class="prettyprint">alert("Selected value is: "+$("#e8").select2("val")); $("#e8").select2("val", "CA");</pre>
|
|
<p class="alert alert-info">Notice that in order to use this method you must define the <code>initSelection</code> function in the options so Select2 knows how to transform the id of the object you pass in <code>val()</code> to the full object it needs to render selection. If you are attaching to a <code>select</code> element this function is already provided for you.</p>
|
|
|
|
<div class="row">
|
|
<div class="span12"><h3>data</h3></div>
|
|
</div>
|
|
<p>Gets or sets the selection. Analogous to <code>val</code> method, but works with objects instead of ids.</p>
|
|
<p><code>data</code> method invoked on a single-select with an unset value will return <code>null</code>, while a <code>data</code> method invoked on an empty multi-select will return <code>[]</code>.</p>
|
|
|
|
|
|
<div class="row">
|
|
<div class="span12"><h3>destroy</h3></div>
|
|
</div>
|
|
<p>Reverts changes to DOM done by Select2. Any selection done via Select2 will be preserved.</p>
|
|
|
|
<div class="row">
|
|
<div class="span12"><h3>open</h3></div>
|
|
</div>
|
|
<p>Opens the dropdown.</p>
|
|
<div class="row">
|
|
<div class="span12"><h3>close</h3></div>
|
|
</div>
|
|
<p>Closes the dropdown.</p>
|
|
<div class="row">
|
|
<div class="span12"><h3>enable(boolean)</h3></div>
|
|
</div>
|
|
<p>Enables or disables Select2 and its underlying form component based on the boolean parameter.</p>
|
|
<div class="row">
|
|
<div class="span12"><h3>readonly(boolean)</h3></div>
|
|
</div>
|
|
<p>Toggles readonly mode on Select2 and its underlying form component based on the boolean parameter.</p>
|
|
|
|
<div class="row">
|
|
<div class="span12"><h3>container</h3></div>
|
|
</div>
|
|
<p>Retrieves the main container element that wraps all of DOM added by Select2
|
|
Example: <code>console.log($("#tags").select2("container"));</code></p>
|
|
<div class="row">
|
|
<div class="span12"><h3>onSortStart</h3></div>
|
|
</div>
|
|
<p>Notifies Select2 that a drag and drop sorting operation has started. Select2 will hide all non-selection list items such as the search container, etc.
|
|
Example: <code>$("#tags").select2("onSortStart");</code></p>
|
|
<div class="row">
|
|
<div class="span12"><h3>onSortEnd</h3></div>
|
|
</div>
|
|
<p>Notifies Select2 that a drag and drop sorting operation has finished. Select2 will re-display any elements previously hidden and update the selection of the element it is attached to.
|
|
Example: <code>$("#tags").select2("onSortEnd");</code>
|
|
</p>
|
|
|
|
|
|
<div class="row">
|
|
<div class="span12"><h2>Events</h2></div>
|
|
</div>
|
|
|
|
<div class="row">
|
|
<div class="span12">
|
|
<h3>change</h3>
|
|
<p>Fired when selection is changed.</p>
|
|
<p>The event object contains the following custom properties:
|
|
<dl>
|
|
<dt>val</dt><dd>The current selection (taking into account the result of the change) - id or array of ids.</dd>
|
|
<dt>added</dt><dd>The added element, if any - the full element object, not just the id.</dd>
|
|
<dt>removed</dt><dd>The removed element, if any - the full element object, not just the id.</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
<div class="row zebra">
|
|
<div class="span12">
|
|
<h3>select2-opening</h3>
|
|
<p>Fired before the dropdown is shown.</p>
|
|
<p>The event listener can prevent the opening by calling <code>preventDefault()</code> on the supplied event object.</p>
|
|
</div>
|
|
</div>
|
|
<div class="row">
|
|
<div class="span12">
|
|
<h3>select2-open</h3>
|
|
<p>Fired after the dropdown is shown.</p>
|
|
</div>
|
|
</div>
|
|
<div class="row zebra">
|
|
<div class="span12">
|
|
<h3>select2-highlight</h3>
|
|
<p>Fired when a choice is highlighted in the dropdown.</p>
|
|
<p>The event object contains the following custom properties:
|
|
<dl>
|
|
<dt>val</dt><dd>The id of the highlighted choice object.</dd>
|
|
<dt>object</dt><dd>The highlighted choice object.</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
<div class="row">
|
|
<div class="span12">
|
|
<h3>select2-selecting</h3>
|
|
<p>Fired when a choice is being selected in the dropdown, but before any modification has been made to the selection.
|
|
This event is used to allow the user to reject selection by calling <code>event.preventDefault()</code></p>
|
|
<p>The event object contains the following custom properties:
|
|
<dl>
|
|
<dt>val</dt><dd>The id of the highlighted choice object.</dd>
|
|
<dt>object</dt><dd>The choice object about to be selected.</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
<div class="row">
|
|
<div class="span12">
|
|
<h3>select2-clearing</h3>
|
|
<p>Fired when a choice is being cleared in the dropdown, but before any modification has been made to the selection.
|
|
This event is used to allow the user to reject the clear by calling <code>event.preventDefault()</code></p>
|
|
<p>For the clear button to be visible the <code>allowClear</code> option needs to be <code>true</code>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="row zebra">
|
|
<div class="span12">
|
|
<h3>select2-removing</h3>
|
|
<p>Fired when a choice is about to be removed in the dropdown/input, but before any removal of the choice has been made.
|
|
This event is used to allow the user to reject removal by calling <code>event.preventDefault()</code></p>
|
|
<p>The event object contains the following custom properties:
|
|
<dl>
|
|
<dt>val</dt><dd>The id of the removing choice object.</dd>
|
|
<dt>object</dt><dd>The choice object about to be removed.</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
<div class="row zebra">
|
|
<div class="span12">
|
|
<h3>select2-removed</h3>
|
|
<p>Fired when a choice is removed or cleared.</p>
|
|
<p>The event object contains the following custom properties:
|
|
<dl>
|
|
<dt>val</dt><dd>The id of the highlighted choice object.</dd>
|
|
<dt>object</dt><dd>The highlighted choice object.</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
<div class="row">
|
|
<div class="span12">
|
|
<h3>select2-loaded</h3>
|
|
<p>Fired when query function is done loading the data and the results list has been updated</p>
|
|
<p>The event object contains the following custom properties:
|
|
<dl>
|
|
<dt>items</dt><dd>data that was used to populate the results.</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
<div class="row zebra">
|
|
<div class="span12">
|
|
<h3>select2-focus</h3>
|
|
<p>Fired when the control is focussed.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div class="row">
|
|
<div class="span12">
|
|
<h3>select2-blur</h3>
|
|
<p>Fired when the control is blurred.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
<div class="row">
|
|
<div class="span12">
|
|
<h2>Configuring Defaults</h2>
|
|
Select2 exposes its default options via the <code>$.fn.select2.defaults</code> object. Properties changed in this object (same properties configurable through the constructor) will take effect for every instance created after the change.
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<!--
|
|
<div style="position: absolute; left:0; top:0; background: white; border: 1px solid red;" id="focus-spy">hello there</div>
|
|
<script>
|
|
$(document).ready(function() {
|
|
var el=$("#focus-spy");
|
|
$(window).bind("scroll", function(){ el.css({top:$(window).scrollTop()}); });
|
|
var update=function() {
|
|
var a=document.activeElement;
|
|
var b=$(a);
|
|
el.html("tag: "+a.tagName+" id:"+a.id+" class:"+b.attr("class")+" val:"+b.val());
|
|
window.setTimeout(update, 100);
|
|
};
|
|
update();
|
|
});
|
|
</script>
|
|
-->
|