vaadin-grid

<vaadin-grid>

Live Demo ↗ | API documentation ↗

<vaadin-grid> is a free, high quality data grid / data table Polymer element, part of the Vaadin components.

<dom-bind>
  <template>
    <iron-ajax auto url="https://demo.vaadin.com/demo-data/1.0/people?count=20" handle-as="json" last-response="{{users}}"></iron-ajax>

    <vaadin-grid theme="row-dividers" items="[[users.result]]" column-reordering-allowed multi-sort>

      <vaadin-grid-selection-column auto-select frozen> </vaadin-grid-selection-column>

      <vaadin-grid-column width="9em">
        <template class="header">
          <vaadin-grid-sorter path="firstName">First Name</vaadin-grid-sorter>
        </template>
        <template>[[item.firstName]]</template>
      </vaadin-grid-column>

      <vaadin-grid-column width="9em">
        <template class="header">
          <vaadin-grid-sorter path="lastName">Last Name</vaadin-grid-sorter>
        </template>
        <template>[[item.lastName]]</template>
      </vaadin-grid-column>

      <vaadin-grid-column width="15em" flex-grow="2">
        <template class="header">
          <vaadin-grid-sorter path="address.street">Address</vaadin-grid-sorter>
        </template>
        <template>[[item.address.street]], [[item.address.city]]</template>
      </vaadin-grid-column>

    </vaadin-grid>
  </template>
</dom-bind>

Getting Started

Vaadin components use the Lumo theme by default.

The file structure for Vaadin components

• src/vaadin-grid.html

  Unstyled component.

• theme/lumo/vaadin-grid.html

  Component with Lumo theme.

• vaadin-grid.html

  Alias for theme/lumo/vaadin-grid.html

Running demos and tests in browser

1. Fork the vaadin-grid repository and clone it locally.

2. Make sure you have npm installed.

3. When in the vaadin-grid directory, run npm install and then bower install to install dependencies.

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

5. 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-grid/demo
• http://127.0.0.1:8080/components/vaadin-grid/test

Running tests from the command line

1. When in the vaadin-grid directory, run polymer test

Following the coding style

We are using ESLint 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 with detailed title and description
• Wait for response from one of Vaadin components team members

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.