CommandHandlerRegistrationContext

Context provided to command handlers during registration.

Import:

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

Signature:

export interface CommandHandlerRegistrationContext

Properties

Property	Type	Description
activeFileProvider	ActiveFileProvider	Provider for accessing the currently active file.
menuEventRegistrar	MenuEventRegistrar	Registrar for menu event handlers.
pluginName	string	The name of the plugin that owns this command.
shouldAddCommandToSubmenu?	boolean | undefined	Overrides the handler's own shouldAddCommandToSubmenu, or undefined to leave it alone. A menu surface that already wraps every contributed item in a plugin-titled parent entry — such as NotebookNavigatorMenuEventRegistrarComponent — sets this to false, because a handler declaring a section submenu of its own would make Menu.sort() nest a second plugin-titled entry inside the first. Only AbstractFileCommandHandler reads it: the surfaces that need it bridge file and folder menus, never the editor menu.