status_bar_widgets.md: note about StatusBarWidgetFactory id

This commit is contained in:
Yann Cébron 2023-08-02 11:14:03 +02:00
parent 67b3c248d5
commit 9c320c59d5

View File

@ -20,6 +20,7 @@ Due to the prominent presentation and limited space, they should be used only fo
The starting point for extending the status bar with new widgets is the
[`StatusBarWidgetFactory`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/wm/StatusBarWidgetFactory.java)
interface, which is registered in the `com.intellij.statusBarWidgetFactory` extension point.
Note: `id` attribute must be provided in <path>plugin.xml</path> registration and match value from `StatusBarWidgetFactory.getId()`.
In case a widget provides information or functionality related to the editor files, consider extending the
[`StatusBarEditorBasedWidgetFactory`](%gh-ic%/platform/platform-impl/src/com/intellij/openapi/wm/impl/status/widget/StatusBarEditorBasedWidgetFactory.kt)