To install, type the following into the command line at the root of your project:
npm i @brighthr/component-radio-block
To implement the RadioBlock component into your project you’ll need to add the import:
import RadioBlock from '@brighthr/component-radio-block';
After adding import into your project you can use it simply like:
<RadioBlock/>
Name | Type | Default | Description |
---|---|---|---|
alignContent |
'left' 'center'
|
'center' |
Sets the horizontal alignment. Left alignment is not compatible with having an icon. |
alignItems |
'normal' 'center'
|
'normal' |
Sets the vertical alignment. |
badgeStatus |
'default' 'information' 'success' 'warning' 'error'
|
Sets the appearance of the badge, if showBadge is true . |
|
badgeText | string |
string |
Sets the text inside the badge, if showBadge is true . |
checked | boolean |
false |
If true , the RadioBlock will show as selected. |
description | string |
Sets the description text. | |
disabled | boolean |
false |
If true , disables the RadioBlock. |
iconName | string |
If an iconName is provided, the relevant icon will be shown. |
|
showBadge | boolean |
false |
If true , shows a badge. |
title | string |
Sets the title text. |