@umbraco-cms/backoffice
    Preparing search index...

    Interface UmbWorkspaceAction<ArgsMetaType>

    interface UmbWorkspaceAction<ArgsMetaType = never> {
        args: UmbWorkspaceActionArgs;
        isDisabled: Observable<boolean>;
        isExecuting?: Observable<boolean>;
        destroy(): void;
        execute(): Promise<void>;
        getHref?(): Promise<string | undefined>;
    }

    Type Parameters

    • ArgsMetaType = never

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    isDisabled: Observable<boolean>
    isExecuting?: Observable<boolean>

    Emits true while execute() is performing real work (e.g. after a preceding modal/dialog has been confirmed) and false otherwise.

    Consumers (such as the workspace action element) use this to show in-flight UI - e.g. a button spinner - only while work is actually happening, not while a user is interacting with a modal.

    Optional; when not exposed, consumers fall back to assuming work begins immediately on execute().

    Methods