About the vcf-autocomplete category

Directory vcf-autocomplete
1

vcf-autocomplete: # vcf-autocomplete Web Component
Published on Vaadin Directory

<vcf-autocomplete> is a text input with a panel of suggested options.

Live Demo :arrow_upper_right:

Screenshot of vcf-autocomplete

Usage

Add <vcf-autocomplete> 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-autocomplete id="demo1" label="Choose country" placeholder="Start typing a country name..." options="[[options]]">
  </vcf-autocomplete>

Installation

This components is distributed as Bower packages.

Polymer 2 and HTML Imports compatible version

Install vcf-autocomplete:

bower i vaadin/vcf-autocomplete --save

Once installed, import it in your application:

<link rel="import" href="bower_components/vcf-autocomplete/vcf-autocomplete.html">

Getting Started

Vaadin components use the Lumo theme by default.

The file structure for Vaadin components

  • src/vcf-autocomplete.html

    Unstyled component.

  • theme/lumo/vcf-autocomplete.html

    Component with Lumo theme.

  • vcf-autocomplete.html

    Alias for theme/lumo/vcf-autocomplete.html

Running demos and tests in browser

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

  2. Make sure you have npm installed.

  3. When in the vcf-autocomplete directory, run npm install and then bower install to install dependencies.

  4. Run polymer serve --open, browser will automatically open the component API documentation.

  5. You can also open demo or in-browser tests by adding demo or test to the URL, for example:

Running tests from the command line

  1. When in the vcf-autocomplete directory, run polymer test

Following the coding style

We are using ESLint for linting JavaScript code. You can check if your code is following our standards by running gulp lint, which will automatically lint all .js files as well as JavaScript snippets inside .html files.

Contributing

  • Make sure your code is compliant with our code linters: gulp lint
  • Check that tests are passing: polymer test
  • Submit a pull request with detailed title and description
  • Wait for response from one of Vaadin components team members

Sponsored Development

Major pieces of development of this add-on has been sponsored by multiple customers of Vaadin. Read more about Expert on Demand at: Support and Pricing: Pricing Plans | Vaadin

License

Apache 2. For license terms, see LICENSE.

Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see GitHub - vaadin/vaadin-usage-statistics: Development-time usage statistics collector..