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

new IgcCheckboxComponent(): IgcCheckboxComponent
Inherited from IgcCheckboxBaseComponent.constructor
- Defined in src/components/checkbox/checkbox-base.ts:59
Returns IgcCheckboxComponent

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

get form(): null | HTMLFormElement
Inherited from IgcCheckboxBaseComponent.form
- Defined in src/components/common/mixins/form-associated.ts:91
Returns the HTMLFormElement associated with this element.

Returns null | HTMLFormElement

validationMessage

get validationMessage(): string
Inherited from IgcCheckboxBaseComponent.validationMessage
- Defined in src/components/common/mixins/form-associated.ts:100
A string containing the validation message of this element.

Returns string

validity

get validity(): ValidityState
Inherited from IgcCheckboxBaseComponent.validity
- Defined in src/components/common/mixins/form-associated.ts:97
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
Inherited from IgcCheckboxBaseComponent.willValidate
- Defined in src/components/common/mixins/form-associated.ts:106
A boolean value which returns true if the element is a submittable element that is a candidate for constraint validation.

Returns boolean

Methods

blur

blur(): void
Inherited from IgcCheckboxBaseComponent.blur
- Defined in src/components/checkbox/checkbox-base.ts:91
Removes focus from the control.

Returns void

checkValidity

checkValidity(): boolean
Inherited from IgcCheckboxBaseComponent.checkValidity
- Defined in src/components/common/mixins/form-associated.ts:109
Checks for validity of the control and emits the invalid event if it invalid.

Returns boolean

click

click(): void
Inherited from IgcCheckboxBaseComponent.click
- Defined in src/components/checkbox/checkbox-base.ts:79
Simulates a click on the control.

Returns void

emitEvent

emitEvent<K, D>(type, eventInitDict?): boolean
Inherited from IgcCheckboxBaseComponent.emitEvent
- Defined in src/components/common/mixins/event-emitter.ts:31
Type parameters
Type Parameters
- K extends keyof IgcCheckboxEventMap
- D extends boolean | void
Parameters
- type: K
- Optional eventInitDict: CustomEventInit<D>
Returns boolean

focus

focus(options?): void
Inherited from IgcCheckboxBaseComponent.focus
- Defined in src/components/checkbox/checkbox-base.ts:85
Sets focus on the control.

Parameters
- Optional options: FocusOptions
Returns void

reportValidity

reportValidity(): boolean
Inherited from IgcCheckboxBaseComponent.reportValidity
- Defined in src/components/common/mixins/form-associated.ts:112
Checks for validity of the control and shows the browser message if it invalid.

Returns boolean

setCustomValidity

setCustomValidity(message): void
Inherited from IgcCheckboxBaseComponent.setCustomValidity
- Defined in src/components/common/mixins/form-associated.ts:118
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

`Static` register

register(): void
- Defined in src/components/checkbox/checkbox.ts:34
Returns void

Class IgcCheckboxComponent

Element

Slot

Fires

Fires

Fires

Csspart

Csspart

Csspart

Csspart

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns IgcCheckboxComponent

Properties

checked

Attr

disabled

Attr

indeterminate

Attr

invalid

Attr

labelPosition

Attr

name

Attr

required

Attr

value

Attr

Static Readonly tagName

Accessors

form

Returns null | HTMLFormElement

validationMessage

Returns string

validity

Returns ValidityState

willValidate

Returns boolean

Methods

blur

Returns void

checkValidity

Returns boolean

click

Returns void

emitEvent

Type parameters

Type Parameters

K extends keyof IgcCheckboxEventMap

D extends boolean | void

Parameters

type: K

Optional eventInitDict: CustomEventInit<D>

Returns boolean

focus

Parameters

Optional options: FocusOptions

Returns void

reportValidity

Returns boolean

setCustomValidity

Parameters

message: string

Returns void

Static register

Returns void

`Static` `Readonly` tagName

`Static` register