<vaadin-grid>
Live Demo
<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, model) => {
root.textContent = `${model.item.address.street}, ${model.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>
Installation
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.js
-
The component with the Material theme:
theme/material/vaadin-grid.js
-
Alias for
theme/lumo/vaadin-grid.js
:vaadin-grid.js
Running demos and tests in a browser
-
Fork the
vaadin-grid
repository and clone it locally. -
Make sure you have node.js 12.x installed.
-
Make sure you have npm installed.
-
When in the
vaadin-grid
directory, runnpm install
to install dependencies. -
Run
npm start
, browser will automatically open the component API documentation. -
You can also open visual tests, for example:
Running tests from the command line
- When in the
vaadin-upload
directory, runnpm test
Running tests from the command line
- When in the
vaadin-grid
directory, runpolymer test
Debugging tests in the browser
- 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.