search

PolymerElements / paper-toggle-button

A Material Design toggle button
https://webcomponents.org/element/PolymerElements/paper-toggle-button
27 stars 39 forks source link

readme

Published on NPM Build status Published on webcomponents.org

<paper-toggle-button>

<paper-toggle-button> provides a ON/OFF switch that user can toggle the state by tapping or by dragging the switch.

See: Documentation, Demo.

Usage

Installation

npm install --save @polymer/paper-toggle-button

In an HTML file

<html>
  <head>
    <script type="module">
      import '@polymer/paper-toggle-button/paper-toggle-button.js';
    </script>
  </head>
  <body>
    <paper-toggle-button checked></paper-toggle-button>
    <paper-toggle-button disabled></paper-toggle-button>
  </body>
</html>

In a Polymer 3 element

import {PolymerElement} from '@polymer/polymer/polymer-element.js';
import {html} from '@polymer/polymer/lib/utils/html-tag.js';

import '@polymer/paper-toggle-button/paper-toggle-button.js';

class ExampleElement extends PolymerElement {
  static get template() {
    return html`
      <paper-toggle-button checked></paper-toggle-button>
      <paper-toggle-button disabled></paper-toggle-button>
    `;
  }
}

customElements.define('example-element', ExampleElement);

Contributing

If you want to send a PR to this element, here are the instructions for running the tests and demo locally:

Installation

git clone https://github.com/PolymerElements/paper-toggle-button
cd paper-toggle-button
npm install
npm install -g polymer-cli

Running the demo locally

polymer serve --npm
open http://127.0.0.1:<port>/demo/

Running the tests

polymer test --npm