aboutsummaryrefslogtreecommitdiffstats
# Vaadin Elements [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vaadin/vaadin-elements?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) Vaadin Elements is an evolving set of custom HTML elements, built using [Polymer](https://www.polymer-project.org), for building mobile and desktop web applications in modern browsers. ### Component examples and documentation View live examples and source code side-by-side for individual custom elements. | Component | Description | | --- | --- | | [<**vaadin-grid**>](https://github.com/vaadin/vaadin-grid) · [Examples](https://cdn.vaadin.com/vaadin-elements/latest/vaadin-grid/demo/) · [API](https://cdn.vaadin.com/vaadin-elements/latest/vaadin-elements/apidoc/#vaadin-grid) | Data grid for showing large amounts of tabular data. | ### Quickstart Get a quick test-drive of the custom elements by forking one of the following JSFiddles: - <**vaadin-grid**> - [Data generated on-the-fly](http://jsfiddle.net/jounik/tvk1235r/) - [JSON data from a URL](http://jsfiddle.net/jounik/tLour4gv/) ### Installation We offer three ways to use Vaadin Elements in your project: Bower, CDN and ZIP archive. The only difference between the options is the URL you use to import the necessary files into your HTML page. #### 1. Create a new folder for your project ```shell $ mkdir my-project $ cd my-project ``` #### 2. Install Vaadin Elements - ##### Bower We recommend using [Bower](http://bower.io) for managing your front-end dependencies. Follow the [Bower installation instructions](http://bower.io/#install-bower), then run the following command inside your project folder to install the most recent stable release. ```shell $ bower install --save vaadin-elements ``` This will download Vaadin Elements and its dependencies to the `bower_components` folder inside your project's folder. If you wish to use the development snapshot version of some component, you can install/update that separately: ```shell $ bower install --save vaadin-grid#master ``` - ##### CDN You can use Vaadin Elements from CDN (see example below). This is especially convenient for services like JSFiddle, Codepen.io, etc. For example, to import vaadin-grid, use the following URL: `https://cdn.vaadin.com/vaadin-elements/latest/vaadin-grid/vaadin-grid.html` To import all Vaadin Elements, use the following URL: `https://cdn.vaadin.com/vaadin-elements/latest/vaadin-elements/vaadin-elements.html` > You can also use the nightly snapshot versions of any component, e.g. https://cdn.vaadin.com/vaadin-elements/master/vaadin-grid/vaadin-grid.html - ##### Download ZIP 1. Download the latest ZIP archive from [vaadin.com/download](https://vaadin.com/download#elements) 2. Extract the archive under your project folder, for example `deps` #### 3. Create a HTML file Create a new HTML file inside your project folder and copy the following code into it (choose one of the options how to import Vaadin Elements in the `` section): > **Serving the files during development**, when using Bower or the ZIP archive: > Due to browser security restrictions, serving HTML imports from a `file:///` URL does not work. You need a web server to view pages where you use custom elements. One simple option is to use the [`serve`](https://www.npmjs.com/package/serve) NPM package. ```html
```