RetailCRM-Mirror/select2
1
0
Fork 0
mirror of synced 2025-03-10 22:56:12 +03:00
Code Issues Projects Releases Wiki Activity

Addresses #4583

Browse Source
This commit is contained in:
alexweissman 2017-09-10 21:17:57 -04:00
parent a2482bd416
commit fa1d12582c
1 changed files with 35 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
pages/12.programmatic-control/02.events/docs.md
View File

@ -26,7 +26,7 @@ Select2 will trigger a few different events when different actions are taken usi
All public events are relayed using the jQuery event system, and they are triggered on the `<select>` element that Select2 is attached to. You can attach to them using the [`.on` method](https://api.jquery.com/on/) provided by jQuery: All public events are relayed using the jQuery event system, and they are triggered on the `<select>` element that Select2 is attached to. You can attach to them using the [`.on` method](https://api.jquery.com/on/) provided by jQuery:
``` ```
$('select').on('select2:select', function (e) { $('#mySelect2').on('select2:select', function (e) {
// Do something // Do something
}); });
``` ```
@ -36,8 +36,40 @@ $('select').on('select2:select', function (e) {
When `select2:select` is triggered, data from the selection can ba accessed via the `params.data` property: When `select2:select` is triggered, data from the selection can ba accessed via the `params.data` property:
``` ```
$('select').on('select2:select', function (e) { $('#mySelect2').on('select2:select', function (e) {
console.log(e.params.data) var data = e.params.data;
console.log(data);
});
```
`e.params.data` will return an object containing the selection properties. Any additional data for the selection that was provided in the [data source](/data-sources/formats) will be included in this object as well. For example:
```
{
"id": 1,
"text": "Tyto alba",
"genus": "Tyto",
"species": "alba"
}
```
## Triggering events
You can manually trigger events on a Select2 control using the jQuery [`trigger`](http://api.jquery.com/trigger/) method. However, if you want to pass some data to any handlers for the event, you need to construct a new [jQuery `Event` object](http://api.jquery.com/category/events/event-object/) and trigger on that:
```
var data = {
"id": 1,
"text": "Tyto alba",
"genus": "Tyto",
"species": "alba"
};
$('#mySelect2').trigger({
type: 'select2:select',
params: {
data: data
}
}); });
``` ```