ToggleProps Interface

Properties for Toggle component

Extends

Properties

Name Type Description
buttonType undefined | ToggleButtonType Button type, either Primary or Blue  
disabled undefined | false | true Determine if the toggle is disabled or not  
isOn undefined | false | true Determine if the toggle is "on" or "off"  
large undefined | false | true Use larger size  
onBlur undefined | (event: FocusEvent) => any Function called when the toggle loses focus  
onChange undefined | (checked: boolean) => any Function called when the toggle state is changed  
rounded undefined | false | true Show the toggle rounded or square (rounded is default)  
setFocus undefined | false | true Indicates whether to set focus to the input element  
showCheckmark undefined | false | true Show a check mark icon when the toggle is "on"  

Inherited properties

Name Type Inherited from Description
className undefined | string ClassNameProps Custom CSS class name
style undefined | React.CSSProperties CommonProps Custom CSS style properties

Defined in

Last Updated: 13 June, 2024