OpenSettingsCommandHandler

A command handler that opens the settings tab for a plugin.

Import:

import { OpenSettingsCommandHandler } from 'obsidian-dev-utils/obsidian/command-handlers/open-settings-command-handler';

Signature:

export class OpenSettingsCommandHandler extends GlobalCommandHandler

Extends: GlobalCommandHandler

Constructor

new OpenSettingsCommandHandler(params: OpenSettingsCommandHandlerConstructorParams)

Constructs a new instance.

Properties

Property	Type	Description
app	App	The Obsidian app instance.
icon	IconName	The icon for the command. (Inherited from GlobalCommandHandler)
id	string	The ID of the command. (Inherited from GlobalCommandHandler)
name	string	The display name of the command. (Inherited from GlobalCommandHandler)
settingTab	SettingTab	The setting tab to open.

Methods

Method	Returns	Description
buildCommand()	Command	Builds a plain Obsidian Command object with a checkCallback. (Inherited from GlobalCommandHandler)
canExecute()	boolean	Checks whether the command can currently execute. (Inherited from GlobalCommandHandler)
execute()	void	Executes the command.
onRegistered(context)	Promise<void>	Called after the command has been registered with Obsidian. Subclasses use the provided context to register menu event handlers. (Inherited from GlobalCommandHandler)

---

Links to this page:

• OpenSettingsCommandHandlerConstructorParams