<multi-value-suggestbox>

A Polymer custom element that allows selection of multiple suggestions

Demo

Check it live!

Install

Install the component using Bower:

$ bower install multi-value-suggestbox --save

Or download as ZIP.

Usage

1. Import Web Components' polyfill:

   <script src="bower_components/platform/platform.js"></script>

2. Import Custom Element:

   <link rel="import" href="bower_components/multi-value-suggestbox/dist/multi-value-suggestbox.html">

3. Start using it!

   <multi-value-suggestbox></multi-value-suggestbox>

Options

Attribute	Options	Default	Description
options.box_width	string	200px	Width of the input box
options.box_height	string	40px	Height of the input box
options.allow_space	bool	false	Whether spaces are accepted
options.allow_nonmatching	bool	false	Whether non-suggested values are accepted

Methods

Method	Parameters	Returns	Description
resetSuggestions()	None.	Nothing.	Removes all suggestions currently displayed in the menu.
setFocus()	None.	Nothing.	Sets focus to the element's text input field.

Events

Event	Description
input-changed	Triggers whenever the value in the text input box is changed by user.

Fields

Attribute	Options	Description
suggestions	array	Suggestions currently displayed
selectedItems	array	Items selected or entered by user

Development

In order to run it locally you'll need to fetch some dependencies and a basic server setup.

• Install Bower & Grunt:

  $ [sudo] npm install -g bower grunt-cli

• Install local dependencies:

  $ bower install && npm install

• To test your project, start the development server and open http://localhost:8000.

  $ grunt server

• To build the distribution files before releasing a new version.

  $ grunt build

• To provide a live demo, send everything to gh-pages branch.

  $ grunt deploy

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -m 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

History

For detailed changelog, check Releases.

License

BSD License