diff options
author | Sauli Tähkäpää <sauli.tahkapaa@outlook.com> | 2015-10-20 14:28:43 +0300 |
---|---|---|
committer | Sauli Tähkäpää <sauli.tahkapaa@outlook.com> | 2015-10-20 14:28:43 +0300 |
commit | 36353716586b5ad46fd5bedbd2abdceaaa3b78e5 (patch) | |
tree | bdcc3d93033df14898d476c3589d4eba939d18ec /README.md | |
parent | dfc3d914fad86afde3a343190a04d9ae559eeac2 (diff) | |
parent | 5b2e35b8351e1a911a3f9881346a591a3d03be48 (diff) | |
download | vaadin-core-36353716586b5ad46fd5bedbd2abdceaaa3b78e5.tar.gz vaadin-core-36353716586b5ad46fd5bedbd2abdceaaa3b78e5.zip |
Merge pull request #19 from vaadin/rename_components
Rename components to Elements
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 40 |
1 files changed, 20 insertions, 20 deletions
@@ -1,8 +1,8 @@ -# Vaadin Components +# Vaadin Elements -[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vaadin/vaadin-components?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) or [discuss on the vaadin.com forum](https://vaadin.com/forum/#!/category/9848927/) +[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vaadin/vaadin-elements?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) or [discuss on the vaadin.com forum](https://vaadin.com/forum/#!/category/9848927/) -Vaadin Components 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. +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 @@ -10,7 +10,7 @@ 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-components/latest/vaadin-grid/demo/) · [API](https://cdn.vaadin.com/vaadin-components/latest/vaadin-components/apidoc/#vaadin-grid) | Data grid for showing large amounts of tabular data. | +| [<**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 @@ -23,7 +23,7 @@ View live examples and source code side-by-side for individual custom elements. ### Installation -We offer three ways to use Vaadin Components 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. +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 @@ -32,17 +32,17 @@ We offer three ways to use Vaadin Components in your project: Bower, CDN and ZIP $ cd my-project ``` -#### 2. Install Vaadin Components +#### 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-components + $ bower install --save vaadin-elements ``` - This will download Vaadin Components and its dependencies to the `bower_components` folder inside your project's folder. + 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: @@ -52,27 +52,27 @@ We offer three ways to use Vaadin Components in your project: Bower, CDN and ZIP - ##### CDN - You can use Vaadin Components from CDN (see example below). This is especially convenient for services like JSFiddle, Codepen.io, etc. + 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-components/latest/vaadin-grid/vaadin-grid.html` + `https://cdn.vaadin.com/vaadin-elements/latest/vaadin-grid/vaadin-grid.html` - To import all Vaadin Components, use the following URL: + To import all Vaadin Elements, use the following URL: - `https://cdn.vaadin.com/vaadin-components/latest/vaadin-components/vaadin-components.html` + `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-components/master/vaadin-grid/vaadin-grid.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#components) + 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 Components in the `<head>` section): + 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 `<head>` section): > **Serving the files during development**, when using Bower or the ZIP archive: @@ -82,19 +82,19 @@ We offer three ways to use Vaadin Components in your project: Bower, CDN and ZIP <!doctype html> <html> <head> - <!-- Import Web Component polyfills and all Vaadin Components --> + <!-- Import Web Component polyfills and all Vaadin Elements --> <!-- CDN --> - <script src="https://cdn.vaadin.com/vaadin-components/latest/webcomponentsjs/webcomponents-lite.min.js"></script> - <link href="https://cdn.vaadin.com/vaadin-components/latest/vaadin-components/vaadin-components.html" rel="import"> + <script src="https://cdn.vaadin.com/vaadin-elements/latest/webcomponentsjs/webcomponents-lite.min.js"></script> + <link href="https://cdn.vaadin.com/vaadin-elements/latest/vaadin-elements/vaadin-elements.html" rel="import"> <!-- Bower --> <!-- <script src="bower_components/webcomponentsjs/webcomponents-lite.min.js"></script> - <link href="bower_components/vaadin-components/vaadin-components.html" rel="import"> --> + <link href="bower_components/vaadin-components/vaadin-elements.html" rel="import"> --> <!-- ZIP archive --> <!-- <script src="deps/webcomponentsjs/webcomponents-lite.min.js"></script> - <link href="deps/vaadin-components/vaadin-components.html" rel="import"> --> + <link href="deps/vaadin-elements/vaadin-elements.html" rel="import"> --> </head> <body> |