Skip to main content
Version: latest

IUpdatableAction

Interface

Properties​

id​

Readonly

An unique ID of an action item. Could be used to distinguish actions between each other.

Type​

​string

type​

Readonly

Menu item type

Type​

​Action

Methods​

execute​

A method which will be called when an action should be executed (e.g. when a user clicks on the item)

Signature​

execute() => void

Returns​

​void

getState​

Signature​

getState() => Readonly<ActionState>

Returns​

Returns a state object of the action.

​Readonly<ActionState>

onUpdate​

Signature​

onUpdate() => ISubscription<OnActionUpdateHandler>

Returns​

A subscription for an event when an action is updated.

​ISubscription<OnActionUpdateHandler>

update​

Update the options for the Action

Signature​

update(options: Partial<OmitActionId<ActionOptions>>) => void

Parameters​

NameTypeDescription
optionsPartial<OmitActionId<ActionOptions>>updated options

Returns​

​void