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.

Fires

igcFocus - Emitted when the control gains focus.

Fires

igcBlur - Emitted when the control loses focus.

Csspart

base - The base wrapper of the checkbox.

Csspart

control - The checkbox control.

Csspart

label - The checkbox label.

Csspart

indicator - The checkbox icon.

Hierarchy

  • IgcCheckboxBaseComponent
    • IgcCheckboxComponent

Constructors

constructor

Properties

checked disabled indeterminate invalid labelPosition name required value tagName

Accessors

form validationMessage validity willValidate

Methods

blur checkValidity click emitEvent focus reportValidity setCustomValidity

Constructors

constructor

Properties

checked

checked: boolean = false

The checked state of the control.

Attr

disabled

disabled: boolean

The disabled state of the component

Attr

[disabled=false]

indeterminate

indeterminate: boolean = false

Draws the checkbox in indeterminate state.

Attr

invalid

invalid: boolean

Control the validity of the control.

Attr

labelPosition

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

The label position of the control.

Attr

label-position

name

name: string

The name attribute of the control.

Attr

required

required: boolean

Makes the control a required field in a form context.

Attr

value

value: string

The value attribute of the control.

Attr

Static Readonly tagName

tagName: "igc-checkbox" = 'igc-checkbox'

Accessors

form

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

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

emitEvent

  • Type Parameters

    • K extends keyof IgcCheckboxEventMap

    • D extends boolean | void

    Parameters

    • type: K
    • Optional eventInitDict: CustomEventInit<D>

    Returns boolean

focus

  • Sets focus on the control.

    Parameters

    • Optional options: FocusOptions

    Returns void

reportValidity

setCustomValidity

  • 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