Polymer Introduction

From WikiOD

Remarks[edit | edit source]

The Polymer project consists of:

  • Polymer library: Polymer is a lightweight library that helps you take full advantage of Web Components. With Web Components, you can create reusable custom elements that interoperate seamlessly with the browser’s built-in elements, or break your app up into right-sized components, making your code cleaner and less expensive to maintain.
  • WebComponents Polyfill: WebComponents Polyfill is a future targeted library aimed at fulfilling the W3C web components specifications. Browsers that fully implement the specification do not need webcomponents.js. However, most browsers are still missing some part of the spec, so this will be a dependency for quite some time.
  • Polymer App Toolbox: Polymer App Toolbox helps you build and deliver cutting-edge Progressive Web Apps with minimal overhead and payload, by leveraging powerful web platform features like Web Components, Service Worker and HTTP/2. The Toolbox provides a component-based architecture, responsive layouts, a modular router, localization support, turnkey support for local storage and offline caching, and efficient delivery of unbundled app resources. Adopt these features individually, or use them together to build a full-featured Progressive Web App. Polymer sprinkles a bit of sugar over the standard Web Components APIs, making it easier for you to get great results. The Polymer library provides a set of features for creating custom elements. These features are designed to make it easier and faster to make custom elements that work like standard DOM elements. Similar to standard DOM elements, Polymer elements can be:

Versions[edit | edit source]

Version Release Date
v2.0.0 2017-05-15
v1.7.0 2016-09-28
v1.6.1 2016-08-01
v1.6.0 2016-06-29
v1.5.0 2016-05-31
v1.4.0 2016-05-18
v1.0.0 2015-05-27

Basic Element Structure[edit | edit source]

We got the following very basic element my-element saved as src/my-element.html

<link rel="import" href="bower_components/polymer/polymer.html">

<dom*module id="my-element">

  <template>
    <style>
      /* local styles go here */
      :host {
        display: block;
      }
    </style>
    <!-- local DOM goes here -->
    <content></content>
  </template>

  <script>
    Polymer({
      /* this is the element's prototype */
      is: 'my-element'
    });
  </script>

</dom-module>
  • The <link> includes the Polymer library using an HTML import.
  • The <dom-module> is the local DOM wrapper for the element (in this case, my-element).
  • The <template> is the actual local DOM definition.
  • The <style> inside the <template> lets you define styles that are scoped to this element and its local DOM and will not affect anything else in the document.
  • The <content> will hold anything you place inside your element.
  • The :host pseudo class matches the custom element (my-element).
  • The Polymer call registers the element.
  • The is Property is the element's name (it has to match the <dom-module>'s id)

You can import it in your app using:

<link rel="import" href="src/my-element.html">

And use it as a tag:

<my-element>Content</my-element>

Setting up your first polymer app from a Template[edit | edit source]

Let's set yourself up to build your own awesome Progressive Web App with Polymer!

Before you can start installing Polymer you require the following:

Node.js - check out the StackOverflow Installing Node.js Documentation

Bower - you can install Bower using the Node Package Manager installed with Node.js:

npm install -g bower

Installing the Polymer Command Line Interface[edit | edit source]

The Polymer CLI provides you with all tools needed for Polymer Projects:

npm install -g polymer-cli

Initialize your app from an app template[edit | edit source]

Use polymer init to initialize your app from an app template.

A cool template is the --app-drawer-template. Let's use that:

polymer init app-drawer-template

Serve your app[edit | edit source]

There is no building needed to serve your first awesome Polymer app. Just serve it:

polymer serve --open

This will open the app in your default browser on http://localhost:8080.

Hello World[edit | edit source]

This example creates a Polymer element named x-foo, whose template binds to a string property, named "message". The element's HTML is imported into the main document, which allows usage of <x-foo> tags in <body>.

x-foo.html

<dom*module id="x-foo">
  <template>
    <span>{{message}}</span>
  </template>

  <script>
    Polymer({
      is: 'x-foo',
      properties : {
        message: {
          type: String,
          value: "Hello world!"
        }
      }
    });
  </script>
</dom-module>

index.html

<head>
  <!-- PolyGit used here as CDN for demo purposes only. In production,
       it's recommended to import Polymer and Web Components locally
       from Bower. -->
  <base href="https://polygit.org/polymer+1.6.0/components/">

  <script src="webcomponentsjs/webcomponents-lite.min.js"></script>
  <link rel="import" href="polymer/polymer.html">

  <link rel="import" href="x-foo.html">
</head>
<body>
  <x-foo></x-foo>
</body>

See demo in CodePen

Using Elements from the Polymer Catalog[edit | edit source]

Polymer prodives a lot of well built elements for you to use in your app.

Browse them in their Element Catalog.

Let's go through the workflow of using an element by including paper-input (Documentation)

Download the Element[edit | edit source]

To Download an element there are two ways:

Bower[edit | edit source]

The convinient way is to use the command line using the bower install command:

bower install --save PolymerElements/paper-input

Note: --save adds the element as a dependency to the bower.json of your app.

ZIP file[edit | edit source]

The other way is to add the selected element (paper-input in this case) to your collection (in the Polymer Catalog) using "Add to Collection" in the navigation and download your collection using the star icon in the upper right corner.

This will generate a .zip file that contains the element and all of its dependencies. You can then copy the bower_components folder inside the .zip/components to the root directory of your app.

Import the Element in your app[edit | edit source]

To import the element you've just installed, import the corresponding .html file:

<link rel="import" href="bower_components/paper-input/paper-input.html">

Use the Element[edit | edit source]

Now you can use paper-input inside the document you imported it to:

<paper-input></paper-input>

Credit:Stack_Overflow_Documentation