Options
All
  • Public
  • Public/Protected
  • All
Menu

Command

Index

Properties

Optional enabledCondition

enabledCondition: string

Defines whether the command should be enabled or disabled, which in turns affects the enabled state of any associated button or menu item.

The condition should be expressed as a "when-clause" (as in Visual Studio Code). It's a simple boolean expression that evaluates to true or false. It supports the following operators:

Operator Symbol Example
Equality == "editorType == markdown"
Inequality != "currentScreen != config"
Or || "noteIsTodo || noteTodoCompleted"
And && "oneNoteSelected && !inConflictFolder"

Currently the supported context variables aren't documented, but you can find the list there:

https://github.com/laurent22/joplin/blob/dev/ReactNativeClient/lib/services/commands/stateToWhenClauseContext.ts

Note: Commands are enabled by default unless you use this property.

Optional iconName

iconName: string

Icon to be used on toolbar buttons for example

label

label: string

Label to be displayed on menu items or keyboard shortcut editor for example

name

name: string

Name of command - must be globally unique

Methods

execute

  • execute(props: any): Promise<any>
  • Code to be ran when the command is executed. It maybe return a result.

    Parameters

    • props: any