panels.xml

XML schema: panels.xsd · Linking and validation.

panels.xml registers backend panels that users can add to their workspace.

Use it for reusable administration panels that should appear in the "add panel" workflow.

Basic Structure

<?xml version="1.0" encoding="UTF-8"?>
<quiqqer xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="https://www.quiqqer.com/docs/schemas/2.x/panels.xsd">
    <panels>
        <panel require="package/vendor/package/bin/Panel">
            <image>fa fa-cube</image>
            <title>
                <locale group="vendor/package" var="panels.example.title"/>
            </title>
            <text>
                <locale group="vendor/package" var="panels.example.text"/>
            </text>
        </panel>
    </panels>
</quiqqer>

The require attribute points to the AMD module for the panel.

QUIQQER reads panels from quiqqer/panels/panel.

Panel Metadata

Each panel should provide:

• image for the icon
• title for the add-panel dialog
• text for the panel description

Use locale references for title and text.

Practical Checklist

Before adding panels.xml:

• Register only package-owned AMD panel modules.
• Use localized title and description text.
• Choose an icon that matches the panel purpose.
• Keep the panel usable as a workspace panel, not only as a one-off action.