\n
\n Chosen - Prototype Version (v1.8.7)
\n \n
Chosen is a Prototype plugin that makes long, unwieldy select boxes much more user-friendly.
\n\n
\n Downloads\n Project Source\n Contribute\n
\n\n
Looking for the jQuery version?
\n\n
\n
\n
\n Turns This\n \n
\n
\n Into This\n \n
\n
\n\n
\n
\n
\n Turns This\n \n
\n
\n Into This\n \n
\n
\n\n
\n
\n
\n Single Select with Groups\n \n
\n
\n Multiple Select with Groups\n \n
\n
\n\n
\n
\n
Chosen automatically highlights selected options and removes disabled options.
\n
\n Single Select\n \n
\n
\n Multiple Select\n \n
\n
\n\n
\n
\n
The disable_search_threshold option can be specified to hide the search input on single selects if there are n or fewer options.
\n
new Chosen($(\"chosen_select_field\"),{disable_search_threshold: 10});
\n
\n
\n \n
\n
\n\n
\n
\n
Chosen automatically sets the default field text (\"Choose a country...\") by reading the select element's data-placeholder value. If no data-placeholder value is present, it will default to \"Select an Option\" or \"Select Some Options\" depending on whether the select is single or multiple. You can change these elements in the plugin js file as you see fit.
\n
<select data-placeholder=\"Choose a country...\" multiple class=\"chosen-select\">
\n
Note: on single selects, the first element is assumed to be selected by the browser. To take advantage of the default text support, you will need to include a blank option as the first element of your select list.
\n
\n\n
\n
\n
Setting the \"No results\" search text is as easy as passing an option when you create Chosen:
\n
new Chosen($(\"chosen_select_field\"),{no_results_text: \"Oops, nothing found!\"});
\n\n
\n Single Select\n \n
\n
\n Multiple Select\n \n
\n
\n\n
\n
\n
You can easily limit how many options the user can select:
\n
new Chosen($(\"chosen_select_field\"),{max_selected_options: 5});
\n
If you try to select another option with limit reached chosen:maxselected event is triggered:
\n
$(\"chosen_select_field\").observe(\"chosen:maxselected\", function(evt) { ... });
\n
\n\n
\n
\n
When a single select box isn't a required field, you can set allow_single_deselect: true and Chosen will add a UI element for option deselection. This will only work if the first option has blank text.
\n
\n \n
\n
\n\n
\n
\n
You can set right-to-left text by setting rtl: true
\n
$(\".chosen-select\").chosen({rtl: true});
\n
\n Single Right-to-Left Select\n \n
\n
\n Multiple Right-to-Left Select\n \n
\n
\n\n
\n
\n
\n - \n
Observing Form Field Changes
\n When working with form fields, you often want to perform some behavior after a value has been selected or deselected. Whenever a user selects a field in Chosen, it triggers a \"change\" event on the original form field. That lets you do something like this:
\n $(\"#form_field\").chosen().change( … );
\n Note: Prototype doesn't offer support for triggering standard browser events. Event.simulate is required to trigger the change event when using the Prototype version.
\n \n - \n
Updating Chosen Dynamically
\n If you need to update the options in your select field and want Chosen to pick up the changes, you'll need to trigger the \"chosen:updated\" event on the field. Chosen will re-build itself based on the updated content.
\n Event.fire($(\"form_field\"), \"chosen:updated\");
\n \n - \n
Destroying Chosen
\n To destroy Chosen and revert back to the native select, call destroy on the Chosen instance:
\n chosen = new Chosen($(\"form_field\"));\n\n// ...later\nchosen.destroy();
\n \n
\n
\n\n
\n
\n
Using a custom width with Chosen is as easy as passing an option when you create Chosen:
\n
new Chosen($(\"chosen_select_field\"),{width: \"95%\"});
\n
\n Single Select\n \n
\n
\n Multiple Select\n \n
\n
\n\n
\n
\n
Use labels just like you would a standard select
\n
\n
\n \n \n
\n
\n \n \n
\n
\n\n
\n
Using Chosen is easy as can be.
\n
\n - Download the plugin and copy the chosen files to your app.
\n - Activate the plugin by creating a new instance of Chosen: New Chosen(some_form_field,some_options);
\n - Disco.
\n
\n\n
\n
\n - \n
Do you have all the available options documented somewhere?
\n Yes! You can find them on the options page.
\n \n - \n
Something doesn't work. Can you fix it?
\n Yes! Please report all issues using the GitHub issue tracking tool. Please include the plugin version (jQuery or Prototype), browser and OS. The more information provided, the easier it is to fix a problem.
\n \n - \n
What browsers are supported?
\n All modern desktop browsers are supported (Firefox, Chrome, Safari and IE9). Legacy support for IE8 is also enabled. Chosen is disabled on iPhone, iPod Touch, and Android mobile devices (more information).
\n \n
\n\n
\n\n
\n\n
\n\n