Interface PageHeaderJsActionProps

Properties for Action click confirmation

Hierarchy

Properties

actionType? className? confirmationConfig? confirmationMode? disabled? icon? imgAlt? label onClick openInNewTab? path?

Properties

Optional actionType

actionType?: PageHeaderActionType

Whether the action is an 'Active' or 'Context' type. Changes the background color to the corresponding action type. (default: 'Context')

Optional className

className?: string

Optional class

Optional confirmationConfig

confirmationConfig?: ConfirmationConfig

Optional text overrides for the confirmation pop up.

Optional confirmationMode

confirmationMode?: ConfirmationMode

If set to 'Simple', the action will require confirmation. If set to 'Advanced', action will require confirmation via a confirmation pop up. (default: 'None')

Optional disabled

disabled?: boolean

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

Optional icon

icon?: string | IconName

Optional built in icon. This prop also accepts an img src.

Optional imgAlt

imgAlt?: string

Optional image alt attribute.

label

label: string

The label of the action.

onClick

onClick: DefaultHandler

Callback to emit when a user clicks on the component

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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc