Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ImageButton

A image button with an image displayed on it.

Hierarchy

  • ImageButton

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional imageButton

imageButton: { icon?: Icon; iconUrl?: string; onClick?: OpenLink | Action }

Type declaration

  • Optional icon?: Icon
  • Optional iconUrl?: string
  • Optional onClick?: OpenLink | Action

Methods

setIcon

  • Sets a predefined {@link @ICON | Icon}} to display on the button.

    Parameters

    • icon: Icon

      One of the predefined {@link @ICON | Icon} values.

    Returns ImageButton

    • this object, for chaining.

setIconUrl

  • Sets the URL of an image to use as this button's icon.

    Parameters

    • iconUrl: string

      The URL address of a hosted image to use as this button's icon.

    Returns ImageButton

    • this object for chaining

setOnClick

  • Sets an action that executes when the object is clicked.

    Parameters

    • onClick: OpenLink | Action

      The action to take when this element is clicked.

    Returns ImageButton

    • this object, for chaining.

Generated using TypeDoc