VCheckbox

Props

Name	Type	Description
aria-current	Enum: page step location date time true false	Indicates the element that represents the current item within a container or set of related elements.
checked	boolean	The current checkedness of the element. This property serves as a mechanism to set the checked property through both property assignment and the .setAttribute() method. This is useful for setting the field's checkedness in UI libraries that bind data through the .setAttribute() API and don't support IDL attribute binding.
connotation	Enum: accent cta	The connotation the checklist should have.
default-checked	boolean	Provides the default checkedness of the input element
disabled	boolean	Sets the element's disabled state. A disabled element will not be included during form submission.
error-text	string	The error text for the form element.
helper-text	string	The helper text for the form element.
initial-value	string	The initial value of the form. This value sets the value property only when the value property has not been explicitly set.
label	string	The label for the form element.
name	string	The name of the element. This element's value will be surfaced during form submission under the provided name.
readonly	boolean	When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly
required	boolean	Require the field to be completed prior to form submission.
success-text	string	The success text for the form element.
tabindex	string
value	string	The current value of the element. This property serves as a mechanism to set the value property through both property assignment and the .setAttribute() method. This is useful for setting the field's value in UI libraries that bind data through the .setAttribute() API and don't support IDL attribute binding.

Events

Name	Event Type	Description
blur	FocusEvent	Fires when the element loses focus.
change	CustomEvent<undefined>	Emitted when the checked state changes.
click	MouseEvent	Fires when a pointing device button (such as a mouse's primary mouse button) is both pressed and released while the pointer is located inside the element.
focus	FocusEvent	Fires when the element receives focus.
input	CustomEvent<undefined>	Emitted when the checked state changes.
keydown	KeyboardEvent	Fires when a key is pressed.
keyup	KeyboardEvent	Fires when a key is released.

Slots

Name	Description
default	The default slot allows you to use rich content as the checkbox's label.
helper-text	Describes how to use the checkbox. Alternative to the helper-text attribute.

Methods

Name	Type	Description
ariaCheckedChanged	() => unknown