vaadin-grid is a free, high quality data grid / data table Web Component. Part of the Vaadin components.
Switch branches/tags
Clone or download
Latest commit 0d7db13 Dec 12, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demo Demo cleanup Nov 27, 2018
src 5.3.0-alpha6 Dec 12, 2018
test fix: heightByRows resizing (#1515) Dec 11, 2018
theme Let the content part in vaadin-grid-sorter shrink Nov 15, 2018
.eslintrc.json re-enabling eslint, and make it pass Aug 31, 2017
.gemini.yml Added visual tests for Material theme. Sep 3, 2018
.gitignore Update .gitignore Aug 27, 2018
.npmrc Disable package-lock.json Nov 30, 2017
.stylelintrc Add stylelint and lint:css Gulp task Dec 28, 2016
.travis.yml Added visual tests for Material theme. Sep 3, 2018
ISSUE_TEMPLATE.md Update live demo link to use Glitch in the issue template [skip ci] (#… Jul 26, 2018
LICENSE Add a bundle for all imports Mar 28, 2017
README.md Add sort columns to readme snippet Oct 29, 2018
all-imports.html Migrate Valo to Lumo Jan 11, 2018
bower.json chore(bower): add src imports to main for modulizer [skip ci] (#1516) Dec 12, 2018
gulpfile.js Fixed end of line problem with gulp-html-extract plugin on Windows. Jul 5, 2018
index.html typo Aug 28, 2017
magi-p3-post.json Pin webcomponentsjs to 2.0.0 for Polymer 3 and Firefox 61 Jul 27, 2018
package.json 5.3.0-alpha6 Dec 12, 2018
screenshot.png Updated example screenshot. Dec 21, 2017
vaadin-directory-description.md Update directory example snippet Nov 23, 2018
vaadin-grid-column-group.html Migrate Valo to Lumo Jan 11, 2018
vaadin-grid-column.html Migrate Valo to Lumo Jan 11, 2018
vaadin-grid-filter-column.html Add convenience vaadin-grid-filter-column helper element Sep 25, 2018
vaadin-grid-filter.html Migrate Valo to Lumo Jan 11, 2018
vaadin-grid-selection-column.html Migrate Valo to Lumo Jan 11, 2018
vaadin-grid-sort-column.html Add convenience vaadin-grid-sort-column helper element Sep 26, 2018
vaadin-grid-sorter.html Migrate Valo to Lumo Jan 11, 2018
vaadin-grid-tree-column.html Add convenience vaadin-grid-tree-column helper element Sep 26, 2018
vaadin-grid-tree-toggle.html Migrate Valo to Lumo Jan 11, 2018
vaadin-grid.html Migrate Valo to Lumo Jan 11, 2018
wct.conf.js Revert Firefox, only use headless Chrome for now Jul 26, 2018

README.md

npm version Published on webcomponents.org Build Status Gitter

Published on Vaadin  Directory Stars on vaadin.com/directory

<vaadin-grid>

Live Demo ↗ | API documentation ↗

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

  <vaadin-grid theme="row-dividers" column-reordering-allowed multi-sort>
    <vaadin-grid-selection-column auto-select frozen></vaadin-grid-selection-column>
    <vaadin-grid-sort-column width="9em" path="firstName"></vaadin-grid-sort-column>
    <vaadin-grid-sort-column width="9em" path="lastName"></vaadin-grid-sort-column>
    <vaadin-grid-column id="addresscolumn" width="15em" flex-grow="2" header="Address"></vaadin-grid-column>
  </vaadin-grid>

  <script>
    // Customize the "Address" column's renderer
    document.querySelector('#addresscolumn').renderer = (root, grid, rowData) => {
      root.textContent = `${rowData.item.address.street}, ${rowData.item.address.city}`;
    };

    // Populate the grid with data
    const grid = document.querySelector('vaadin-grid');
    fetch('https://demo.vaadin.com/demo-data/1.0/people?count=200')
      .then(res => res.json())
      .then(json => grid.items = json.result);
  </script>

Screenshot of vaadin-grid, using the default Lumo theme

Installation

The Vaadin components are distributed as Bower and npm packages. Please note that the version range is the same, as the API has not changed. You should not mix Bower and npm versions in the same application, though.

Unlike the official Polymer Elements, the converted Polymer 3 compatible Vaadin components are only published on npm, not pushed to GitHub repositories.

Polymer 2 and HTML Imports Compatible Version

Install vaadin-grid:

bower i vaadin/vaadin-grid --save

Once installed, import it in your application:

<link rel="import" href="bower_components/vaadin-grid/vaadin-grid.html">

Polymer 3 and ES Modules Compatible Version

Install vaadin-grid:

npm i @vaadin/vaadin-grid --save

Once installed, import it in your application:

import '@vaadin/vaadin-grid/vaadin-grid.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-grid.html

  • The component with the Material theme:

    theme/material/vaadin-grid.html

  • Alias for theme/lumo/vaadin-grid.html:

    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:

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.

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.