Contact us
Get started

Directory

← Back

paper-radio-button

A Material Design radio button

Author

Contributors

Rating

Links

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

Compatibility

(Loading compatibility data...)

Last updated: 2017-05-15

Was this helpful? Need more help?
Leave a comment or a question below. You can also join the chat on Discord or ask questions on StackOverflow.

Version

Dependencies

  • @polymer/iron-checked-element-behavior#^3.0.0-pre.26
  • @polymer/iron-flex-layout#^3.0.0-pre.26
  • @polymer/paper-behaviors#^3.0.0-pre.27
  • @polymer/paper-styles#^3.0.0-pre.26
  • @polymer/polymer#^3.0.0
Released
2018-09-14
Maturity
IMPORTED
License
BSD 3-clause "New" or "Revised" License

Compatibility

Framework
Polymer 1.0+
Polymer 3.0+
Polymer 2.0+ in 2.1.0
Browser
Browser Independent
Online