Panel Properties
Last modified by Eleni Cojocariu on 2026/08/28 09:53
Reference
A Panel is a wiki page carrying one Panels.PanelClass xobject. These are its properties, under the labels the Panel edition form gives them.
| Property | Accepted values | Meaning |
|---|---|---|
| Name | free text | The Panel's display name, used on the Panels home page and in the "Panel List" tab of the Wizard. It is neither the name of the page storing the Panel nor the heading the Panel renders, which comes from the header macro in "Content". |
| Panel type | view, edit | Whether the Panel is displayed while a page is being viewed or while it is being edited. Almost every Panel an administrator places is of type view. |
| Category | Information, Navigation, Tools, Administration, Other | The group the Panel is filed under in the "Panel List" tab. |
| Description | free text | Shown beside the Panel on the Panels home page, and as its tooltip in the Wizard. |
| Content | XWiki syntax | The body of the Panel, normally wrapped in the header and footer macros listed in Panel Content Macros and Variables. |
| Asynchronous rendering | Yes, No (default No) | Renders the Panel in a request of its own, so a slow Panel no longer delays the page around it. |
| Cached | Yes, No (default No) | Keeps the result of the Panel's execution instead of running it on every page view. It has no effect unless asynchronous rendering is on. |
| Context elements | multiple choice | The context the Panel needs while it executes, such as the current user or the current page. The same choice builds the cache key, so a Panel whose output depends on the user must declare it. |
The properties are stored on the Panel's own page, so changing one affects every column the Panel appears in. Which columns those are is a separate, wiki-level or page-level setting covered by Scope of a Panel Configuration.
FAQ
Why does my Panel show the wrong heading?
The heading comes from the argument of the header macro in "Content", not from the "Name" property. Change it in the macro call.
A cached Panel shows another user's data. What went wrong?
Its "Context elements" do not declare the current user, so every reader is served the first reader's cached output.
