Wondering what’s next for npm?Check out our public roadmap! »

    @vaadin/vaadin-combo-box
    TypeScript icon, indicating that this package has built-in type declarations

    20.0.0 • Public • Published

    npm latest version Published on webcomponents.org Build Status Coverage Status Gitter

    Published on Vaadin  Directory Stars on vaadin.com/directory

    <vaadin-combo-box>

    Live Demo | API documentation

    <vaadin-combo-box> is a Web Component combining a dropdown list with an input field for filtering the list of items, part of the Vaadin components.

    <vaadin-combo-box label="User" placeholder="Please select" item-value-path="email" item-label-path="email"></vaadin-combo-box>
    
    <script>
      const comboBox = document.querySelector('vaadin-combo-box');
    
      fetch('https://randomuser.me/api?results=100&inc=name,email')
        .then(res => res.json())
        .then(json => comboBox.items = json.results);
    </script>

    Screenshot of vaadin-combo-box

    Installation

    Install vaadin-combo-box:

    npm i @vaadin/vaadin-combo-box --save

    Once installed, import it in your application:

    import '@vaadin/vaadin-combo-box/vaadin-combo-box.js';

    Getting Started

    Vaadin components use the Lumo theme by default.

    To use the Material theme, import the correspondent file from the theme/material folder.

    Entry points

    • The components with the Lumo theme:

      theme/lumo/vaadin-combo-box.js theme/lumo/vaadin-combo-box-light.js

    • The components with the Material theme:

      theme/material/vaadin-combo-box.js theme/material/vaadin-combo-box-light.js

    • Alias for theme/lumo/vaadin-combo-box.js theme/lumo/vaadin-combo-box-light.js

      vaadin-combo-box.js vaadin-combo-box-light.js

    Running API docs and tests in a browser

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

    2. Make sure you have node.js 12.x installed.

    3. Make sure you have npm installed.

    4. When in the vaadin-combo-box directory, run npm install to install dependencies.

    5. Run npm start, browser will automatically open the component API documentation.

    6. You can also open visual tests, for example:

    Running tests from the command line

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

    Debugging tests in the browser

    1. Run npm run debug, then choose manual mode (M) and open the link in browser.

    Following the coding style

    We are using ESLint for linting JavaScript code. You can check if your code is following our standards by running npm run lint, which will automatically lint all .js files.

    Big Thanks

    Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs.

    Contributing

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

    License

    Apache License 2.0

    Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.

    Install

    npm i @vaadin/vaadin-combo-box

    DownloadsWeekly Downloads

    19,427

    Version

    20.0.0

    License

    Apache-2.0

    Unpacked Size

    144 kB

    Total Files

    31

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar