Skip to content

westonganger/chosen-remote-source

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 

chosen-remote-source

NPM Version NPM Downloads

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