Options

Available Options

Header

Either a boolean value denoting whether or not to display the header, or a string value. If you pass a string, the default "check all", "uncheck all", and "close" links will be replaced with the specified text.
Default: true

---

Height

Height of the checkbox container (scroll area) in pixels. If set to "auto", the height will calculate based on the number of checkboxes in the menu.
Default: 175

---

minWidth

Minimum width of the entire widget in pixels. Setting to "auto" will disable.
Default: 225

---

checkAllText

The text of the "check all" link.
Default: "Check all"

---

uncheckAllText

The text of the "uncheck all" link.
Default: "Uncheck All"

---

noneSelectedText

The default text the select box when no options have been selected.
Default: "Select options"

---

selectedText

The text to display in the select box when options are selected (if selectedList is false). A pound sign (#) will automatically replaced by the number of checkboxes selected. If two pound signs are present in this parameter, the second will be replaced by the total number of checkboxes available. Example: "# of # checked". This parameter also accepts an anonymous function with three arguments: the number of checkboxes checked, the total number of checkboxes, and an array of the checked checkbox DOM elements. See examples for usage.
Default: "# selected"

---

selectedList

A numeric (or boolean to disable) value denoting whether or not to display the checked opens in a list, and how many. A number greater than 0 denotes the maximum number of list items to display before switching over to the selectedText parameter. A value of 0 or false is disabled.
Default: false

---

show

The name of the effect to use when the menu opens. To control the speed as well, pass in an array: ['slide', 500]
Default: Empty string

---

hide

The name of the effect to use when the menu closes. To control the speed as well, pass in an array: ['explode', 500]
Default: Empty string

---

autoOpen

A boolean value denoting whether or not to automatically open the menu when the widget is initialized.
Default: false

---

multiple

If set to false, the widget will use radio buttons instead of checkboxes, forcing users to select only one option.
Default: true

---

classes

Additional class(es) to apply to BOTH the button and menu for further customization. Separate multiple classes with a space. You'll need to scope your CSS to differentiate between the button/menu: css /* button / .ui-multiselect.myClass {} / menu */ .ui-multiselect-menu.myClass {}
Default: Empty string

---

position

This option allows you to position the menu anywhere you'd like relative to the button; centered, above, below (default), etc. Also provides collision detection to flip the menu above the button when near the bottom of the window. If you do not set this option or if the position utility has not been included, the menu will open below the button. Requires the jQuery UI position utility and jQuery 1.4.3+. Please see this demo for usage instructions.
Default: {}

---

appendTo

Selector for the element under which the multiselect elements should be added.
Default: "body"

---

menuWidth

Sets a width for the menu after the button is clicked. Useful if you have long text options or there was limited space for the select.
Default: Default matches the button width.