PluginConflict
A plugin another plugin refuses to run beside, or warns about running beside.
Import:
import type { PluginConflict } from 'obsidian-dev-utils/obsidian/components/plugin-gate-component';Signature:
export interface PluginConflictProperties
| Property | Type | Description |
|---|---|---|
| conflictingVersionRange | string | The semver range of the OTHER plugin's versions that conflict, e.g. '<12.0.0' for "every version before the one that gave this behavior up".A range rather than a minimum, so an overlap confined to one major ( '>=3 <4') is expressible, and so is a plugin that conflicts at every version — spell that '>=0.0.0', since compare-versions rejects a bare *. Evaluated against manifest.version; a version that cannot be parsed counts as conflicting. |
| pluginId | string | The manifest.id of the conflicting plugin, as listed in Obsidian's community plugin registry. |
| pluginName | string | The display name of the conflicting plugin, shown to the user. |
| reason | string | A localized sentence saying what goes wrong when both run, shown in the banner. The declaring plugin owns this string because only it knows what the two of them collide over, and a user being asked to disable something deserves to be told why. |
| severity | PluginConflictSeverity | What this plugin does about the conflict. |
Links to this page: