Class SimpleCommand

Hierarchy (view full)

Command<void, void>
- SimpleCommand

Index

Constructors

Methods

addExecuteListener addPropertyListener context description disabled execute icon key label shortcut state tags target update updateCallback

Constructors

constructor

new SimpleCommand(key, target, props?, callback?): SimpleCommand
Parameters
- key: string
- target: CommandTarget | (() => CommandTarget)
- Optional props: ICommandProperties<void, void>
- Optional callback: ICommandCallback<void>
Returns SimpleCommand
Inherited from Command.constructor

Methods

addExecuteListener

addExecuteListener(listener): RemoveListener
Parameters
- listener: ICommandHook<void, void>
Returns RemoveListener
Inherited from Command.addExecuteListener

addPropertyListener

addPropertyListener(listener, fireOnListen?): RemoveListener
This is call when any command properties are changed but not when the callback is changed
Parameters
- listener: ICommandPropertyListener<void, void>
- fireOnListen: boolean = false
Returns RemoveListener
Inherited from Command.addPropertyListener

context

context(): any
Returns any
Inherited from Command.context

description

description(context?): string
Parameters
- Optional context: DynamicContext<void>
Returns string
Inherited from Command.description

disabled

disabled(): boolean
Returns boolean
Inherited from Command.disabled

execute

execute(args, hook?): Promise<boolean>
Parameters
- args: void
- Optional hook: ICommandHook<void, void>
Returns Promise<boolean>
Inherited from Command.execute

icon

icon(context?): ReactNode
Parameters
- Optional context: DynamicContext<void>
Returns ReactNode
Inherited from Command.icon

key

key(): string
A unique key for the command. This is how the command is identified within the CommandTree

Returns string
Remarks
Immutable

Inherited from Command.key

label

label(scope?, scopedContext?): string
Parameters
- Optional scope: string
- Optional scopedContext: void
Returns string
Inherited from Command.label

shortcut

shortcut(): IKeyStroke | IKeyStroke[]
Returns IKeyStroke | IKeyStroke[]
Inherited from Command.shortcut

state

state(): void
Represents the current state of the value that can also be set

Returns void
Inherited from Command.state

tags

tags(context?): string[]
Parameters
- Optional context: DynamicContext<void>
Returns string[]
Inherited from Command.tags

target

target(): CommandTarget
Returns CommandTarget
Inherited from Command.target

update

update(props): ICommand<void, void>
Additional information that may be needed to render or make decisions about setting state.
Parameters
- props: ICommandProperties<void, void>
Returns ICommand<void, void>
Inherited from Command.update

updateCallback

updateCallback(callback): ICommand<void, void>
Parameters
- callback: ICommandCallback<void>
Returns ICommand<void, void>
Inherited from Command.updateCallback