Documentation Index
Fetch the complete documentation index at: https://docs.comfy.org/llms.txt
Use this file to discover all available pages before exploring further.
The About Panel Badges API allows extensions to add custom badges to the ComfyUI about page. These badges can display information about your extension and contain links to documentation, source code, or other resources.
Basic Usage
app.registerExtension({
name: "MyExtension",
aboutPageBadges: [
{
label: "Documentation",
url: "https://example.com/docs",
icon: "pi pi-file"
},
{
label: "GitHub",
url: "https://github.com/username/repo",
icon: "pi pi-github"
}
]
});
Badge Configuration
Each badge requires all of these properties:
{
label: string, // Text to display on the badge
url: string, // URL to open when badge is clicked
icon: string // Icon class (e.g., PrimeVue icon)
}
Icon Options
Badge icons use PrimeVue’s icon set. Here are some commonly used icons:
- Documentation:
pi pi-file or pi pi-book
- GitHub:
pi pi-github
- External link:
pi pi-external-link
- Information:
pi pi-info-circle
- Download:
pi pi-download
- Website:
pi pi-globe
- Discord:
pi pi-discord
For a complete list of available icons, refer to the PrimeVue Icons documentation.
Example
app.registerExtension({
name: "BadgeExample",
aboutPageBadges: [
{
label: "Website",
url: "https://example.com",
icon: "pi pi-home"
},
{
label: "Donate",
url: "https://example.com/donate",
icon: "pi pi-heart"
},
{
label: "Documentation",
url: "https://example.com/docs",
icon: "pi pi-book"
}
]
});
