https://github.com/vaadin-component-factory/vcf-autocomplete

Text input with a panel of suggested options.
https://github.com/vaadin-component-factory/vcf-autocomplete

Last synced: 24 days ago
JSON representation

Text input with a panel of suggested options.

• Host: GitHub
• URL: https://github.com/vaadin-component-factory/vcf-autocomplete
• Owner: vaadin-component-factory
• License: apache-2.0
• Created: 2019-05-02T11:40:22.000Z (about 6 years ago)
• Default Branch: polymer-3
• Last Pushed: 2024-07-22T09:18:40.000Z (10 months ago)
• Last Synced: 2024-11-07T04:44:50.272Z (7 months ago)
• Language: JavaScript
• Size: 1.15 MB
• Stars: 2
• Watchers: 10
• Forks: 10
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# <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 Polymer 3.

[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)

## 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 `` 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

```

## 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.

## 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: https://vaadin.com/pricing

## License

Apache License 2