@vaadin-component-factory/vcf-autocomplete/README.md

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

# <vcf-autocomplete>

[![npm version](https://badgen.net/npm/v/@vaadin-component-factory/vcf-autocomplete)](https://www.npmjs.com/package/@vaadin-component-factory/vcf-autocomplete)
[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadin-component-factoryvcf-autocomplete)

This is the npm version [vcf-autocomplete](https://github.com/vaadin-component-factory/vcf-autocomplete) developed using Lit.

[Live demo ↗](https://vcf-autocomplete.netlify.com)
|
[API documentation ↗](https://vcf-autocomplete.netlify.com/api/#/elements/Vaadin.VcfAutocomplete)

![screenshot](https://user-images.githubusercontent.com/3392815/67003977-ea44cd80-f0e7-11e9-971c-175bdc31407c.gif)

## Important information about versioning

Earlier releases used the Vaadin major version as the component major version (for example, `24.x`), which does not follow Semantic Versioning guidelines.

As part of restoring a proper semantic versioning scheme:

- The existing `24.x` web component version should be considered as version **2.x**.
- If any fixes or adjustments are needed for that version, they will be released as **2.x** (not `24.x`).
- New development for Vaadin 25 continues in the **3.x** major line.

## Installation

Install `vcf-autocomplete`:

```sh
npm i @vaadin-component-factory/vcf-autocomplete --save
```

## Usage

Once installed, import it in your application:

```js
import '@vaadin-component-factory/vcf-autocomplete';
```

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.

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

## Running demo

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

1. Make sure you have [npm](https://www.npmjs.com/) installed.

1. When in the `vcf-autocomplete` directory, run `npm install` to install dependencies.

1. Run `npm start` to open the demo.

## Contributing

To contribute to the component, please read [the guideline](https://github.com/vaadin/vaadin-core/blob/master/CONTRIBUTING.md) first.

## License

Apache License 2