export interface CheckboxProps { /** * The name of the form field/input, used to set/track the field value in the form state. */ name: string; /** * The (accessible) label for the field - anything that can be rendered. * * You must always provide a label to ensure the field is accessible to users of * assistive technologies. */ label: React.ReactNode; /** * Required fields get additional markup/styling to indicate this validation requirement. */ isRequired?: boolean; /** * Sometimes the label should never get an asterisk or suffix for the required state, * e.g. when the checkbox is part of a larger component (like selectboxes). */ ignoreRequired?: boolean; /** * Readonly fields get marked as such in an accessible manner. */ isReadOnly?: boolean; /** * Whether the checkbox should be disabled or not. */ disabled?: boolean; /** * Additional description displayed close to the field - use this to document any * validation requirements that are crucial to successfully submit the form. More * information that is contextual/background typically belongs in a tooltip. */ description?: React.ReactNode; /** * Whether to treat the description as help text for a standalone field or blend the * description in more with the label. */ descriptionAsHelpText?: boolean; /** * Optional tooltip to provide additional information that is not crucial but may * assist users in filling out the field correctly. */ tooltip?: React.ReactNode; } declare const Checkbox: React.FC; export default Checkbox;