Standard Plugins » Action Panel » Elements

Action Panel Elements

Use your plugin’s requirements.schema file to define the action panels you want to use. Remember that multiple plugins can require the same panel, but it’ll be only included once, so it’s safe to require the same panel in all the plugins which need it.

Action Panel Elements need a panel name, to distinguish between all the different panels in use in your application. A good panel name is as generic as possible, to encourage sharing of panels amongst many plugins. A panel to be displayed on the right of people objects should be called "person".

The panel name is configured in the options of the Element definition. For example, a panel for People objects would be defined in your requirements.schema file like:

type std:type:person as Person
    element: std:group:everyone right std:action_panel {"panel":"person"}

Adding a panel to the home page is similar:

feature std:page:home
    element: std:group:everyone right std:action_panel {"panel":"home_links"}

Element options

As well as the required panel option, you can specify:

key title

A title for the Element, as described in the Element documentation.

key category

A category name for the panel, so consuming plugins can add panel elements based on category as well as by name.

key style

A style for the panel, as described in the O.ui.builder() documentation.

key highlight

A default highlight for the panel, as described in the PanelBuilder documentation.