PluginGateComponentConstructorParams

Parameters for the PluginGateComponent constructor.

Import:

import type { PluginGateComponentConstructorParams } from 'obsidian-dev-utils/obsidian/components/plugin-gate-component';

Signature:

export interface PluginGateComponentConstructorParams

Properties

Property	Type	Description
conflicts	readonly PluginConflict[]	The conflicts to enforce. An empty list means the plugin refuses to run beside nothing.
dependencies	readonly PluginDependency[]	The dependencies to enforce. An empty list means the plugin depends on nothing, and its feature surface loads immediately.
plugin	Plugin	The host plugin — the one declaring the dependencies and conflicts.
pluginNoticeComponent	PluginNoticeComponent	The host plugin's notice component, used to say what is missing, what is in the way, and what changed.

Methods

Method	Returns	Description
loadFeatureSurface(this)	Promise<void>	Loads the host plugin's feature surface. Called once every dependency is satisfied and no blocking conflict holds, and again after a gate that had closed opens back up.
unloadFeatureSurface(this)	void	Unloads the host plugin's feature surface. Called when a gate that had been open closes.