disabled

false
Copy

invalid

false
Copy

labelPosition

name

checked

• get checked(): boolean

  Returns boolean

• set checked(value: boolean): void

  The checked state of the control.

  Attr

  Parameters

  • value: boolean

  Returns void

defaultChecked

• get defaultChecked(): boolean

  Returns boolean

• set defaultChecked(value: boolean): void

  The initial checked state of the component.

  Parameters

  • value: boolean

  Returns void

form

• get form(): HTMLFormElement | null

  Returns the HTMLFormElement associated with this element.

  Returns HTMLFormElement | null

required

• get required(): boolean

  Returns boolean

• set required(value: boolean): void

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

  Attr

  Default

  false
  Copy

  Parameters

  • value: boolean

  Returns void

validationMessage

• get validationMessage(): string

  A string containing the validation message of this element.

  Returns string

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

• get value(): string

  Returns string

• set value(value: string): void

  The value attribute of the control.

  Attr

  Parameters

  • value: string

  Returns void

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

addEventListener

• addEventListener<
      K extends string
      | number
      | symbol,
      M extends IgcCheckboxComponentEventMap & HTMLElementEventMap,
  >(
      type: K,
      listener: (this: HTMLElement, ev: M[K]) => any,
      options?: boolean | AddEventListenerOptions,
  ): void

  Type parameters

  Type Parameters

  • K extends string | number | symbol
  • M extends IgcCheckboxComponentEventMap & HTMLElementEventMap

  Parameters

  • type: K

  • listener: (this: HTMLElement, ev: M[K]) => any

  • options: boolean | AddEventListenerOptions

  Returns void

• addEventListener(
      type: string,
      listener: EventListenerOrEventListenerObject,
      options?: boolean | AddEventListenerOptions,
  ): void

  Parameters

  • type: string

  • listener: EventListenerOrEventListenerObject

  • options: boolean | AddEventListenerOptions

  Returns void

• addEventListener<K extends keyof HTMLElementEventMap>(
      type: K,
      listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any,
      options?: boolean | AddEventListenerOptions,
  ): void

  Type parameters

  Type Parameters

  • K extends keyof HTMLElementEventMap

  Parameters

  • type: K

  • listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any

  • options: boolean | AddEventListenerOptions

  Returns void

blur

• blur(): void

  Removes focus from the control.

  Returns void

checkValidity

• checkValidity(): boolean

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

  Returns boolean

click

• click(): void

  Simulates a click on the control.

  Returns void

emitEvent

• emitEvent<
      K extends keyof IgcCheckboxComponentEventMap,
      D extends IgcCheckboxChangeEventArgs,
  >(
      type: K,
      eventInitDict?: CustomEventInit<D>,
  ): boolean

  Type parameters

  Type Parameters

  • K extends keyof IgcCheckboxComponentEventMap
  • D extends IgcCheckboxChangeEventArgs

  Parameters

  • type: K

  • eventInitDict: CustomEventInit<D>

  Returns boolean

focus

• focus(options?: FocusOptions): void

  Sets focus on the control.

  Parameters

  • options: FocusOptions

  Returns void

removeEventListener

• removeEventListener<
      K extends string
      | number
      | symbol,
      M extends IgcCheckboxComponentEventMap & HTMLElementEventMap,
  >(
      type: K,
      listener: (this: HTMLElement, ev: M[K]) => any,
      options?: boolean | EventListenerOptions,
  ): void

  Type parameters

  Type Parameters

  • K extends string | number | symbol
  • M extends IgcCheckboxComponentEventMap & HTMLElementEventMap

  Parameters

  • type: K

  • listener: (this: HTMLElement, ev: M[K]) => any

  • options: boolean | EventListenerOptions

  Returns void

• removeEventListener(
      type: string,
      listener: EventListenerOrEventListenerObject,
      options?: boolean | EventListenerOptions,
  ): void

  Parameters

  • type: string

  • listener: EventListenerOrEventListenerObject

  • options: boolean | EventListenerOptions

  Returns void

• removeEventListener<K extends keyof HTMLElementEventMap>(
      type: K,
      listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any,
      options?: boolean | EventListenerOptions,
  ): void

  Type parameters

  Type Parameters

  • K extends keyof HTMLElementEventMap

  Parameters

  • type: K

  • listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any

  • options: boolean | EventListenerOptions

  Returns void

reportValidity

• reportValidity(): boolean

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

  Returns boolean

setCustomValidity

• setCustomValidity(message: string): 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