Polymer Logo Home Guides Feature overview Try Polymer Install Polymer 3.x Tutorial: Build an element 1. Get set up 2. Add shadow DOM 3. Data binding & properties 4. React to input 5. Theming with custom properties About this release What's new in 3.0 Upgrade guide Release notes Custom elements Custom element concepts Define an element Declare properties Working with legacy elements 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 and modules Tools Tools overview Polymer CLI CLI commands Create an element project Create an application project Document your elements Test your elements polymer.json specification Node support Build apps Overview App templates Build for production Serve your app The PRPL pattern Service worker Reference Glossary Global settings API Reference index polymer-element.js Elements array-selector.js custom-style.js dom-bind.js dom-if.js dom-module.js dom-repeat.js Mixins dir-mixin.js disable-upgrade-mixin.js element-mixin.js gesture-event-listeners.js mutable-data.js properties-changed.js properties-mixin.js property-accessors.js property-effects.js strict-binding-parser.js template-stamp.js Utils array-splice.js async.js case-map.js debounce.js flattened-nodes-observer.js flush.js gestures.js html-tag.js mixin.js path.js render-status.js resolve-url.js settings.js style-gather.js telemetry.js templatize.js Legacy class.js legacy-data-mixin.js legacy-element-mixin.js mutable-data-behavior.js polymer-fn.js polymer.dom.js templatizer-behavior.js

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

Contents

Polymer CLI is the official command line tool for Polymer projects and Web Components. It includes a build pipeline, a boilerplate generator for creating elements and apps, a linter, a development server, and a test runner.

Follow these instructions to install the Polymer CLI on a Linux or MacOS operating system.

For a suggested way to run the Polymer CLI on Windows 10, see the instructions below on Installing Polymer CLI pre-requisites on Windows 10.

  1. Make sure you have installed a version of Node.js supported by Polymer. To check the version of Node.js that you have installed, run:

    node --version

    See the official node version support policy for more details.

  2. Update npm.

    npm install npm@latest -g

  3. Ensure that Git is installed.

    git --version

    If it isn't, you can find it on the Git downloads page.

  4. Install Polymer CLI.

    npm install -g polymer-cli

You're all set. Run polymer help to view a list of commands.

Polymer CLI works with two types of projects:

  • Elements projects. In an element project, you expose a single element or group of related elements which you intend to use in other element or app projects, or distribute on a registry like NPM. Elements are reusable and organized to be used alongside other elements, so components are referenced outside the project.

    See the guide to creating an element project with the Polymer CLI for more information.

  • Application projects. In an app project, you build an application, composed of Polymer elements, which you intend to deploy as a website. Applications are self-contained, organized with components inside the application.

    See the guide to creating an application project with the Polymer CLI for more information.

See the documentation on Polymer CLI commands for a list of commands and how to use them.

There are multiple ways to install the pre-requisites for the Polymer CLI on a Windows 10 system. This method uses Bash on the Windows Subsystem for Linux.

For complete and up-to-date installation instructions for Bash on the Windows Subsystem for Linux, we recommend you review the Bash on ubuntu on Windows documentation.

  1. Check your Windows OS build:

    1. Press **Win+R** to open the **Run** dialog.

2. At **Open**, enter `winver`. 

3. Click **OK**.

Make sure you have an x64 installation of Windows 10 with OS build > 14393.

  1. Open Settings > Update and Security > For developers and select Developer Mode.

  2. From the Start Menu, search for Turn Windows features on or off and select Windows Subsystem for Linux.

  3. Restart your computer.

  4. Log in as Administrator.

  5. From a PowerShell prompt, run the following command:

    Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux

  6. When the previous command is complete, open a Bash prompt:

    bash

  7. If you are asked to create a new user, follow the prompts to do so.

Your Bash installation is complete. You can start now start a new Bash prompt by typing bash from the Start menu.

For complete and up-to-date instructions, refer to the official documentation for installing Node with nvm.

  1. Type the following command to use an install script:

    curl -o- https://raw.githubusercontent.com/creationix/nvm/master/install.sh | bash

  2. Restart your terminal by closing and re-opening your Bash prompt.

  3. Install the latest version of Node:

    nvm install node

Optionally, set a default browser so polymer serve --open has something to open. Use your own Path variable.

echo $'\n'export BROWSER=/mnt/c/Program\\\ Files\\\ \\\(x86\\\)/
Google/Chrome/Application/chrome.exe >> ~/.bashrc