Skip to main content

CheckboxField


Example

<CheckboxField
label="I agree with the terms and conditions"
name="terms-and-conditions"
value={checked}
onChange={setChecked}
/>

Props

NameTypeDefault ValueRequiredDescription
disabledbooleanNo
hintPlacement"bottom" | "left" | "right" | "top" | "bottom-end" | "bottom-start" | "left-end" | "left-start" | "right-end" | "right-start" | "top-end" | "top-start"No
autoFocusbooleanNo
onBlur() => unknownNo
namestringNo
valuebooleanYes
onChange(value: boolean) => unknownYes
issuesNonEmptyArray<Children>No
hintstringNo
labelChildrenYes

Related components