/vaadin-grid

vaadin-grid is a free, high quality data grid / data table element, built using Polymer

Primary LanguageHTMLApache License 2.0Apache-2.0

Bower version Published on webcomponents.org Build Status Coverage Status Gitter

<vaadin-grid> v2

Live Demo ↗

👀 Looking for <vaadin-grid> v1.x? Please see the the v1 branch

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

<template is="dom-bind">
  <x-data-provider data-provider="{{dataProvider}}"></x-data-provider>

  <vaadin-grid data-provider="[[dataProvider]]" size="200">

    <vaadin-grid-column width="50px" flex-grow="0">
      <template class="header">#</template>
      <template>[[index]]</template>
    </vaadin-grid-column>

    <vaadin-grid-column width="50px" flex-grow="0">
      <template class="header"></template>
      <template>
        <iron-image src="[[item.picture.thumbnail]]"></iron-image>
      </template>
    </vaadin-grid-column>

    <vaadin-grid-column width="calc(50% - 100px)">
      <template class="header">First Name</template>
      <template>[[item.name.first]]</template>
    </vaadin-grid-column>

    <vaadin-grid-column width="calc(50% - 100px)">
      <template class="header">Last Name</template>
      <template>[[item.name.last]]</template>
    </vaadin-grid-column>

  </vaadin-grid>
</template>

Contributing

  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 to install dependencies.

Running demos and tests in browser

  1. Install polyserve: npm install -g polyserve

  2. When in the vaadin-grid directory, run polyserve --open, browser will automatically open the component API documentation.

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

Running tests from the command line

  1. Install web-component-tester: npm install -g web-component-tester

  2. When in the vaadin-grid directory, run wct or npm 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: npm test
  • Submit a pull request with detailed title and description
  • Wait for response from one of Vaadin Elements team members

License

Apache License 2.0