Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/vaadin/vaadin-grid

vaadin-grid is a free, high quality data grid / data table Web Component. Part of the Vaadin components.
https://github.com/vaadin/vaadin-grid

custom-elements data-grid data-table vaadin web-component webcomponents

Last synced: 4 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/vaadin/vaadin-grid
Owner: vaadin
License: apache-2.0
Created: 2015-01-21T22:40:01.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2024-03-16T22:51:04.000Z (4 months ago)
Last Synced: 2024-03-17T07:23:08.840Z (4 months ago)
Topics: custom-elements, data-grid, data-table, vaadin, web-component, webcomponents
Language: HTML
Homepage: https://vaadin.com/components
Size: 35.3 MB
Stars: 398
Watchers: 36
Forks: 156
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-stars - vaadin-grid - grid is a free, high quality data grid / data table Web Component. Part of the Vaadin components. | vaadin | 398 | (HTML)

README

        # <vaadin-grid>

> ⚠️ Starting from Vaadin 20, the source code and issues for this component are migrated to the [`vaadin/web-components`](https://github.com/vaadin/web-components/tree/master/packages/vaadin-grid) monorepository.

> This repository contains the source code and releases of `` for the Vaadin versions 10 to 19.

[<vaadin-grid>](https://vaadin.com/components/vaadin-grid) is a free, high quality data grid / data table Web Component, part of the [Vaadin components](https://vaadin.com/components).

[Live Demo ↗](https://vaadin.com/components/vaadin-grid/html-examples)

|

[API documentation ↗](https://vaadin.com/components/vaadin-grid/html-api)

[![npm version](https://badge.fury.io/js/%40vaadin%2Fvaadin-grid.svg)](https://badge.fury.io/js/%40vaadin%2Fvaadin-grid)

[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/vaadin/vaadin-grid)

[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadinvaadin-grid)

[![Discord](https://img.shields.io/discord/732335336448852018?label=discord)](https://discord.gg/PHmkCKC)

```html

  

    

    

    

    

  

  

    // 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);

  

```

[](https://vaadin.com/components/vaadin-grid)

## 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`:

```sh

bower i vaadin/vaadin-grid --save

```

Once installed, import it in your application:

```html

```

### Polymer 3 and ES Modules Compatible Version

Install `vaadin-grid`:

```sh

npm i @vaadin/vaadin-grid --save

```

Once installed, import it in your application:

```js

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 a browser

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

1. Make sure you have [npm](https://www.npmjs.com/) and [Bower](https://bower.io) installed.

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

1. Run `npm start`, browser will automatically open the component API documentation.

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

  - http://127.0.0.1:3000/components/vaadin-grid/demo

  - http://127.0.0.1:3000/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](http://eslint.org/) 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 as well as JavaScript snippets inside `.html` files.

## Big Thanks

Cross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs](https://saucelabs.com).

## Contributing

  To contribute to the component, please read [the guideline](https://github.com/vaadin/vaadin-core/blob/master/CONTRIBUTING.md) 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.