# vaadin-combo-box

> Polymer element for displaying a list of items with filtering

Latest version **3.0.0-alpha4** (published 2017-09-20) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install vaadin-combo-box
pnpm add vaadin-combo-box
yarn add vaadin-combo-box
bun add vaadin-combo-box
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 3.0.0-alpha4 |
| Published | 2017-09-20 |
| First published | 2017-01-18 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 115 |
| Author | Vaadin Ltd |
| Maintainers | jouni, limonte, manolo, platosha, samiheikki, tomivirkki, vaadin, yuriyyev |
| Keywords | Vaadin, combo-box, web-components, web-component, polymer |

## Links

- npm: https://www.npmjs.com/package/vaadin-combo-box
- Repository: https://github.com/vaadin/vaadin-combo-box
- Homepage: https://vaadin.com/elements
- Issues: https://github.com/vaadin/vaadin-combo-box/issues
- npm.io page: https://npm.io/package/vaadin-combo-box

## Recent versions

- 3.0.0-alpha4 (latest) — 2017-09-20
- 2.0.0 — 2017-07-27
- 2.0.0-beta2 — 2017-07-12
- 2.0.0-alpha4 — 2017-05-24
- 1.3.3 — 2017-04-12
- 1.3.2 — 2017-03-06
- 1.3.0 — 2017-02-16
- 1.3.0-beta1 — 2017-02-07
- 1.2.0 — 2017-01-25
- 1.1.5 — 2017-01-18

## README

![Bower version](https://img.shields.io/bower/v/vaadin-combo-box.svg)
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/vaadin/vaadin-combo-box)
![Polymer 2 supported](https://img.shields.io/badge/Polymer2-supported-blue.svg)
[![Build Status](https://travis-ci.org/vaadin/vaadin-combo-box.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-combo-box)
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vaadin/vaadin-core-elements?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

# &lt;vaadin-combo-box&gt;

[Live Demo ↗](https://cdn.vaadin.com/vaadin-combo-box/3.0.0-alpha3/demo/)
|
[API documentation ↗](https://cdn.vaadin.com/vaadin-combo-box/3.0.0-alpha3/#/elements/vaadin-combo-box)

[&lt;vaadin-combo-box&gt;](https://vaadin.com/elements/-/element/vaadin-combo-box) is a [Polymer](http://polymer-project.org) element combining a dropdown list with an input field for filtering the list of items, part of the [Vaadin Core Elements](https://vaadin.com/elements).

<!--
```
<custom-element-demo height="300">
  <template>
    <script src="../webcomponentsjs/webcomponents-lite.js"></script>
    <link rel="import" href="../iron-ajax/iron-ajax.html">
    <link rel="import" href="../paper-item/all-imports.html">
    <link rel="import" href="vaadin-combo-box.html">
    <next-code-block></next-code-block>
  </template>
</custom-element-demo>
```
-->
```html
<div>
  <style is="custom-style">
    paper-icon-item {
      margin: -13px -16px;
    }
    paper-icon-item img {
      border-radius: 50%;
    }
  </style>
  <template is="dom-bind">
    <iron-ajax url="https://randomuser.me/api?results=100&inc=name,email,picture" last-response="{{response}}" auto></iron-ajax>

    <vaadin-combo-box items="[[response.results]]" item-value-path="email" item-label-path="email">
      <template>
        <paper-icon-item>
          <img src="[[item.picture.thumbnail]]" item-icon>
          <paper-item-body two-line>
            <div>[[item.name.first]] [[item.name.last]]</div>
            <div secondary>[[item.email]]</div>
          </paper-item-body>
        </paper-icon-item>
      </template>
    </vaadin-combo-box>
  </template>
</div>

```

[<img src="https://raw.githubusercontent.com/vaadin/vaadin-combo-box/master/docs/img/vaadin-combo-box-item-template-material.png" width="311" alt="Screenshot of vaadin-combo-box" />](https://vaadin.com/elements/-/element/vaadin-combo-box)


## Running demos and tests in browser

1. Fork the `vaadin-combo-box` repository and clone it locally.

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

1. When in the `vaadin-combo-box` directory, run `npm install` and then `bower install` to install dependencies.

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

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

  - http://127.0.0.1:8080/components/vaadin-combo-box/demo
  - http://127.0.0.1:8080/components/vaadin-combo-box/test


## Running tests from the command line

1. When in the `vaadin-combo-box` directory, run `polymer test`


## Following the coding style

We are using [ESLint](http://eslint.org/) 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.


## Creating a pull request

  - Make sure your code is compliant with our code linters: `gulp lint`
  - Check that tests are passing: `polymer test`
  - [Submit a pull request](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github) with detailed title and description
  - Wait for response from one of Vaadin Elements team members


## License

Apache License 2.0

---
_Source: https://npm.io/package/vaadin-combo-box · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
