Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcIconButtonComponent

element

igc-icon-button

csspart

base - The wrapping element.

csspart

icon - The icon element.

Hierarchy

  • IgcButtonBaseComponent
    • IgcIconButtonComponent

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

collection

collection: string

The name of the icon collection.

disabled

disabled: boolean = false

Determines whether the button is disabled.

download

download: string

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

href

href: string

The URL the button points to.

mirrored

mirrored: boolean = false

Whether to flip the icon button. Useful for RTL layouts.

name

name: string

The name of the icon.

rel

rel: string

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

size

size: "small" | "medium" | "large"

Determines the size of the component.

target

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

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

type

type: "button" | "reset" | "submit"

The type of the button. Defaults to undefined.

variant

variant: "flat" | "outlined" | "contained" = 'contained'

The visual variant of the icon button.

Static Readonly tagName

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

Accessors

ariaLabel

  • get ariaLabel(): string
  • set ariaLabel(value: string): void

Methods

blur

  • blur(): void

emitEvent

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

  • Type Parameters

    • K extends keyof IgcButtonEventMap

    • D extends void

    Parameters

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

    Returns boolean

focus

  • focus(options?: FocusOptions): void