Chosen (v1.1.0)
19 |Chosen has a number of options and attributes that allow you to have full control of your select boxes.
21 | 22 |Options
23 |The following options are available to pass into Chosen on instantiation.
24 | 25 |Example:
26 |
27 | $(".my_select_box").chosen({
28 | disable_search_threshold: 10,
29 | no_results_text: "Oops, nothing found!",
30 | width: "95%"
31 | });
32 |
33 |
34 | | Option | Default | Description | 37 |
|---|---|---|
| allow_single_deselect | 40 |false | 41 |When set to true on a single select, Chosen adds a UI element which selects the first elment (if it is blank). |
42 |
| disable_search | 45 |false | 46 |When set to true, Chosen will not display the search field (single selects only). |
47 |
| disable_search_threshold | 50 |0 | 51 |Hide the search input on single selects if there are fewer than (n) options. | 52 |
| enable_split_word_search | 55 |true | 56 |By default, searching will match on any word within an option tag. Set this option to false if you want to only match on the entire text of an option tag. |
57 |
| inherit_select_classes | 60 |false | 61 |When set to true, Chosen will grab any classes on the original select field and add them to Chosen’s container div. |
62 |
| max_selected_options | 65 |Infinity | 66 |Limits how many options the user can select. When the limit is reached, the chosen:maxselected event is triggered. |
67 |
| no_results_text | 70 |"No results match" | 71 |The text to be displayed when no matching results are found. The current search is shown at the end of the text (e.g., 72 | No results match "Bad Search"). | 73 |
| placeholder_text_multiple | 76 |"Select Some Options" | 77 |The text to be displayed as a placeholder when no options are selected for a multiple select. | 78 |
| placeholder_text_single | 81 |"Select an Option" | 82 |The text to be displayed as a placeholder when no options are selected for a single select. | 83 |
| search_contains | 86 |false | 87 |By default, Chosen’s search matches starting at the beginning of a word. Setting this option to true allows matches starting from anywhere within a word. This is especially useful for options that include a lot of special characters or phrases in ()s and []s. |
88 |
| single_backstroke_delete | 91 |true | 92 |By default, pressing delete/backspace on multiple selects will remove a selected choice. When false, pressing delete/backspace will highlight the last choice, and a second press deselects it. |
93 |
| width | 96 |Original select width. | 97 |The width of the Chosen select box. By default, Chosen attempts to match the width of the select box you are replacing. If your select is hidden when Chosen is instantiated, you must specify a width or the select will show up with a width of 0. | 98 |
| display_disabled_options | 101 |true | 102 |By default, Chosen includes disabled options in search results with a special styling. Setting this option to false will hide disabled results and exclude them from searches. | 103 |
| display_selected_options | 106 |true | 107 |
108 | By default, Chosen includes selected options in search results with a special styling. Setting this option to false will hide selected results and exclude them from searches. 109 |Note: this is for multiple selects only. In single selects, the selected result will always be displayed. 110 | |
111 |
Attributes
115 |Certain attributes placed on the select tag or its options can be used to configure Chosen.
116 | 117 |Example:
118 | 119 |
120 | <select class="my_select_box" data-placeholder="Select Your Options">
121 | <option value="1">Option 1</option>
122 | <option value="2" selected>Option 2</option>
123 | <option value="3" disabled>Option 3</option>
124 | </select>
125 |
126 |
127 | | Attribute | Description | 130 |
|---|---|
| data-placeholder | 133 |
134 | The text to be displayed as a placeholder when no options are selected for a select. Defaults to "Select an Option" for single selects or "Select Some Options" for multiple selects. 135 |Note:This attribute overrides anything set in the |
137 |
| multiple | 140 |The attribute multiple on your select box dictates whether Chosen will render a multiple or single select. |
141 |
| selected, disabled | 144 |Chosen automatically highlights selected options and disables disabled options. | 145 |
Classes
149 |Classes placed on the select tag can be used to configure Chosen.
150 | 151 |Example:
152 | 153 |
154 | <select class="my_select_box chosen-rtl">
155 | <option value="1">Option 1</option>
156 | <option value="2">Option 2</option>
157 | <option value="3">Option 3</option>
158 | </select>
159 |
160 |
161 | | Classname | 164 |Description | 165 |
|---|---|
| chosen-rtl | 168 |
169 | Chosen supports right-to-left text in select boxes. Add the class Note: The |
172 |
Triggered Events
176 |Chosen triggers a number of standard and custom events on the original select field.
177 | 178 |Example:
179 | 180 |
181 | $('.my_select_box').on('change', function(evt, params) {
182 | do_something(evt, params);
183 | });
184 |
185 |
186 | | Event | Description | 189 |
|---|---|
| change | 192 |
193 | Chosen triggers the standard DOM event whenever a selection is made (it also sends a Note: in order to use change in the Prototype version, you have to include the Event.simulate class. The selected and deselected parameters are not available for Prototype. 195 | |
196 |
| chosen:ready | 199 |Triggered after Chosen has been fully instantiated. | 200 |
| chosen:maxselected | 203 |Triggered if max_selected_options is set and that total is broken. |
204 |
| chosen:showing_dropdown | 207 |Triggered when Chosen’s dropdown is opened. | 208 |
| chosen:hiding_dropdown | 211 |Triggered when Chosen’s dropdown is closed. | 212 |
| chosen:no_results | 215 |Triggered when a search returns no matching results. | 216 |
220 | Note: all custom Chosen events (those that being with chosen:) also include the chosen object as a parameter.
221 |
Triggerable Events
224 |You can trigger several events on the original select field to invoke a behavior in Chosen.
225 | 226 |Example:
227 | 228 |
229 | // tell Chosen that a select has changed
230 | $('.my_select_box').trigger('chosen:updated');
231 |
232 |
233 | | Event | Description | 236 |
|---|---|
| chosen:updated | 239 |This event should be triggered whenever Chosen’s underlying select element changes (such as a change in selected options). | 240 |
| chosen:activate | 243 |This is the equivalant of focusing a standard HTML select field. When activated, Chosen will capure keypress events as if you had clicked the field directly. | 244 |
| chosen:open | 247 |This event activates Chosen and also displays the search results. | 248 |
| chosen:close | 251 |This event deactivates Chosen and hides the search results. | 252 |