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

Constructors

constructor

Properties

collection download href mirrored name rel size target type variant formAssociated tagName

Accessors

disabled form

Methods

blur click emitEvent focus

Constructors

constructor

Properties

collection

collection: string

The name of the icon collection.

Attr

download

download: string

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

Attr

href

href: string

The URL the button points to.

Attr

mirrored

mirrored: boolean = false

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

Attr

name

name: string

The name of the icon.

Attr

rel

rel: string

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

Attr

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.

Attr

type

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

The type of the button. Defaults to undefined.

Attr

variant

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

The visual variant of the icon button.

Attr

Static Readonly formAssociated

formAssociated: true = true

Static Readonly tagName

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

Accessors

disabled

form

  • get form(): null | HTMLFormElement

  • Returns the HTMLFormElement associated with this element.

    Returns null | HTMLFormElement

Methods

blur

click

emitEvent

  • Type Parameters

    • K extends keyof IgcButtonEventMap

    • D extends void

    Parameters

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

    Returns boolean

focus

  • Sets focus in the button.

    Parameters

    • Optional options: FocusOptions

    Returns void