A check box allowing single values to be selected/deselected.
- Slots
-
default— The checkbox label. -
helper-text— Renders content below the input. -
value-missing— Renders content when the required validation fails. -
custom-error— Renders content when setCustomValidity(message) is set. -
invalid— Renders content when the component is in invalid state (validity.valid = false).
- CSS Parts
-
base— The base wrapper of the checkbox. -
control— The checkbox input element. -
label— The checkbox label. -
indicator— The checkbox indicator icon.
Properties
Section titled "Properties"indeterminate
Section titled "indeterminate"Draws the checkbox in indeterminate state.
indeterminate: booleanlabelPosition
Section titled "labelPosition"The label position of the control.
labelPosition: ToggleLabelPositionMethods
Section titled "Methods"Removes focus from the control.
blur(): voidReturns void
click
Section titled "click"Simulates a click on the control.
click(): voidReturns void
focus
Section titled "focus"Sets focus on the control.
focus(options: FocusOptions): voidParameters
- options:
FocusOptions
Returns void
Events
Section titled "Events"onChange
Section titled "onChange"Emitted when the control's checked state changes.
onChange(args: CustomEvent<IgrCheckboxChangeEventArgs>): void