vault/ui/lib/core/stories/box-radio.md

BoxRadio

BoxRadio components are used to display options for a radio selection.

Params

Param	Type	Default	Description
displayName	string		This is the string that will show on the box radio option.
type	string		type is the key that the radio input will be identified by. Please use a value without spaces.
glyph	string		glyph is the name of the icon that will be used in the box
groupValue	string		The key of the radio option that is currently selected for this radio group
groupName	string		The name (key) of the group that this radio option belongs to
onRadioChange	function		This callback will trigger when the radio option is selected (if enabled)
[disabled]	boolean	false	This parameter controls whether the radio option is selectable. If not, it will be grayed out and show a tooltip.
[tooltipMessage]	string	"default"	The message that shows in the tooltip if the radio option is disabled

Example

<BoxRadio @displayName="Catahoula Leopard" @type="catahoula" @glyph="dog" @groupValue="labrador" @groupName="my-favorite-dog" @onRadioChange={{handleRadioChange}} />

See

• Uses of BoxRadio
• BoxRadio Source Code

---