obsidian/components/plugin-suggestion-component
Component that suggests installing another community plugin the host plugin needs in order to offer some of its behavior.
A suggestion is not a dependency. Obsidian has no mechanism for one community plugin to require another, and inventing one by refusing to load would punish the user for something they never agreed to. So the host plugin keeps working without the suggested plugin — it simply cannot offer whatever that plugin owns — and this component asks, once, whether the user would like it installed.
The ask is surfaced twice, deliberately, because the two placements answer different questions: a notice on load (“you are missing something you probably want”) and a settings-tab banner (“the settings you came looking for live in another plugin”). Declining silences only the notice — a user who opens the settings tab is asking about the feature right then, so the banner stays.
Classes
Section titled “Classes”| Class | Description |
|---|---|
| PluginSuggestionComponent | Suggests installing another community plugin, via a load-time notice and a settings-tab banner. |
Interfaces
Section titled “Interfaces”| Interface | Description |
|---|---|
| PluginSuggestionComponentConstructorParams | Parameters for the PluginSuggestionComponent constructor. |
| Enum | Description |
|---|---|
| SuggestedPluginState | How the suggested plugin is currently present in the vault. |