Checkbox API

Checkbox API

Name	Required	Type	Default Value	Description
animation	No	"smooth" | "jelly" | "tada" | "rotate" | "pulse"		Tne kind of animation to apply to the checkbox or radio.
bigger	No	boolean		Set true to make the control a little bit larger. For more control, use `font-size` in CSS on `.pretty`.
color	No	"primary" | "success" | "info" | "warning" | "danger" | "primary-o" | "success-o" | "info-o" | "warning-o" | "danger-o"		Choose a color (solid or outline) to apply to the control.
hasFocus	No	boolean		Set true to enable focus styling.
icon	No	ReactElement<any, "img" | "svg" | "i" | "em">		The icon to pass (as JSX) to the checkbox or radio.
indeterminate	No	boolean		Unique to checkbox, set `true` when the checkbox is in `indeterminate` state. If you're using a controlled checkbox, use the state hook instead. Mark the underlying HTML input checkbox as `indeterminate`. This prop doesn't change icons for you, it just ensures we have the correct `aria-checked` value and the checkbox has indeterminate status.
locked	No	boolean		Set true to enable locked mode.
plain	No	boolean		Set `true` to enable plain styles when to checkbox or radio is selected.
setState	No	Dispatch<SetStateAction<string | boolean | any[]>>		The state dispatch function either from the `setState` hook or a reference to `this.setState`.
shape	No	"curve" | "round"		The shape of the checkbox or radio.
state	No	string | boolean | any[]		The state of the control. Typically a boolean, string, or string array.
variant	No	"thick" | "fill"		The fill, or variant of the checkbox or radio.

useCheckboxState API

Name	Required	Type	Default Value	Description
onChange	No	ChangeEventHandler<HTMLInputElement>		Your change handlers to run _after_ the default dispatch has occurred.
state	No	string | boolean | any[]	false	The state object of the checkbox. This can be a boolean or an array of items.

useCheckboxState Return

Name	Type	Description
state	string | boolean | any[]	The state object of the checkbox. This can be a boolean or an array of items.
setState	React.Dispatch<React.SetStateAction<typeof state>>	The React dispatch function from useState or a reference to this.setState
onChange	React.ChangeEventHandler<HTMLInputElement>	The change handler to be called by the input control when a change event fires. This calls setState for you