Class Command<STATE, CONTEXT>

Type Parameters

STATE extends any = void
CONTEXT extends any = void

Hierarchy (View Summary)

Command
- SimpleCommand

Index

Constructors

Methods

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

Constructors

constructor

new Command<STATE extends unknown = void, CONTEXT extends unknown = void>(
    key: string,
    target: ITarget | (() => ITarget),
    props?: ICommandProperties<STATE, CONTEXT>,
    callback?: ICommandCallback<STATE>,
): Command<STATE, CONTEXT>
Type Parameters
- STATE extends unknown = void
- CONTEXT extends unknown = void
Parameters
- key: string
- target: ITarget | (() => ITarget)
- Optionalprops: ICommandProperties<STATE, CONTEXT>
- Optionalcallback: ICommandCallback<STATE>
Returns Command<STATE, CONTEXT>

Methods

addExecuteListener

addExecuteListener(listener: ICommandHook<STATE, CONTEXT>): RemoveListener
Parameters
- listener: ICommandHook<STATE, CONTEXT>
Returns RemoveListener
Implementation of ICommand.addExecuteListener

addPropertyListener

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

context

context(): any
Returns any
Implementation of ICommand.context

description

description(context?: DynamicContext<CONTEXT>): string
Parameters
- Optionalcontext: DynamicContext<CONTEXT>
Returns string
Implementation of ICommand.description

disabled

disabled(): boolean
Returns boolean
Implementation of ICommand.disabled

execute

execute(args: STATE, hook?: ICommandHook<STATE, CONTEXT>): Promise<boolean>
Parameters
- args: STATE
- Optionalhook: ICommandHook<STATE, CONTEXT>
Returns Promise<boolean>
Implementation of ICommand.execute

icon

icon(context?: DynamicContext<CONTEXT>): ReactNode
Parameters
- Optionalcontext: DynamicContext<CONTEXT>
Returns ReactNode
Implementation of ICommand.icon

key

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

Returns string
Remarks
Immutable

Implementation of ICommand.key

label

label(scope?: string, scopedContext?: CONTEXT): string
Parameters
- Optionalscope: string
- OptionalscopedContext: CONTEXT
Returns string
Implementation of ICommand.label

shortcut

shortcut(): IKeyStroke | IKeyStroke[]
Returns IKeyStroke | IKeyStroke[]
Implementation of ICommand.shortcut

state

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

Returns STATE
Implementation of ICommand.state

target

target(): ITarget
Returns ITarget
Implementation of ICommand.target

update

update(props: ICommandProperties<STATE, CONTEXT>): 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>
Implementation of ICommand.update

updateCallback

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

Class Command<STATE, CONTEXT>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Command<STATE, CONTEXT>

Methods

addExecuteListener

Parameters

Returns RemoveListener

addPropertyListener

Parameters

Returns RemoveListener

context

Returns any

description

Parameters

Returns string

disabled

Returns boolean

execute

Parameters

Returns Promise<boolean>

icon

Parameters

Returns ReactNode

key

Returns string

Remarks

label

Parameters

Returns string

shortcut

Returns IKeyStroke | IKeyStroke[]

state

Returns STATE

tags

Parameters

Returns string[]

target

Returns ITarget

update

Parameters

Returns ICommand<STATE, CONTEXT>

updateCallback

Parameters

Returns ICommand<STATE, CONTEXT>

Settings

On This Page