@vaadin-component-factory/vcf-autosuggest

Web Component with a text input that provides a panel of suggested options.

Usage no npm install needed!

<script type="module">
  import vaadinComponentFactoryVcfAutosuggest from 'https://cdn.skypack.dev/@vaadin-component-factory/vcf-autosuggest';
</script>

README

<vcf-autosuggest>

Gitter npm version Published on Vaadin Directory

This is the npm version vcf-autosuggest developed using Polymer 3.

Live demo ↗ | API documentation ↗

screenshot

Installation

Install vcf-autosuggest:

npm i @vaadin-component-factory/vcf-autosuggest --save

Usage

Once installed, import it in your application:

import '@vaadin-component-factory/vcf-autosuggest';

Add <vcf-autosuggest> to the page. In attribute options you should declare options that will be offered for user to select. All change listener to the element in which you will update options appribute.

<vcf-autosuggest id="demo1" label="Choose country" placeholder="Start typing a country name..." options="[[options]]">
</vcf-autosuggest>

Running demo

  1. Fork the vcf-autosuggest repository and clone it locally.

  2. Make sure you have npm installed.

  3. When in the vcf-autosuggest directory, run npm install to install dependencies.

  4. Run npm start to open the demo.

Contributing

To contribute to the component, please read the guideline first.

License

Apache License 2