diff options
Diffstat (limited to 'catapult/third_party/polymer/components/paper-radio-group/README.md')
-rw-r--r-- | catapult/third_party/polymer/components/paper-radio-group/README.md | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/catapult/third_party/polymer/components/paper-radio-group/README.md b/catapult/third_party/polymer/components/paper-radio-group/README.md new file mode 100644 index 00000000..2f258bb9 --- /dev/null +++ b/catapult/third_party/polymer/components/paper-radio-group/README.md @@ -0,0 +1,59 @@ + +<!--- + +This README is automatically generated from the comments in these files: +paper-radio-group.html + +Edit those files, and our readme bot will duplicate them over here! +Edit this file, and the bot will squash your changes :) + +The bot does some handling of markdown. Please file a bug if it does the wrong +thing! https://github.com/PolymerLabs/tedium/issues + +--> + +[![Build status](https://travis-ci.org/PolymerElements/paper-radio-group.svg?branch=master)](https://travis-ci.org/PolymerElements/paper-radio-group) + +_[Demo and API docs](https://elements.polymer-project.org/elements/paper-radio-group)_ + + +##<paper-radio-group> + +Material design: [Radio button](https://www.google.com/design/spec/components/selection-controls.html#selection-controls-radio-button) + +`paper-radio-group` allows user to select at most one radio button from a set. +Checking one radio button that belongs to a radio group unchecks any +previously checked radio button within the same group. Use +`selected` to get or set the selected radio button. + +The <paper-radio-buttons> inside the group must have the `name` attribute +set. + +Example: + +```html +<paper-radio-group selected="small"> + <paper-radio-button name="small">Small</paper-radio-button> + <paper-radio-button name="medium">Medium</paper-radio-button> + <paper-radio-button name="large">Large</paper-radio-button> +</paper-radio-group> +``` + +Radio-button-groups can be made optional, and allow zero buttons to be selected: + +```html +<paper-radio-group selected="small" allow-empty-selection> + <paper-radio-button name="small">Small</paper-radio-button> + <paper-radio-button name="medium">Medium</paper-radio-button> + <paper-radio-button name="large">Large</paper-radio-button> +</paper-radio-group> +``` + +See <a href="paper-radio-button">paper-radio-button</a> for more +information about `paper-radio-button`. + +| Custom property | Description | Default | +| --- | --- | --- | +| `--paper-radio-group-item-padding` | The padding of the item | `12px` | + + |