Features

API

DOM Structure

Slot	Description
indicator	Creates the indicator, and can be styles based on the checkbox's current state
label	Creates the label and associates it to the control

Part	Description
indicator	An outer wrapper around the indicator
label	An outer wrapper around the label

Attributes

Name	Type	Default	Description
checked	boolean	false	Whether or not the checkbox's value is checked, if set to true the checkbox displays the contents of the checked-indicator slot
defaultChecked	boolean	false	Whether the checkbox is checked by default when added to the DOM. Does nothing if checked is explicitly set
disabled	string	-	When set the checkbox cannot be interacted with
indeterminate	boolean	false	When set to true the checkbox displays the contents of the intermediate-indicator slot
value	string	"on"	The value of the checkbox
name	string	-	The name of the checkbox for form submission purposes. Required if submitting values to a form.
required	boolean	false	Whether or not the checkbox is required for form submission. This value is ignored if the checkbox is disabled
form	string	-	Associates the element with a form in the document whose id is this value.

Events

Event Name	Bubbles	Composed	Cancellable	Dispatch Behavior
change	true	true	false	Fired when the checkbox's state changes.
input	true	true	false	Fired when the checkbox's state changes.