Chosen

Use the Chosen library with Editor for complex select input options.

Chosen is a jQuery plug-in that makes long, unwieldy select boxes much more user-friendly.

Note that Chosen displays its drop down select element inside the Editor display controller. This can have the visual effect of having access to the select control potentially limited. The Select2 and Selectize libraries do not have this issue.

Plug-in configuration and API

Options

This field type supports the following options, in addition to the default field-options configuration:

  • object options: - The values and labels to be used in the Chosen list. This can be given in a number of different forms:
    • object - Name / value pairs, where the property name is used as the label and the value as the field value. For example: { "Edinburgh": 51, "London": 76, ... }.
    • array - An array of objects with the properties label and value defined. For example: [ { label: "Edinburgh", value: 51 }, { label: "London", value: 76 } ].
    • array - An array of values (e.g. numbers, strings etc). Each element in the array will be used for both the label and the value. For example: [ "Edinburgh", "London" ].
  • object opts: Chosen initialisation options object. Please refer to the Chosen documentation for the full range of options available.
  • object attr: Attributes that are applied to the select element before Chosen is initialised

Methods

This plug-in does not provide any additional methods over those available for the all fields (see field()).

License required

The Editor plug-ins are available to download for licensed users of Editor only. If you already have an Editor license, please . Otherwise, an Editor license can be purchased to be able to access the plug-ins.