Skip to content

panel.xml

panel.xml extends an existing backend panel with additional categories or settings sections.

Use it only when a package needs to integrate into a specific backend panel and the panel type is known.

Basic Structure

xml
<quiqqer>
    <window name="package/quiqqer/bricks/bin/BrickEdit">
        <categories>
            <category name="history">
                <text>
                    <locale group="quiqqer/history" var="title"/>
                </text>
                <image>fa fa-clock-o</image>
            </category>
        </categories>
    </window>
</quiqqer>

The window name targets the panel type. The category name must be stable because the panel uses it to render the category.

Settings Sections

Panel extensions use the same category/settings/input structure as settings XML.

xml
<settings name="history">
    <input type="hidden" data-qui="package/quiqqer/history/bin/Brick">
        <text>-</text>
    </input>
</settings>

Use package AMD modules for custom controls through data-qui.

Real Package Shape

quiqqer/history extends the brick edit panel with a history category:

xml
<quiqqer>
    <window name="package/quiqqer/bricks/bin/BrickEdit">
        <categories>
            <category name="history">
                <text>
                    <locale group="quiqqer/history" var="title"/>
                </text>

                <image>fa fa-clock-o</image>

                <settings name="history">
                    <input type="hidden" data-qui="package/quiqqer/history/bin/Brick">
                        <text>-</text>
                    </input>
                </settings>
            </category>
        </categories>
    </window>
</quiqqer>

Practical Checklist

Before adding panel.xml:

  • Verify the target panel type.
  • Use a stable category name.
  • Localize category text.
  • Use package-owned AMD modules for custom controls.
  • Keep the extension focused on that panel.

Released under GPL-3.0-or-later.