Class IgcButtonComponent

Represents a clickable button, used to submit forms or anywhere in a document for accessible, standard button functionality.

Element

igc-button

Slot

Renders the label of the button.

Slot

prefix - Renders content before the label of the button.

Slot

suffix - Renders content after the label of the button.

Csspart

base - The native button element of the igc-button component.

Csspart

prefix - The prefix container of the igc-button component.

Csspart

suffix - The suffix container of the igc-button component.

Hierarchy

IgcButtonBaseComponent
- IgcButtonComponent

Constructors

Properties

Accessors

Methods

Constructors

constructor

new IgcButtonComponent(): IgcButtonComponent
Overrides IgcButtonBaseComponent.constructor
- Defined in src/components/button/button.ts:42
Returns IgcButtonComponent

Properties

`Optional`download

download?: string

Prompts to save the linked URL instead of navigating to it.

Attr

`Optional`href

href?: string

The URL the button points to.

Attr

`Optional`rel

rel?: string

The relationship of the linked URL. See https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types

Attr

`Optional`target

target?: "_blank" | "_parent" | "_self" | "_top"

Where to display the linked URL, as the name for a browsing context.

Attr

type

type: "reset" | "submit" | "button" = 'button'

The type of the button. Defaults to button.

Attr

variant

variant: ButtonVariant = 'contained'

Sets the variant of the button.

Attr

`Static` `Readonly`formAssociated

formAssociated: true = true

`Static` `Readonly`tagName

tagName: "igc-button" = 'igc-button'

Accessors

disabled

get disabled(): boolean
Inherited from IgcButtonBaseComponent.disabled
- Defined in src/components/button/button-base.ts:83
Returns boolean
set disabled(value: boolean): void
Inherited from IgcButtonBaseComponent.disabled
- Defined in src/components/button/button-base.ts:78
The disabled state of the component

Attr
[disabled=false]

Parameters
- value: boolean
Returns void

form

get form(): HTMLFormElement | null
Inherited from IgcButtonBaseComponent.form
- Defined in src/components/button/button-base.ts:90
Returns the HTMLFormElement associated with this element.

Returns HTMLFormElement | null

Methods

addEventListener

addEventListener<
    K extends string
    | number
    | symbol,
    M extends IgcButtonEventMap & HTMLElementEventMap,
>(
    type: K,
    listener: (this: HTMLElement, ev: M[K]) => any,
    options?: boolean | AddEventListenerOptions,
): void
Inherited from IgcButtonBaseComponent.addEventListener
- Defined in src/components/common/mixins/event-emitter.ts:7
Type parameters
Type Parameters
- K extends string | number | symbol
- M extends IgcButtonEventMap & 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
Inherited from IgcButtonBaseComponent.addEventListener
- Defined in src/components/common/mixins/event-emitter.ts:12
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
Inherited from IgcButtonBaseComponent.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:17886
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
Inherited from IgcButtonBaseComponent.blur
- Defined in src/components/button/button-base.ts:107
Removes focus from the button.

Returns void

click

click(): void
Inherited from IgcButtonBaseComponent.click
- Defined in src/components/button/button-base.ts:101
Simulates a mouse click on the element

Returns void

emitEvent

emitEvent<K extends keyof IgcButtonEventMap, D extends unknown>(
type: K,
eventInitDict?: CustomEventInit<D>,
): boolean
Inherited from IgcButtonBaseComponent.emitEvent
- Defined in src/components/common/mixins/event-emitter.ts:30
Type parameters
Type Parameters
- K extends keyof IgcButtonEventMap
- D extends unknown
Parameters
- type: K
- eventInitDict: CustomEventInit<D>
Returns boolean

focus

focus(options?: FocusOptions): void
Inherited from IgcButtonBaseComponent.focus
- Defined in src/components/button/button-base.ts:96
Sets focus in the button.

Parameters
- options: FocusOptions
Returns void

removeEventListener

removeEventListener<
    K extends string
    | number
    | symbol,
    M extends IgcButtonEventMap & HTMLElementEventMap,
>(
    type: K,
    listener: (this: HTMLElement, ev: M[K]) => any,
    options?: boolean | EventListenerOptions,
): void
Inherited from IgcButtonBaseComponent.removeEventListener
- Defined in src/components/common/mixins/event-emitter.ts:17
Type parameters
Type Parameters
- K extends string | number | symbol
- M extends IgcButtonEventMap & 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
Inherited from IgcButtonBaseComponent.removeEventListener
- Defined in src/components/common/mixins/event-emitter.ts:25
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
Inherited from IgcButtonBaseComponent.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:17888
Type parameters
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- type: K
- listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any
- options: boolean | EventListenerOptions
Returns void

Class IgcButtonComponent

Element

Slot

Slot

Slot

Csspart

Csspart

Csspart

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns IgcButtonComponent

Properties

Optionaldownload

Attr

Optionalhref

Attr

Optionalrel

Attr

Optionaltarget

Attr

type

Attr

variant

Attr

Static ReadonlyformAssociated

Static ReadonlytagName

Accessors

disabled

Returns boolean

Attr

Parameters

value: boolean

Returns void

form

Returns HTMLFormElement | null

Methods

addEventListener

Type parameters

Type Parameters

Parameters

type: K

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

options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

options: boolean | AddEventListenerOptions

Returns void

Type parameters

Type Parameters

Parameters

type: K

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

options: boolean | AddEventListenerOptions

Returns void

blur

Returns void

click

Returns void

emitEvent

Type parameters

Type Parameters

Parameters

type: K

eventInitDict: CustomEventInit<D>

Returns boolean

focus

Parameters

options: FocusOptions

Returns void

removeEventListener

Type parameters

Type Parameters

`Optional`download

`Optional`href

`Optional`rel

`Optional`target

`Static` `Readonly`formAssociated

`Static` `Readonly`tagName

`Static`register