Toggle Switch

yarn add @clayui/form

Toggle provide users with different selection and activation tools.

Stable 3.32.0 View in Lexicon CHANGELOG

Toggle
RadioGroup

Toggle

Property	Type	Required	Default	Description
containerProps	React.HTMLAttributes<HTMLSpanElement>	false	{}
disabled	boolean	false
id	string	false
label	React.ReactText	false
onToggle	(val: boolean) => void	false
spritemap	string	false
symbol	{on: string; off: string}	false
toggled	boolean	false
type	'checkbox' \| 'radio'	false	'checkbox'
value	string	false

RadioGroup

Property	Type	Required	Default	Description
children	Array< React.ReactElement<IRadioProps> \| React.ReactElement<IToggleProps> >	true		Takes either Radio or Toggle as a child.
inline	boolean	false		Flag to indicate if radio elements should display inline.
name	string	false		Form element `name` that is applied to each radio element.
onSelectedValueChange	(val: React.ReactText) => void	true		Callback function for whenever a radio element is selected.
selectedValue	React.ReactText	false		The value that corresponds to the selected radio element. Leave undefined if no option is selected.