Skip to content

EditorCommandHandlerConstructorParams

Parameters for creating an editor command handler.

Import:

import type { EditorCommandHandlerConstructorParams } from 'obsidian-dev-utils/obsidian/command-handlers/editor-command-handler';

Signature:

export interface EditorCommandHandlerConstructorParams extends CommandHandlerConstructorParams

Extends: CommandHandlerConstructorParams

Properties

PropertyTypeDescription
editorMenuItemName?string | undefinedThe item name to use in the editor menu.
editorMenuSection?string | undefinedThe section to use in the editor menu.
editorMenuSubmenuIcon?IconName | undefinedThe icon to use in the editor menu submenu.
iconIconNameThe icon for the command.
(Inherited from CommandHandlerConstructorParams)
idstringThe ID of the command.
(Inherited from CommandHandlerConstructorParams)
namestringThe display name of the command.
(Inherited from CommandHandlerConstructorParams)
shouldAddCommandToSubmenu?boolean | undefinedWhether to add the command to a submenu.