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

    Interface UmbBlockAction<ArgsMetaType>

    interface UmbBlockAction<ArgsMetaType> {
        args: UmbBlockActionArgs;
        getHrefObservable?: () => | Promise<
            Observable<string | undefined>
            | undefined,
        >
        | undefined;
        destroy(): void;
        execute(): Promise<void>;
        getHref(): Promise<string | undefined>;
        getValidationDataPath(): Promise<string | undefined>;
        getValidationDataPathObservable?(): | Promise<
            Observable<string | undefined>
            | undefined,
        >
        | undefined;
    }

    Type Parameters

    • ArgsMetaType

    Hierarchy (View Summary)

    Implemented by

    Index
    getHrefObservable?: () => | Promise<Observable<string | undefined> | undefined>
    | undefined

    Optional, but recommended, observable for the href location, the action will act as a link. The execute method will not be called.

    Type Declaration

      • (): Promise<Observable<string | undefined> | undefined> | undefined
      • Returns Promise<Observable<string | undefined> | undefined> | undefined

    • The href location, the action will act as a link. The execute method will not be called. Kept alongside getHrefObservable for actions whose href never changes after resolving once; implement the observable variant instead when the href can change during the action's lifetime.

      Returns Promise<string | undefined>

    • Returns Promise<string | undefined>

      Use getValidationDataPathObservable() instead. Optional validation data path for displaying an invalid badge on the action button. Optional validation data path for displaying an invalid badge on the action button. When provided, the default kind element creates a validation state controller and renders a badge when validation messages exist at the given path.

    • Optional validation data path observable for displaying an invalid badge on the action button. When provided, the default kind element creates a validation state controller and renders a badge when validation messages exist at the given path.

      Returns Promise<Observable<string | undefined> | undefined> | undefined