Skip to content

PluginSuggestionComponent.onload method

PluginSuggestionComponent › onload

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.

Signature:

onload(): void

Returns: void