Interface CommonJsButtonOptions

Button options for buttons with JS handlers (renders as a button)

Hierarchy

Properties

buttonContext? className? dataTestId? disabled? height? onBlur? onButtonClicked? openInNewTab? path? type? width?

Properties

Optional buttonContext

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.

Optional className

className?: string

Optional class

Optional dataTestId

dataTestId?: string

Optional data-test-id

Optional disabled

disabled?: boolean

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

Optional height

height?: string | number

Button's height

Optional onBlur

onBlur?: FocusEventHandler<HTMLButtonElement>

Optional onButtonClicked

onButtonClicked?: ((event) => void)

Type declaration

    • (event): void

    • Event to raise when the button is clicked

      Parameters

      • event: MouseEvent<HTMLButtonElement, MouseEvent>

      Returns void

Optional openInNewTab

openInNewTab?: undefined

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

Optional path

path?: undefined

Where to navigate to when the action is clicked.

Optional type

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

HTML button type attribute (default: 'button')

Optional width

width?: string | number

Button's width

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc