IAutomationDialogActionBarProps
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Members shared by both automation dialogs’ action-bar regions (the footer row).
export interface IAutomationDialogActionBarProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (BETA) Label of the cancel button. | ||
string | (BETA) (Optional) Label of the delete button. Present with IAutomationDialogActionBarProps.onDelete. | ||
string | (BETA) (Optional) Target of the documentation link. Absent when the workspace is white-labeled. | ||
string | (BETA) (Optional) Text of the documentation link. Absent (with IAutomationDialogActionBarProps.helpLinkHref) when the workspace is white-labeled. | ||
boolean | (BETA) Whether a save is in flight; drives the progress spinner and disables Delete. | ||
boolean | (BETA) Whether submitting is currently disabled (validation, saving, execution-timestamp mode). | ||
() => void | (BETA) Closes the dialog without saving. | ||
() => void | (BETA) (Optional) Opens the delete confirmation. Absent when creating a new automation. | ||
() => void | (BETA) Submits the automation. | ||
string | (BETA) Label of the submit button (“Create” / “Save” per mode). | ||
string | (BETA) (Optional) Tooltip shown on the disabled submit button, when there is one. |
Property details
IAutomationDialogActionBarProps.cancelButtonTextpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Label of the cancel button.
cancelButtonText: string;
IAutomationDialogActionBarProps.deleteButtonTextpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Label of the delete button. Present with IAutomationDialogActionBarProps.onDelete.
deleteButtonText?: string;
IAutomationDialogActionBarProps.helpLinkHrefpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Target of the documentation link. Absent when the workspace is white-labeled.
helpLinkHref?: string;
IAutomationDialogActionBarProps.helpLinkTextpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Text of the documentation link. Absent (with IAutomationDialogActionBarProps.helpLinkHref) when the workspace is white-labeled.
helpLinkText?: string;
IAutomationDialogActionBarProps.isSavingpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Whether a save is in flight; drives the progress spinner and disables Delete.
isSaving: boolean;
IAutomationDialogActionBarProps.isSubmitDisabledpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Whether submitting is currently disabled (validation, saving, execution-timestamp mode).
isSubmitDisabled: boolean;
IAutomationDialogActionBarProps.onCancelpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Closes the dialog without saving.
onCancel: () => void;
IAutomationDialogActionBarProps.onDeletepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Opens the delete confirmation. Absent when creating a new automation.
onDelete?: () => void;
IAutomationDialogActionBarProps.onSubmitpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Submits the automation.
onSubmit: () => void;
IAutomationDialogActionBarProps.submitButtonTextpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Label of the submit button (“Create” / “Save” per mode).
submitButtonText: string;
IAutomationDialogActionBarProps.submitButtonTooltipTextpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Tooltip shown on the disabled submit button, when there is one.
submitButtonTooltipText?: string;