Skip to main content
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

Badge Configuration

Each badge requires all of these properties:

Icon Options

Badge icons use Lucide icon classes in the form icon-[lucide--<icon-name>]. Here are some commonly used icons:
  • Documentation: icon-[lucide--file] or icon-[lucide--book-open]
  • GitHub: icon-[lucide--github]
  • External link: icon-[lucide--external-link]
  • Information: icon-[lucide--info]
  • Download: icon-[lucide--download]
  • Website: icon-[lucide--globe]
The frontend generates these classes when it is built, so only the Lucide icons that the frontend itself uses are available. If an icon does not render, pick another icon, or define your own icon class in a stylesheet that your extension loads. PrimeIcons classes such as pi pi-file still render for now, but they are being phased out. Don’t use them in new code. See PrimeVue removal migration.

Example

Badges appear in the About panel of the Settings dialog, which can be accessed via the gear icon in the top-right corner of the ComfyUI interface.