Skip to content

CheckboxProps

CheckboxProps<FieldValues> = object

Type Parameter
FieldValues extends TFieldValues
PropertyTypeDescription
disabled?booleanIf true, the component is disabled. Default false
error?objectAn error message to display below the element when in an invalid state.
error.message?string-
helpText?React.ReactNodeExplanatory text to render below the element.
labelstringA user-friendly label displayed alongside the element.
namePath<FieldValues>A unique name identifying the element within a form.
required?booleanWhen true, the element will be invalid when touched and unchecked. Default false