@freshleafmedia/multi-list-control v1.1.1

Multi-List-Control

Overview

A wrapper around a HTML multi-select to provide:

• Selecting items by adding and removing items from a visual list
• Drag and Drop ordering
• Adding suggested options via AJAX

Install

npm install multi-list-control

Usage

import MultiListControl from 'multi-list-control';

const el = document.querySelector('#mySelect');
new MultiListControl(el);

Available Options

Specify options as an object as the second parameter e.g. new MultiListControl(el, options)

ajaxOptions

Type: Function Default: null

A function executed when performing a suggestions search.

The MultiListControl instance is available as the first parameter, and as this.

Example:

new MultiListControl(el, {
  ajaxOptions: (multiListControl, query, callback) => {
    Axios.get('ajax?query=' + query).then(response => {
      callback(response.data);
    })
  },
});

maxSelected

Type: Integer Default: null

Specifies the max number of items to allow to be selected.

Example:

new MultiListControl(el, {
  maxSelected: 3
});

searchDebounce

Type: Integer Default: 300

Number of milliseconds to debounce the search suggestions

Example:

new MultiListControl(el, {
  searchDebounce: 300
});

markup.item

Type: Function Default: Function

A function that returns the template used for the markup of each list item

Example:

new MultiListControl(el, {
  markup: {
    item: option => `<div class="MultiList__Item"><span>${option.name}</span><span class="MultiList__Close">x</span></div>`
  }
});

data

Type: Array Default: null

A list of keys of additional data to accept. The data can be read from a data-attribute and from an ajax response.

The data can be used when rendering using the markup option, and can be retreived when using the getSelected method

new MultiListControl(el, {
  data: ['description']
});

strings

Type: Object

A list of strings that are used in the component.

The example below lists the defaults.

new MultiListControl(el, {
  strings: {
    searchPlaceholder: 'Search...',
    maxSelectedError: 'You cannot select more than # items',
    noneSelected: 'No items selected'
  }
});

Supported Browsers

• Chrome
• Firefox
• Edge
• Safari
• Opera
• Internet Explorer 11

Methods

getSelected()

Return: Map

Returns a Map of selected options

const multiList = new MultiListControl(el);
multiList.getSelected();

// Returns: Map([{id: 1, name: 'item'}])

reset()

Resets the selected items to its initial state, and resets the selector's search

const multiList = new MultiListControl(el);
multiList.reset();