JSPM – tree-multiselect@2.4.1

Package Exports

tree-multiselect

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tree-multiselect) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

jQuery Tree Multiselect

This plugin allows you to add a sweet treeview frontend to a select element. The underlying select element can be used as it was before.

Requires jQuery v1.8+
Does not work on IE8. Pull requests welcome!

Demo

My website has a simple demo running.

Usage

Make sure your select has the multiple attribute set. Also, make sure you've got <meta charset="UTF-8"> or some of the symbols may look strange.

Options on your select

Option Attribute name	Description
`selected`	Have the option pre-selected. This is actually part of the HTML spec
`readonly`	User cannot modify the value of the option. Option can be selected (ex. `<option selected readonly ...`)
`data-section`	The section the option will be in; can be nested
`data-description`	A description of the attribute; will be shown on the multiselect
`data-index`	For pre-selected options, display options in this order, lowest index first. Conflicts will be overwritten by the last item with the same `data-index`

All of the above are optional.

Your data-section can have multiple section names, separated by the sectionDelimiter option.

Ex. data-section="top/middle/inner" will show up as

top
- middle
  - inner
    - your option

The JavaScript

$("select").treeMultiselect();

And now with some params.

$("select").treeMultiselect({searchable: true});

function treeOnChange(allSelectedItems, addedItems, removedItems) {
  console.log("something changed!");
}

$("select").treeMultiselect({
  allowBatchSelection: false,
  onChange: treeOnChange,
  startCollapsed: true
});

The function returns returns an array of objects, each of which contains two functions, remove and reload. remove removes the tree, and reload reinitializes the tree from its select element. User-changed options will be lost!

var trees = $("select").treeMultiselect();
var firstTree = trees[0];

// remove the tree
firstTree.remove();

// or, change the select element with new options, then...
firstTree.reload();

Params

Name	Default	Description
`allowBatchSelection`	`true`	Sections have checkboxes which when checked, check everything within them
`collapsible`	`true`	Adds collapsibility to sections
`enableSelectAll`	`false`	Enables selection of all or no options
`selectAllText`	`Select All`	Only used if `enableSelectAll` is active
`unselectAllText`	`Unselect All`	Only used if `enableSelectAll` is active
`freeze`	`false`	Disables selection/deselection of options; aka display-only
`hideSidePanel`	`false`	Hide the right panel showing all the selected items
`onChange`	`null`	Callback for when select is changed. Called with (allSelectedItems, addedItems, removedItems), each of which is an array of objects with the properties `text`, `value`, `initialIndex`, and `section`
`onlyBatchSelection`	`false`	Only sections can be checked, not individual items
`sortable`	`false`	Selected options can be sorted by dragging (requires jQuery UI)
`searchable`	`false`	Allows searching of options
`searchParams`	`['value', 'text', 'description', 'section']`	Set items to be searched. Array must contain `'value'`, `'text'`, or `'description'`, and/or `'section'`
`sectionDelimiter`	`/`	Separator between sections in the select option `data-section` attribute
`showSectionOnSelected`	`true`	Show section name on the selected items
`startCollapsed`	`false`	Activated only if `collapsible` is true; sections are collapsed initially

Installation

Load jquery.tree-multiselect.min.js on to your web page. The css file is optional (but recommended).

You can also use bower - bower install tree-multiselect

FAQ

Help! The first element is selected when I create the tree. How do I make the first element not selected? You didn't set the multiple attribute on your select. This is a property of single-option select nodes - the first option is selected.

License

MIT licensed.