diff --git a/src/components/radio/README.md b/src/components/radio/README.md new file mode 100644 index 00000000000..8a598bc8fb9 --- /dev/null +++ b/src/components/radio/README.md @@ -0,0 +1,52 @@ +# MdRadio +Radio buttons allow the user to select one option from a set. Use radio buttons for exclusive selection if you think that the user needs to see all available options side-by-side. + +![Preview](https://material.angularjs.org/material2_assets/radio/radios.png) + +### Examples +A basic radio group would have the following markup. +```html + + 1 + 2 + +``` + +A dynamic example, populated from a `data` variable: +```html + + + {{d.label}} + + +``` + +## `` +### Properties + +| Name | Type | Description | +| --- | --- | --- | +| `selected` | `MdRadioButton` | The currently selected button. | +| `value` | `any` | The current value for this group. | +| `disabled` | `boolean` | Whether the group is disabled. | + +When selection is changed, an event is emitted from the `change` EventEmitter property. + +### Notes +The `md-radio-group` component has no button initially selected. + +## `` +### Properties + +| Name | Type | Description | +| --- | --- | --- | +| `id` | `string` | The unique ID of this radio button. | +| `name` | `string` | Group name, defaults to parent radio group if present. | +| `value` | `any` | The value of this radio button. | +| `checked` | `boolean` | Whether the radio is checked. | +| `disabled` | `boolean` | Whether the radio is disabled. | + +When checked, an event is emitted from the `change` EventEmitter property. + +### Notes +* The `md-radio-button` component by default uses the accent color from the theme palette.