Polymer Logo Home Guides Feature overview Try Polymer Install Polymer 2.x Tutorial: Build an element 1. Get set up 2. Add local DOM 3. Data binding & properties 4. React to input 5. Theming with custom properties About this release What's new in 2.0 Upgrade guide Hybrid elements Release notes Custom elements Custom element concepts Define an element Declare properties Shadow DOM & styling Shadow DOM concepts DOM templating Style shadow DOM Custom CSS properties Events Handle and fire events Gesture events Data system Data system concepts Work with object and array data Observers and computed properties Data binding Helper elements Browser support Overview Polyfills ES6 Tools Tools overview Polymer CLI CLI commands Create an element project Create an application project Document your elements Test your elements Publish your elements Web services polymer.json specification Node support Build apps Overview App templates Responsive app layout Routing Localization App storage Service worker Build for production Serve your app The PRPL pattern Shop App Case Study News App Case Study Resources Glossary Global settings API Reference index Elements Polymer.ArraySelector Polymer.CustomStyle Polymer.DomBind Polymer.DomIf Polymer.DomModule Polymer.DomRepeat Polymer.Element Classes Polymer.Debouncer Polymer.DomApi Polymer.FlattenedNodesObserver Mixins Polymer.ArraySelectorMixin Polymer.DirMixin Polymer.ElementMixin Polymer.GestureEventListeners Polymer.LegacyElementMixin Polymer.MutableData Polymer.OptionalMutableData Polymer.PropertiesChanged Polymer.PropertiesMixin Polymer.PropertyAccessors Polymer.PropertyEffects Polymer.TemplateStamp Functions Polymer.Class Polymer.dedupingMixin Polymer.dom Polymer.enqueueDebouncer Polymer.flush Polymer.html Polymer.htmlLiteral Polymer.importHref Polymer.mixinBehaviors Polymer.setLegacyOptimizations Polymer.setPassiveTouchGestures Polymer.setRootPath Polymer.setSanitizeDOMValue Namespaces Polymer.ArraySplice Polymer.Async Polymer.CaseMap Polymer.dom Polymer.Gestures Polymer.Path Polymer.RenderStatus Polymer.ResolveUrl Polymer.Settings Polymer.StyleGather Polymer.telemetry Polymer.Templatize

The Polymer library is in maintenance mode. For new development, we recommend Lit.

You're viewing an older version of the Polymer library documentation. Please see Polymer 3.0 for the latest.

Contents

If you're familiar with Polymer and just want to get started with the new release, you're in the right place! If you'd like an introduction to the Polymer project and web components:

Polymer is distributed via the Bower package manager.

To create an application template and install Polymer automatically, you can use the Polymer CLI.

To start a project from scratch, you can install Polymer with Bower.

The Polymer CLI requires Node.js, npm, Git and Bower. For full installation instructions, see the Polymer CLI documentation.

  1. Install the Polymer CLI.

    npm install -g polymer-cli

  2. Create a test folder for Polymer 2.0, and switch to it.

    mkdir polymer-20-test
cd polymer-20-test

  3. Initialize your project.

    polymer init

  4. Select polymer-2-application.

  5. Serve your project.

    polymer serve

  1. Install Bower.

    npm install -g bower

  2. Install the Polymer CLI

    The Polymer CLI requires Node.js and npm as well as Bower. For full installation instructions, see the Polymer CLI documentation.

    npm install -g polymer-cli

  3. Install the latest Polymer 2.0 release from bower

    bower install Polymer/polymer#^2.0.0

  4. Create a test index.html file, and add the following in the <head> tag:

  • <script src="/bower_components/webcomponentsjs/webcomponents-loader.js"></script> to load the polyfills
  • <link rel="import" href="/bower_components/polymer/polymer.html"> to import Polymer

  1. Import and use whichever elements you’d like.

  2. Serve your project.

    polymer serve

For information on building your project for production, see the documentation on building Polymer applications for production.