chosen
Web icon

Chosen

Stable version 1.1.5 (Compatible with OutSystems 11)
Other versions available for 10 and Older
Uploaded
 on 30 September 2020
 by 
4.8
 (21 ratings)
chosen

Chosen

Documentation
1.1.5

Options


The following options are available to pass into Chosen on instantiation.


allow_single_deselect (default: false)

When set to true on a single select, Chosen adds a UI element which selects the first element (if it is blank).

disable_search (default: false)

When set to true, Chosen will not display the search field (single selects only).

disable_search_threshold (default: 0)

Hide the search input on single selects if there are n or fewer options.

enable_split_word_search (default: true)

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.

inherit_select_classes (default: false)

When set to true, Chosen will grab any classes on the original select field and add them to Chosen’s container div.

max_selected_options (default: Infinity)

Limits how many options the user can select. When the limit is reached, the  chosen:maxselected event is triggered.

no_results_text (default: "No results match")

The text to be displayed when no matching results are found. The current search is shown at the end of the text (e.g., No results match "Bad Search").

placeholder_text_multiple (default: "Select Some Options")

The text to be displayed as a placeholder when no options are selected for a multiple select.

placeholder_text_single (default: "Select an Option")

The text to be displayed as a placeholder when no options are selected for a single select.

search_contains (default: false)

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.

single_backstroke_delete (default: true)

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.

width (default: Original select width.)

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.

display_disabled_options (default: true)

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.

display_selected_options (default: true)

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. Note: this is for multiple selects only. In single selects, the selected result will always be displayed.

include_group_label_in_selected (default: false)

By default, Chosen only shows the text of a selected option. Setting this option to  true will show the text and group (if any) of the selected option.

max_shown_results (default: Infinity)

Only show the first (n) matching options in the results. This can be used to increase performance for selects with very many options.

case_sensitive_search (default: false)

By default Chosen's search is case-insensitive. Setting this option to true makes the search case-sensitive.

hide_results_on_select (default: true)

By default Chosen's results are hidden after a option is selected. Setting this option to false will keep the results open after selection. This only applies to multiple selects.

rtl (default: false)

Chosen supports right-to-left text in select boxes. Set this option to true to support right-to-left text options.