A check box allowing single values to be selected/deselected.
Element
igc-checkbox
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.

Constructors

Section titled "Constructors"

IgcCheckboxComponent 

new IgcCheckboxComponent(args: any[]): IgcCheckboxComponent

Defined in src/components/common/mixins/constructor.ts:1

Returns IgcCheckboxComponent

Properties

Section titled "Properties"

disabled

Section titled "disabled"

Inherited from: IgcCheckboxBaseComponent

The disabled state of the component.

 
disabled: boolean

Defined in src/components/common/mixins/forms/types.ts:29

indeterminate

Section titled "indeterminate"

Draws the checkbox in indeterminate state.

 
indeterminate: boolean = false

Defined in src/components/checkbox/checkbox.ts:53

invalid

Section titled "invalid"

Inherited from: IgcCheckboxBaseComponent

Sets the control into invalid state (visual state only).

 
invalid: boolean

Defined in src/components/common/mixins/forms/types.ts:36

labelPosition

Section titled "labelPosition"

Inherited from: IgcCheckboxBaseComponent

The label position of the control.

 
labelPosition: ToggleLabelPosition = 'after'

Defined in src/components/checkbox/checkbox-base.ts:91

name

Section titled "name"

Inherited from: IgcCheckboxBaseComponent

The name attribute of the control.

 
name: string

Defined in src/components/common/mixins/forms/types.ts:42

tagName

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

Defined in src/components/checkbox/checkbox.ts:35

Accessors

Section titled "Accessors"

checked

Section titled "checked"

Inherited from: IgcCheckboxBaseComponent 

get checked(): boolean

Defined in src/components/checkbox/checkbox-base.ts:82

Returns boolean

The checked state of the control.

 
set checked(value: boolean): void

Defined in src/components/checkbox/checkbox-base.ts:78

Parameters

  • value: boolean

Returns void

defaultChecked

Section titled "defaultChecked"

Inherited from: IgcCheckboxBaseComponent 

get defaultChecked(): boolean

Defined in src/components/common/mixins/forms/types.ts:169

Returns boolean

The initial checked state of the component.

 
set defaultChecked(value: boolean): void

Defined in src/components/common/mixins/forms/types.ts:168

Parameters

  • value: boolean

Returns void

form

Section titled "form"

Inherited from: IgcCheckboxBaseComponent

Returns the HTMLFormElement associated with this element.

 
get form(): HTMLFormElement | null

Defined in src/components/common/mixins/forms/types.ts:45

Returns HTMLFormElement | null

required

Section titled "required"

Inherited from: IgcCheckboxBaseComponent 

get required(): boolean

Defined in src/components/common/mixins/forms/types.ts:181

Returns boolean

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

 
set required(value: boolean): void

Defined in src/components/common/mixins/forms/types.ts:180

Parameters

  • value: boolean

Returns void

validationMessage

Section titled "validationMessage"

Inherited from: IgcCheckboxBaseComponent

A string containing the validation message of this element.

 
get validationMessage(): string

Defined in src/components/common/mixins/forms/types.ts:54

Returns string

validity

Section titled "validity"

Inherited from: IgcCheckboxBaseComponent

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

 
get validity(): ValidityState

Defined in src/components/common/mixins/forms/types.ts:51

Returns ValidityState

value

Section titled "value"

Inherited from: IgcCheckboxBaseComponent 

get value(): string

Defined in src/components/checkbox/checkbox-base.ts:68

Returns string

The value attribute of the control.

 
set value(value: string): void

Defined in src/components/checkbox/checkbox-base.ts:61

Parameters

  • value: string

Returns void

willValidate

Section titled "willValidate"

Inherited from: IgcCheckboxBaseComponent

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

 
get willValidate(): boolean

Defined in src/components/common/mixins/forms/types.ts:60

Returns boolean

Methods

Section titled "Methods"

addEventListener

Section titled "addEventListener"

Inherited from: IgcCheckboxBaseComponent 

addEventListener(type: K, listener: object, options: boolean | AddEventListenerOptions): void

Defined in src/components/common/mixins/event-emitter.ts:7

Parameters

  • type: K
  • listener: object
  • options: boolean | AddEventListenerOptions

Returns void

blur

Section titled "blur"

Inherited from: IgcCheckboxBaseComponent

Removes focus from the control.

 
blur(): void

Defined in src/components/checkbox/checkbox-base.ts:106

Returns void

checkValidity

Section titled "checkValidity"

Inherited from: IgcCheckboxBaseComponent

Checks for validity of the control and emits the invalid event if it invalid.

 
checkValidity(): boolean

Defined in src/components/common/mixins/forms/types.ts:146

Returns boolean

click

Section titled "click"

Inherited from: IgcCheckboxBaseComponent

Simulates a click on the control.

 
click(): void

Defined in src/components/checkbox/checkbox-base.ts:94

Returns void

emitEvent

Section titled "emitEvent"

Inherited from: IgcCheckboxBaseComponent 

emitEvent(type: K, eventInitDict: CustomEventInit<D>): boolean

Defined in src/components/common/mixins/event-emitter.ts:30

Parameters

  • type: K
  • eventInitDict: CustomEventInit<D>

Returns boolean

focus

Section titled "focus"

Inherited from: IgcCheckboxBaseComponent

Sets focus on the control.

 
focus(options: FocusOptions): void

Defined in src/components/checkbox/checkbox-base.ts:100

Parameters

  • options: FocusOptions

Returns void

removeEventListener

Section titled "removeEventListener"

Inherited from: IgcCheckboxBaseComponent 

removeEventListener(type: K, listener: object, options: boolean | EventListenerOptions): void

Defined in src/components/common/mixins/event-emitter.ts:17

Parameters

  • type: K
  • listener: object
  • options: boolean | EventListenerOptions

Returns void

reportValidity

Section titled "reportValidity"

Inherited from: IgcCheckboxBaseComponent

Checks for validity of the control and shows the browser message if it invalid.

 
reportValidity(): boolean

Defined in src/components/common/mixins/forms/types.ts:149

Returns boolean

setCustomValidity

Section titled "setCustomValidity"

Inherited from: IgcCheckboxBaseComponent

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

 
setCustomValidity(message: string): void

Defined in src/components/common/mixins/forms/types.ts:155

Parameters

  • message: string

Returns void

register

Section titled "register" 
register(): void

Defined in src/components/checkbox/checkbox.ts:39

Returns void

Events

Section titled "Events"

igcChange

Section titled "igcChange" 
igcChange: CustomEvent<IgcCheckboxChangeEventArgs>

Defined in src/components/checkbox/checkbox-base.ts:20