Skip to content

CheckboxProps

CheckboxProps<FieldValues>: object

Type Parameters

Type Parameter
FieldValues extends TFieldValues

Type declaration

NameTypeDescription
disabledbooleanIf true, the component is disabled. Default false
errorobjectAn error message to display below the element when in an invalid state.
error.messagestring-
helpTextReact.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.
requiredbooleanWhen true, the element will be invalid when touched and unchecked. Default false