PluginSuggestionComponent

Suggests installing another community plugin, via a load-time notice and a settings-tab banner.

Import:

import { PluginSuggestionComponent } from 'obsidian-dev-utils/obsidian/components/plugin-suggestion-component';

Signature:

export class PluginSuggestionComponent extends ComponentEx

Extends: ComponentEx

Constructor

new PluginSuggestionComponent(params: PluginSuggestionComponentConstructorParams)

Creates an instance of PluginSuggestionComponent.

Methods

Method	Returns	Description
[Symbol.dispose]()	void	Disposes of the component. (Inherited from ComponentEx)
addChild(component)	TComponent	Adds a child component. Mirrors the native Component.addChild contract: if this component is already loaded, the child is loaded immediately, so child._loaded is set before this method returns even when this component has async load logic. The child's async tail (if any) is sequenced into the load promise so a later loadWithPromises call awaits it. Adding a child BEFORE the first load is legitimate: the child is queued and loaded when this component loads. Adding one AFTER this component has been unloaded is not — the child would never be loaded and never unloaded (a leak), so it is refused with a SilentError. The typical source of such a call is an async method that was suspended on an await when the component got unloaded and then resumed on the dead component; the SilentError unwinds it quietly (see isUnloaded). (Inherited from ComponentEx)
ensureLoaded()	void	Ensures the component is loaded, throwing if it is not. Use this to guard public methods that register teardown-bearing resources (via Component.register, Component.registerEvent, Component.registerDomEvent, etc.). Registering before load is unsafe: Component.unload is a no-op while the component is not loaded, so any teardown registered beforehand would never run if the component is unloaded without first being loaded. The two not-loaded cases are deliberately distinguished. A component that was NEVER loaded is a genuine programming error, so it throws a loud Error. A component that has ALREADY been unloaded is not — it is the expected outcome of work that outlived its component (e.g. an async method suspended on an await while the component was unloaded, then resumed) — so it throws a SilentError, which handleSilentError suppresses, letting such work unwind quietly instead of reporting an async error. (Inherited from ComponentEx)
getInFlightLoadPromise()	null | Promise<void>	Returns the component's in-flight load Promise (its onloadAsync plus children), or null when nothing is loading — either the component loaded fully synchronously or its async load has already settled. Lets a caller scheduled while the component is still loading await the async load tail before acting, instead of racing it. The motivating case is a layout-ready handler (see LayoutReadyComponent) that fires because the component was loaded after the workspace layout was already ready: Component.onload has run (so _loaded is set) but onloadAsync may not have finished. (Inherited from ComponentEx)
getSuggestedPluginState()	SuggestedPluginState	Resolves how the suggested plugin is currently present in the vault.
hasLoadErrors()	boolean	Returns whether the most recent load recorded any failure. Reflects the outcome of the last load / loadWithPromises: true when onloadAsync or any child's load threw (synchronously or asynchronously). Unlike loadWithPromises, reading this does NOT re-raise the collected errors — it lets a bystander (e.g. a layout-ready handler awaiting the in-flight load) tell whether the load succeeded without adopting a failure that the load's owner is already responsible for. (Inherited from ComponentEx)
installAndEnableSuggestedPlugin()	Promise<void>	Installs (when needed) and enables the suggested plugin, reporting the outcome as a notice.
isUnloaded()	boolean	Returns whether the component has already been unloaded, as opposed to simply not having been loaded yet. Both states leave _loaded false, but they mean opposite things: a component that was never loaded is still ahead of its lifecycle (queueing children before load is legitimate), while an unloaded one is behind it and must not be used any further. The distinction is tracked by a flag set in load, NOT by an Component.onunload override, because subclasses override onunload and may not call super. Use it in a long-running async method to abandon work whose component was unloaded mid-flight, when unwinding via the SilentError thrown by ensureLoaded / addChild is not desired. (Inherited from ComponentEx)
load()	void	Loads the component. (Inherited from ComponentEx)
loadWithPromises()	null | Promise<void>	Loads the component with promises. Unlike load, this method never rejects with an individual error: every failure raised by onloadAsync or a child's load is collected, and once everything settles the returned Promise rejects with a single AggregateError holding all of them. Non-Error throwables are normalized via ErrorWrapper.create. (Inherited from ComponentEx)
onload()	void	Loads the component, showing the suggestion notice once the layout is ready AND the host's settings have been read from disk. Both waits matter, and neither implies the other: - Layout-ready, because plugins load in an unspecified order, so the suggested plugin may well be enabled a moment after this one. Checking earlier would suggest installing something the user already has. - Settings-loaded, because PluginSuggestionComponentConstructorParams.isSuggestionDeclined reads a setting of the host, and the host's settings component is a SIBLING whose own async load is still in flight here. On a layout that is already ready — a runtime enable from the Community Plugins tab, or a re-enable after an update — the layout-ready callback fires immediately, so the read would see the default false and ask again a user who has already declined.
onloadAsync()	Promise<void>	Asynchronously loads the component. Override to add async load logic, which is executed after Component.onload. (Inherited from ComponentEx)
registerDisposable(disposable)	TDisposable	Registers a Disposable so it is disposed when this component unloads, and returns it unchanged. The recurring "tie a disposable to the component's lifecycle, then keep using it" idiom: the disposable is disposed on Component.unload (or earlier, if the caller disposes it directly — dispose is expected to be idempotent). Guard with ensureLoaded at the call site when registering before load would be unsafe. (Inherited from ComponentEx)
removeChild(component)	TComponent	Removes a child component. (Inherited from ComponentEx)
renderBanner(containerEl)	void	Renders the suggestion banner into a settings-tab container, with a button that installs and enables the suggested plugin. Renders nothing when the suggested plugin is already enabled. Unlike the notice, the banner ignores a previous decline — the user is looking at these settings right now, which is a fresher signal than an answer they gave earlier.

---

Links to this page:

• PluginSuggestionComponentConstructorParams