Skip to content

AbstractFileCommandHandlerConstructorParams

Parameters for creating an abstract file command handler.

Import:

import type { AbstractFileCommandHandlerConstructorParams } from 'obsidian-dev-utils/obsidian/command-handlers/abstract-file-command-handler';

Signature:

export interface AbstractFileCommandHandlerConstructorParams extends CommandHandlerConstructorParams

Extends: CommandHandlerConstructorParams

Properties

PropertyTypeDescription
fileMenuItemName?string | undefinedThe item name to use in the single-file menu.
fileMenuSection?string | undefinedThe section to use in the single-file menu.
fileMenuSubmenuIcon?IconName | undefinedThe icon to use in the single-file menu submenu.
filesMenuItemName?string | undefinedThe item name to use in the multi-file menu.
filesMenuSection?string | undefinedThe section to use in the multi-file menu.
filesMenuSubmenuIcon?IconName | undefinedThe icon to use in the multi-file 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.