README.md

chosen-remote-source

Provides remote data source support for chosen-js selects.

To make this library future proof we try not to change or add hardly any code to original chosen-js code.

Install

Yarn or NPM

yarn add chosen-remote-source

npm install chosen-remote-source

Usage

$('select.chosen-remote-source').chosenRemoteSource({
  url: "/my-path",
  method: "GET",
  delay: 250,
  event: 'input',
  label_field: 'label',
  value_field: 'value',
  search_param: 'q',
  selected_param: 'selected',
});

Now upon entering text the remote URL will be used to create an AJAX query to update the select options.

The ajax request will send the following parameter names according to the specified search_param and selected_param options.

{q: 'foo', selected: [1,6,8]}

The plugins expects that your URL will return an array of objects with attribute names according to the specified value_field and label_field options.

[
  {
    value: "1",
    label: "Foo",
  },

  {
    value: "2",
    label: "Bar",
  },
  
  /* ... */
]

Contributing

Testing is handled within ./index.html

Credits

Created by Weston Ganger - @westonganger