monster.ui.countrySelector()
Syntax
monster.ui.countrySelector($target[, args]);
Parameters
| Key | Description | Type | Default | Required |
|---|---|---|---|---|
$target | jQuery object that references a <select> element on which the list will be rendered. | jQuery | true | |
args | Additional arguments to initialize the selector. | Object(#args) | false |
args
| Key | Description | Type | Default | Required |
|---|---|---|---|---|
selectedValues | One or more country codes that will be selected on load. | `String | Array` | [] |
options | Configuration options for this helper. | Object(#options) | false |
options
The helper options supports the ones available for the jQuery Chosen plugin, as well as a custom option named showEmptyOption. This parameter is a boolean which indicates whether to add an empty item to the choices list. Having this empty option allows the control to have an empty state.
Return value
An object representing the jQuery Chosen instance that manages the list of countries.
Errors
"$target" is not a jQuery object:$targetis not a jQuery element"$target" is not a select input:$targetdoes not reference a<select>HTML element"args" is not a plain object:argsis defined but not a plain object"args.selectedValues" is not a string nor an array:args.selectedValuesis defined but not a string neither an array"args.options" is not a plain object:args.optionsis defined but not a plain object
Description
This helper will transform a select input field into a list of selectable countries. It makes use of the monster.ui.chosen() helper under the hood, to make it easier for the user to search and select countries.