Have ideas to improve npm?Join in the discussion! »

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

    20.0.0 • Public • Published

    <vaadin-list-box>

    Live Demo | API documentation

    <vaadin-list-box> is a Web Component providing reusable list boxes, part of the Vaadin components.

    npm version Published on webcomponents.org Build Status Published on Vaadin Directory Stars on vaadin.com/directory Discord

      <vaadin-list-box selected="2">
        <b>Select an Item</b>
        <vaadin-item>Item one</vaadin-item>
        <vaadin-item>Item two</vaadin-item>
        <hr>
        <vaadin-item>Item three</vaadin-item>
        <vaadin-item>Item four</vaadin-item>
      </vaadin-list-box>

    Screenshot of vaadin-list-box

    Installation

    Install vaadin-list-box:

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

    Once installed, import it in your application:

    import '@vaadin/vaadin-list-box/vaadin-list-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 component with the Lumo theme:

      theme/lumo/vaadin-list-box.js

    • The component with the Material theme:

      theme/material/vaadin-list-box.js

    • Alias for theme/lumo/vaadin-list-box.js:

      vaadin-list-box.js

    Running API docs and tests in a browser

    1. Fork the vaadin-list-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-list-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-list-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-list-box

    DownloadsWeekly Downloads

    13,604

    Version

    20.0.0

    License

    Apache-2.0

    Unpacked Size

    26.1 kB

    Total Files

    12

    Last publish

    Collaborators

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