A Material Design radio button

Published on NPM Build status Published on webcomponents.org

<paper-radio-button>

paper-radio-button is a button that can be either checked or unchecked. The user can tap the radio button to check or uncheck it.

Use a <paper-radio-group> to group a set of radio buttons. When radio buttons are inside a radio group, exactly one radio button in the group can be checked at any time.

See: Documentation, Demo.

Usage

Installation

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

In an HTML file

<html>
  <head>
    <script type="module">
      import '@polymer/paper-radio-button/paper-radio-button.js';
    </script>
  </head>
  <body>
    <paper-radio-button>Unchecked</paper-radio-button>
    <paper-radio-button checked>Checked</paper-radio-button>
    <paper-radio-button disabled>Disabled</paper-radio-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-radio-button/paper-radio-button.js';

class ExampleElement extends PolymerElement {
  static get template() {
    return html`
      <paper-radio-button>Unchecked</paper-radio-button>
      <paper-radio-button checked>Checked</paper-radio-button>
      <paper-radio-button disabled>Disabled</paper-radio-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-radio-button
cd paper-radio-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

Install

Link to this version
ImportedReleased 15 March 2018Other
Framework Support
Polymer 2.0+
Also supported:
Polymer 1 (3.0.1)Polymer 3 (3.0.1)
Browser Compatibility
Install with
bower install --save PolymerElements/paper-radio-button"#2.1.0"
Run the above Bower command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 2.1.0

Dependencies

  • iron-checked-element-behavior#PolymerElements/iron-checked-element-behavior#1 - 2
  • iron-flex-layout#PolymerElements/iron-flex-layout#1 - 2
  • paper-behaviors#PolymerElements/paper-behaviors#1 - 2
  • paper-styles#PolymerElements/paper-styles#1 - 2
  • polymer#Polymer/polymer#1.9 - 2