A Material Design radio button
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Create CODEOWNERS Jan 24, 2018
demo
test
.gitignore
.npmignore Tedium automated v3 element updates. Aug 16, 2018
.travis.yml Only generate types once on Travis Sep 7, 2018
CONTRIBUTING.md [skip ci] Update contribution guide May 17, 2016
README.md
bower.json Add `bower.json` so that webcomponents.org can read the repo. Sep 14, 2018
formatconfig.json Add `formatconfig.json`; format. Jul 23, 2018
hero.svg
manifest.json auto-converted by polymer-modulizer Jun 23, 2018
package-lock.json 3.0.1 Sep 14, 2018
package.json 3.0.1 Sep 14, 2018
paper-radio-button.js Update `README.md`. Jul 23, 2018
wct.conf.json

README.md

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