IlyaSobolev/DocSpace-buildtools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

web: Components: Fixed RadioButton component readme

Browse Source
This commit is contained in:
Ilya Oleshko 2019-11-21 16:27:24 +03:00
parent e049caa2a5
commit ad60cb45c9
1 changed files with 16 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
web/ASC.Web.Components/src/components/radio-button/README.md
View File

@ -1,29 +1,26 @@
# RadioButton
#### Description
RadioButton allow you to add radiobutton
#### Usage
### Usage
```js
import { RadioButton } from 'asc-web-components';
<RadioButton
name='fruits'
value= 'apple'
label= 'Sweet apple'
/>
import { RadioButton } from "asc-web-components";
```
#### Properties
```jsx
<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
| `onClick` | `func` | - | - | - | Allow you to handle clicking events on component
| 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 |
| `onClick` | `func` | - | - | - | Allow you to handle clicking events on component |