Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcCheckboxComponent

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

Element

igc-checkbox

Slot

  • The checkbox label.

Fires

igcChange - Emitted when the control's checked state changes.

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.

Hierarchy

Hierarchy

  • IgcCheckboxBaseComponent
    • IgcCheckboxComponent

Properties

Accessors

Methods

Properties

disabled

disabled: boolean

The disabled state of the component.

Attr

Default

false

indeterminate

indeterminate: boolean = false

Draws the checkbox in indeterminate state.

Attr

invalid

invalid: boolean

Control the validity of the control.

Attr

Default

false

labelPosition

labelPosition: "after" | "before" = 'after'

The label position of the control.

Attr

label-position

name

name: string

The name attribute of the control.

Attr

Accessors

checked

form

required

  • set required(value): void

  • When set, makes the component a required field for validation.

    Attr

    Default

    false

    Parameters

    • value: boolean

    Returns void

validationMessage

validity

  • get validity(): ValidityState

  • Returns a ValidityState object which represents the different validity states the element can be in, with respect to constraint validation.

    Returns ValidityState

value

willValidate

  • get willValidate(): boolean

  • A boolean value which returns true if the element is a submittable element that is a candidate for constraint validation.

    Returns boolean

Methods

blur

checkValidity

click

focus

reportValidity

setCustomValidity

  • setCustomValidity(message): void

  • Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid.

    Parameters

    • message: string

    Returns void