Interface UmbBlockAction<ArgsMetaType>

interface UmbBlockAction<ArgsMetaType> {
    args: UmbBlockActionArgs;
    destroy(): void;
    execute(): Promise<void>;
    getHref(): Promise<string | undefined>;
    getValidationDataPath(): Promise<string | undefined>;
}

Type Parameters

ArgsMetaType

Hierarchy (View Summary)

UmbAction<UmbBlockActionArgs<ArgsMetaType>>
- UmbBlockAction

Implemented by

UmbBlockActionBase

Index

Properties

Methods

destroy execute getHref getValidationDataPath

Properties

args

args: UmbBlockActionArgs

Methods

destroy

destroy(): void
Returns void
Inherited from UmbAction.destroy
- Defined in src/libs/extension-api/models/api.interface.ts:2

execute

execute(): Promise<void>
The execute method, the action will act as a button.

Returns Promise<void>
Overrides UmbAction.execute
- Defined in src/packages/block/block/action/block-action.interface.ts:16

getHref

getHref(): Promise<string | undefined>
The href location, the action will act as a link. The execute method will not be called.

Returns Promise<string | undefined>
- Defined in src/packages/block/block/action/block-action.interface.ts:10

getValidationDataPath

getValidationDataPath(): Promise<string | undefined>
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.

Returns Promise<string | undefined>
- Defined in src/packages/block/block/action/block-action.interface.ts:24