diff options
| author | Manolo Carrasco <manolo@apache.org> | 2015-01-21 23:28:24 -0800 |
|---|---|---|
| committer | Sauli Tähkäpää <sauli@vaadin.com> | 2015-05-21 14:42:07 +0300 |
| commit | 5759ee06e8fbdc2caeb912d614ec5a42834d009d (patch) | |
| tree | caeef1516f932f5d96909054cf4b13e82d1c5a22 /README.md | |
| download | vaadin-core-5759ee06e8fbdc2caeb912d614ec5a42834d009d.tar.gz vaadin-core-5759ee06e8fbdc2caeb912d614ec5a42834d009d.zip | |
Release version 0.2-snapshot.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..d7dabce --- /dev/null +++ b/README.md @@ -0,0 +1,72 @@ +# Vaadin Components + +A set of high-quality Web Components built using Polymer. + +Learn more about [Vaadin Components.](https://vaadin.com/labs-components/) + +For contributions and issues, see the project's [Github Repository.](https://github.com/vaadin/components/) + +## Installation +- Bower +```shell +$ bower install vaadin-components#0.3.0 +``` +```html +<!-- Import web component polyfills and the component you want into your HTML --> +<head> + ... + <script src="bower_components/webcomponentsjs/webcomponents-lite.js"></script> + <link href="bower_components/vaadin-components/vaadin-grid/vaadin-grid.html" rel="import"> + ... +</head> +``` +- CDN +```html +<!-- Import web component polyfills and the component you want into your HTML --> +<head> + ... + <script src="https://cdn.vaadin.com/vaadin-components/0.3.0/webcomponentsjs/webcomponents-lite.js"></script> + <link href="https://cdn.vaadin.com/vaadin-components/0.3.0/vaadin-grid/vaadin-grid.html" rel="import"> + ... +</head> +``` +- Downloading the zip archive + - Head over to https://vaadin.com/download#components + - Download the version you wish to use + - Extract the zip under your project folder +```html +<!-- Import web component polyfills and the component you want into your HTML --> +<head> + ... + <script src="deps/vaadin-components/webcomponentsjs/webcomponents-lite.js"></script> + <link href="deps/vaadin-components/vaadin-grid.html" rel="import"> + ... +</head> +``` +## Usage +```html +<!-- After adding the required imports, just add a <v-grid> into your HTML --> +<v-grid> + <table> + <colgroup> + <col header-text="Name"> + <col header-text="Value"> + <col header-text="Progress"> + </colgroup> + <tbody> + <tr> + <td>Grid</td> + <td>10000</td> + <td>0.8</td> + </tr> + <tr> + <td>Vaadin X</td> + <td>999999</td> + <td>0.8</td> + </tr> + </tbody> + </table> +</v-grid> +``` + +For more detailed examples on usage, see the [components-examples](https://tomivirkki.github.io/components-examples) |