Interface ModalToolCreationParameters

Parameters for creating a modal tool in the tool container

interface ModalToolCreationParameters {
    action?: RegisteredAction<NoArgsAction>;
    contentBadgeId?: string;
    icon?: string;
    staging?: boolean;
    title?: string;
    tooltip?: BasicTooltipContent;
}

Index

Properties

action? contentBadgeId? icon? staging? title? tooltip?

Properties

`Optional`action

action?: RegisteredAction<NoArgsAction>

Remarks

Action associated with tool activation

`Optional`contentBadgeId

contentBadgeId?: string

Remarks

Content badge id associated with the modal tool

`Optional`icon

icon?: string

Remarks

Icon resource

`Optional`staging

staging?: boolean

Remarks

When true, the tool will be excluded from tool groups and tool rail

`Optional`title

title?: string

Remarks

Localized title of the tool

`Optional`tooltip

tooltip?: BasicTooltipContent

Remarks

Tooltip description of the tool