Button options for icon buttons with JS handlers

Hierarchy

Properties

buttonContext?: ButtonContext

Buttons type (default: 'Active'). Affects buttons color and border. Button context type Navigation is deprecated and will be removed in future versions. For navigation type of buttons define path instead of onButtonClicked, onBlur and type properties to render link instead of button.

className?: string

Optional class

customIcon?: ReactNode

Optional custom icon. When provided, icon property is ignored.

dataTestId?: string

Optional data-test-id

disabled?: boolean

Whether the button is disabled. If set to true, disallows interactions. (default: undefined)

height?: string | number

Button's height

icon?: IconName

Optional icon

onBlur?: FocusEventHandler<HTMLButtonElement>
onButtonClicked?: ((event) => void)

Type declaration

    • (event): void
    • Event to raise when the button is clicked

      Parameters

      • event: MouseEvent<HTMLButtonElement, MouseEvent>

      Returns void

openInNewTab?: undefined

If set to true, the link will open in a new tab.

path?: undefined

Where to navigate to when the action is clicked.

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

HTML button type attribute (default: 'button')

width?: string | number

Button's width

Generated using TypeDoc