Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Class IgrCheckbox

A check box allowing single values to be selected/deselected.

Slot

  • The checkbox label.

Slot

helper-text - Renders content below the input.

Slot

value-missing - Renders content when the required validation fails.

Slot

custom-error - Renders content when setCustomValidity(message) is set.

Slot

invalid - Renders content when the component is in invalid state (validity.valid = false).

Csspart

base - The base wrapper of the checkbox.

Csspart

control - The checkbox input element.

Csspart

label - The checkbox label.

Csspart

indicator - The checkbox indicator icon.

Callable

  • IgrCheckbox(): ReactNode

    Returns ReactNode

Events

Properties

Events

onChange

onChange: (args: CustomEvent<IgrCheckboxChangeEventArgsDetail>) => void

Emitted when the control's checked state changes.

Type declaration

Properties

indeterminate

indeterminate: boolean

Draws the checkbox in indeterminate state.