Skip to content

Commit 37dbe05

Browse files
committed
Document DOM events
This closes #4115.
1 parent 7f8e9dc commit 37dbe05

File tree

3 files changed

+59
-1
lines changed

3 files changed

+59
-1
lines changed

docs/_includes/options/events/jquery.html

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,38 @@ <h3>
77
What events will Select2 trigger?
88
</h3>
99

10-
{% include options/not-written.html %}
10+
<p>
11+
Select2 will trigger a few different events when different actions are taken using the component, allowing you to add custom hooks and perform actions.
12+
</p>
13+
14+
<dl class="s2-docs-panels">
15+
<dt>change</dt>
16+
<dd>Triggered whenever an option is selected or removed.</dd>
17+
18+
<dt>select2:close</dt>
19+
<dd>Triggered whenever the dropdown is closed.</dd>
20+
21+
<dt>select2:closing</dt>
22+
<dd>Triggered before the dropdown is closed. This event can be prevented.</dd>
23+
24+
<dt>select2:open</dt>
25+
<dd>Triggered whenever the dropdown is opened.</dd>
26+
27+
<dt>select2:opening</dt>
28+
<dd>Triggered before the dropdown is opened. This event can be prevented.</dd>
29+
30+
<dt>select2:select</dt>
31+
<dd>Triggered whenever a result is selected.</dd>
32+
33+
<dt>select2:selecting</dt>
34+
<dd>Triggered before a result is selected. This event can be prevented.</dd>
35+
36+
<dt>select2:unselect</dt>
37+
<dd>Triggered whenever a selection is removed.</dd>
38+
39+
<dt>select2:unselecting</dt>
40+
<dd>Triggered before a selection is removed. This event can be prevented.</dd>
41+
</dl>
1142

1243
<h3>
1344
How can I attach listeners for these events?

docs/_sass/_dl-panels.scss

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.s2-docs-panels {
2+
dt, dd {
3+
border: 1px solid $panel-default-border;
4+
}
5+
6+
dt {
7+
background-color: $panel-default-heading-bg;
8+
border-top-left-radius: $panel-border-radius;
9+
border-top-right-radius: $panel-border-radius;
10+
padding: 5px 7.5px;
11+
}
12+
13+
dd {
14+
background-color: $panel-bg;
15+
border-bottom-left-radius: $panel-border-radius;
16+
border-bottom-right-radius: $panel-border-radius;
17+
margin-bottom: 0.75em;
18+
padding: 7.5px;
19+
}
20+
21+
dt + dd {
22+
border-top: none;
23+
}
24+
}

docs/css/s2-docs.scss

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
---
33

4+
@import "vendor/bootstrap/variables";
5+
46
@import "result-repository";
57
@import "sidenav";
68
@import "hamburger";
@@ -19,3 +21,4 @@
1921
@import "prettify";
2022
@import "syntax-highlighting";
2123
@import "typography";
24+
@import "dl-panels";

0 commit comments

Comments
 (0)