obsidian/components/release-notes-component
Component that shows a plugin’s release notes once, when the workspace layout is ready.
Several plugins hand-rolled this popup, and every copy had the same defect: it was titled only Release notes, over headings that are bare version numbers, so nothing in it named the plugin. A user with dozens of plugins installed could not tell whose popup it was. This component always names the plugin in the title.
It also owns the wait every copy needed. The notes already shown are stored in the host’s settings, and the host’s settings component is a SIBLING whose own async load is still in flight when the plugin is enabled after the layout is ready. Reading the list then sees the default empty one and shows every note again, on every start. See PluginSettingsComponentBase.whenLoadedFromFile.
Classes
Section titled “Classes”| Class | Description |
|---|---|
| ReleaseNotesComponent | Shows a plugin’s release notes that the user has not seen yet, once the workspace layout is ready. |
Interfaces
Section titled “Interfaces”| Interface | Description |
|---|---|
| ReleaseNotesComponentConstructorParams | Parameters for the ReleaseNotesComponent constructor. |
| Type | Description |
|---|---|
| ReleaseNotes | Release notes, keyed by the semantic version that introduced each one. |