Interface ICommand<STATE, CONTEXT>

interface ICommand<STATE, CONTEXT> {
    addExecuteListener(listener): RemoveListener;
    addPropertyListener(listener, fireOnListen?): RemoveListener;
    context(): CONTEXT;
    description(context?): string;
    disabled(): boolean;
    execute(args?, hook?): Promise<boolean>;
    icon(context?): ReactNode;
    key(): string;
    label(scope?, context?): string;
    shortcut(): IKeyStroke | IKeyStroke[];
    state(): STATE;
    tags(context?): string[];
    target(): CommandTarget;
    update(props): ICommand<STATE, CONTEXT>;
    updateCallback(callback): ICommand<STATE, CONTEXT>;
}

Type Parameters

STATE extends any = any
CONTEXT extends any = void

Implemented by

Command

Index

Methods

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

Methods

addExecuteListener

addExecuteListener(listener): RemoveListener
Parameters
- listener: ICommandHook<STATE, CONTEXT>
Returns RemoveListener

addPropertyListener

addPropertyListener(listener, fireOnListen?): RemoveListener
This is call when any command properties are changed but not when the callback is changed
Parameters
- listener: ICommandPropertyListener<STATE, CONTEXT>
- Optional fireOnListen: boolean
Returns RemoveListener

context

context(): CONTEXT
Returns CONTEXT

description

description(context?): string
Parameters
- Optional context: DynamicContext<CONTEXT>
Returns string

disabled

disabled(): boolean
Returns boolean

execute

execute(args?, hook?): Promise<boolean>
Parameters
- Optional args: STATE
- Optional hook: ICommandHook<STATE, CONTEXT>
Returns Promise<boolean>

icon

icon(context?): ReactNode
Parameters
- Optional context: DynamicContext<CONTEXT>
Returns ReactNode

key

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

Returns string
Remarks
Immutable

label

label(scope?, context?): string
Parameters
- Optional scope: string
- Optional context: DynamicContext<CONTEXT>
Returns string

shortcut

shortcut(): IKeyStroke | IKeyStroke[]
Returns IKeyStroke | IKeyStroke[]

state

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

Returns STATE

tags

tags(context?): string[]
Parameters
- Optional context: DynamicContext<CONTEXT>
Returns string[]

target

target(): CommandTarget
Returns CommandTarget

update

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

updateCallback

updateCallback(callback): ICommand<STATE, CONTEXT>
Parameters
- callback: ICommandCallback<STATE>
Returns ICommand<STATE, CONTEXT>