title: Methods taxonomy:
category: docs
process:
twig: true
Select2 supports methods that allow programmatic control of the component.
To programmatically select a value for a Select2 control, use the jQuery .val()
method:
$('select').val('US'); // Select the option with a value of 'US'
$('select').trigger('change'); // Notify any JS components that the value changed
Select2 will listen for the change
event on the <select>
element that it is attached to. When you make any external changes that need to be reflected in Select2 (such as changing the value), you should trigger this event.
change
eventIt's common for other components to be listening to the change
event, or for custom event handlers to be attached that may have side effects. To limit the scope to only notify Select2 of the change, use the .select2
event namespace:
$('select').val('US'); // Change the value or make some change to the internal state
$('select').trigger('change.select2'); // Notify only Select2 of changes
There are two ways to programmatically access the selection data: using .select2('data')
, or by using a jQuery selector.
data
methodCalling select2('data')
will return a JavaScript array of objects representing the current selection. Each object will contain all of the properties/values that were in the source data objects passed through processResults
and templateResult
callbacks (as in Loading data from an array and Connecting to a remote data source).
$('select').select2('data');
Selected items can also be accessed via the :selected
jQuery selector:
$('select').find(':selected');
It is possible to extend the <option>
elements representing selection with the HTML data-* attributes containing arbitrary data from the source data objects:
$('select').select2({
// ...
templateSelection: function (data, container) {
$(data.element).attr('data-custom-attribute', data.customValue);
return data.text;
}
});
// Retrieve custom attribute value of the first selected element
$('select').find(':selected').attr('data-custom-attribute')
Methods handled directly by Select2 can be invoked by passing the name of the method to .select2(...)
.
The open
method will cause the dropdown menu to open, displaying the selectable options:
$('select').select2('open');
The close
method will cause the dropdown menu to close, hiding the selectable options:
$('select').select2('close');
The destroy
method will remove the Select2 widget from the target element. It will revert back to a standard select
control:
$('select').select2('destroy');
You may clear all current selections in a Select2 control by setting the value of the control to null
:
$('select').val(null).trigger('change');
Multiple select Set to California and Alabama Clear