JSPM

  • Created
  • Published
  • Downloads 9256
  • Score
    100M100P100Q144107F
  • License BSD-3-Clause

A material design toggle button control

Package Exports

  • @polymer/paper-toggle-button
  • @polymer/paper-toggle-button/paper-toggle-button
  • @polymer/paper-toggle-button/paper-toggle-button.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@polymer/paper-toggle-button) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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