Panels are a standardised way of displaying information and links as part of your plugin UI.
Each panel is composed of panel elements which build up the UI.
While you can use these templates directly, the
O.ui.panel() builder and the Action Panel standard plugin standard plugin are often more convenient ways to use them, especially when the UI is composed from functionality provided by multiple cooperating plugins.
There are several different styles of panel, each of which take a common view but ignore properties which are not relevant.
std:ui:panel is the default style, intended for use in the sidebar.
These view render a single panel. Using
O.ui.panel() or the Action Panel standard plugin allows you to display more than one panel at once.
Top level view
An array of panel element views. See below for properties.
Where supported by the template, a title to be displayed above the panel.
Where supported by the template, this property specifies an additional level of highlighting for this panel. Values are:
Panel element views
The default style,
std:ui:panel, supports the vast majority of these properties, but the alternative styles will only support a few. All properties are optional.
The main text for the panel element.
The link for the panel element.
An indicator to draw the user’s attention to this panel element. Values are:
||Primary, or usual, next action|
||Secondary action, less likely to be taken|
||An action will which terminate a process|
||Primary, moving process forward|
||Secondary, moving process forward|
||Primary, moving process back|
||Secondary, moving process back|
||Move process forward|
||Move process back|
A title for this panel element.
A heading element. Don’t include a
label if you’re using this property.
true to show a disabled panel element.
true to style the panel element less prominently.
An additional link, as an object containing
Additional explanatory text.
A value of a statistic.
An icon description of the icon to display on this panel element.
Additional panel styles