DocSpace-client/web/ASC.Web.Storybook/stories/input/radio-button/README.md

30 lines
1.5 KiB
Markdown
Raw Normal View History

# RadioButton
#### Description
RadioButton allow you to add radiobutton
#### Usage
```js
import { RadioButton } from 'asc-web-components';
<RadioButton
name='fruits'
value= 'apple'
label= 'Sweet apple'
/>
```
#### Properties
`<RadioButtonGroup />` props supersede RadioButton props
| Props | Type | Required | Values | Default | Description |
| ---------------------- | -------- | :------: | ---------------------------- | ------- | ------------------------------------------------------------------------------------------------------ |
| `value` | `string` | ✅ | - | - | Used as HTML `value` property for `<input>` tag. Used for identification each radiobutton
| `name` | `string` | ✅ | - | - | Used as HTML `name` property for `<input>` tag.
| `label` | `string` | - | - | - | Name of the radiobutton. If missed, `value` will be used
| `isChecked` | `bool` | - | - | `false` | Used as HTML `checked` property for each `<input>` tag
| `isDisabled` | `bool` | - | - | `false` | Used as HTML `disabled` property for each `<input>` tag
| `onChange` | `func` | - | - | - | Allow you to handle changing events on component