Skip to content

Checkbox

A checkbox component.

  • Import
    import "@tapsioss/web-components/checkbox";
  • Tag
    <tapsi-checkbox></tapsi-checkbox>

Properties

NameDescriptionTypeDefault Value
checkedIndicates whether the checkbox is checked.booleanfalse
indeterminateIndicates whether the checkbox is in an indeterminate state.booleanfalse
disabledIndicates whether the checkbox is disabled.booleanfalse
valueThe value of the checkbox when it is checked.string"on"
errorWhether the checkbox has error.booleanfalse
labelDefines a string value that can be used to name checkbox input.
https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label
string-
labelledbyIdentifies the element (or elements) that labels the checkbox input.
https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-labelledby
string-
requiredIndicates that the user must specify a value for the input before the owning form can be submitted and will render an error state when reportValidity() is invoked when value is empty.
https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/required
booleanfalse