mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-01-26 19:09:52 +00:00
656 lines
19 KiB
Markdown
656 lines
19 KiB
Markdown
<div align="center">
|
|
|
|
# ComfyUI_frontend
|
|
|
|
**Official front-end implementation of [ComfyUI](https://github.com/comfyanonymous/ComfyUI).**
|
|
|
|
[![Website][website-shield]][website-url]
|
|
[![Discord][discord-shield]][discord-url]
|
|
[![Matrix][matrix-shield]][matrix-url]
|
|
<br>
|
|
[![][github-release-shield]][github-release-link]
|
|
[![][github-release-date-shield]][github-release-link]
|
|
[![][github-downloads-shield]][github-downloads-link]
|
|
[![][github-downloads-latest-shield]][github-downloads-link]
|
|
|
|
|
|
[github-release-shield]: https://img.shields.io/github/v/release/Comfy-Org/ComfyUI_frontend?style=flat&sort=semver
|
|
[github-release-link]: https://github.com/Comfy-Org/ComfyUI_frontend/releases
|
|
[github-release-date-shield]: https://img.shields.io/github/release-date/Comfy-Org/ComfyUI_frontend?style=flat
|
|
[github-downloads-shield]: https://img.shields.io/github/downloads/Comfy-Org/ComfyUI_frontend/total?style=flat
|
|
[github-downloads-latest-shield]: https://img.shields.io/github/downloads/Comfy-Org/ComfyUI_frontend/latest/total?style=flat&label=downloads%40latest
|
|
[github-downloads-link]: https://github.com/Comfy-Org/ComfyUI_frontend/releases
|
|
[matrix-shield]: https://img.shields.io/badge/Matrix-000000?style=flat&logo=matrix&logoColor=white
|
|
[matrix-url]: https://app.element.io/#/room/%23comfyui_space%3Amatrix.org
|
|
[website-shield]: https://img.shields.io/badge/ComfyOrg-4285F4?style=flat
|
|
[website-url]: https://www.comfy.org/
|
|
[discord-shield]: https://img.shields.io/discord/1218270712402415686?style=flat&logo=discord&logoColor=white&label=Discord
|
|
[discord-url]: https://www.comfy.org/discord
|
|
|
|
</div>
|
|
|
|
## Release Schedule
|
|
|
|
### Nightly Release
|
|
|
|
Nightly releases are published daily at [https://github.com/Comfy-Org/ComfyUI_frontend/releases](https://github.com/Comfy-Org/ComfyUI_frontend/releases).
|
|
|
|
To use the latest nightly release, add the following command line argument to your ComfyUI launch script:
|
|
|
|
```bat
|
|
--front-end-version Comfy-Org/ComfyUI_frontend@latest
|
|
```
|
|
|
|
#### For Windows Stand-alone Build Users
|
|
|
|
Edit your `run_cpu.bat` or `run_nvidia_gpu.bat` file as follows:
|
|
|
|
```bat
|
|
.\python_embeded\python.exe -s ComfyUI\main.py --windows-standalone-build --front-end-version Comfy-Org/ComfyUI_frontend@latest
|
|
pause
|
|
```
|
|
|
|
### Stable Release
|
|
|
|
Stable releases are published bi-weekly in the ComfyUI main repository.
|
|
|
|
## Release Summary
|
|
|
|
### Major features
|
|
|
|
<details id='feature-native-translation'>
|
|
<summary>v1.5: Native translation (i18n)</summary>
|
|
|
|
ComfyUI now includes built-in translation support, replacing the need for third-party translation extensions. Select your language
|
|
in `Comfy > Locale > Language` to translate the interface into English, Chinese (Simplified), Russian, Japanese, or Korean. This native
|
|
implementation offers better performance, reliability, and maintainability compared to previous solutions.<br>
|
|
|
|
More details available here: https://blog.comfy.org/p/native-localization-support-i18n
|
|
</details>
|
|
|
|
<details id='feature-mask-editor'>
|
|
<summary>v1.4: New mask editor</summary>
|
|
|
|
https://github.com/Comfy-Org/ComfyUI_frontend/pull/1284 implements a new mask editor.
|
|
|
|
|
|
</details>
|
|
|
|
<details id='feature-integrated-server-terminal'>
|
|
<summary>v1.3.22: Integrated server terminal</summary>
|
|
|
|
Press Ctrl + ` to toggle integrated terminal.
|
|
|
|
https://github.com/user-attachments/assets/eddedc6a-07a3-4a83-9475-63b3977f6d94
|
|
</details>
|
|
|
|
<details id='feature-keybinding-customization'>
|
|
<summary>v1.3.7: Keybinding customization</summary>
|
|
|
|
## Basic UI
|
|
|
|
|
|
## Reset button
|
|
|
|
|
|
## Edit Keybinding
|
|
|
|
|
|
|
|
[rec.webm](https://github.com/user-attachments/assets/a3984ed9-eb28-4d47-86c0-7fc3efc2b5d0)
|
|
|
|
</details>
|
|
|
|
<details id='feature-node-library-sidebar'>
|
|
<summary>v1.2.4: Node library sidebar tab</summary>
|
|
|
|
#### Drag & Drop
|
|
https://github.com/user-attachments/assets/853e20b7-bc0e-49c9-bbce-a2ba7566f92f
|
|
|
|
#### Filter
|
|
https://github.com/user-attachments/assets/4bbca3ee-318f-4cf0-be32-a5a5541066cf
|
|
</details>
|
|
|
|
<details id='feature-queue-sidebar'>
|
|
<summary>v1.2.0: Queue/History sidebar tab</summary>
|
|
|
|
https://github.com/user-attachments/assets/86e264fe-4d26-4f07-aa9a-83bdd2d02b8f
|
|
</details>
|
|
|
|
<details id='feature-node-search'>
|
|
<summary>v1.1.0: Node search box</summary>
|
|
|
|
#### Fuzzy search & Node preview
|
|
|
|
|
|
#### Release link with shift
|
|
https://github.com/user-attachments/assets/a1b2b5c3-10d1-4256-b620-345de6858f25
|
|
</details>
|
|
|
|
### QoL changes
|
|
|
|
<details id='feature-nested-group'>
|
|
<summary>v1.3.32: **Litegraph** Nested group</summary>
|
|
|
|
https://github.com/user-attachments/assets/f51adeb1-028e-40af-81e4-0ac13075198a
|
|
</details>
|
|
|
|
<details id='feature-group-selection'>
|
|
<summary>v1.3.24: **Litegraph** Group selection</summary>
|
|
|
|
https://github.com/user-attachments/assets/e6230a94-411e-4fba-90cb-6c694200adaa
|
|
</details>
|
|
|
|
<details id='feature-toggle-link-visibility'>
|
|
<summary>v1.3.6: **Litegraph** Toggle link visibility</summary>
|
|
|
|
[rec.webm](https://github.com/user-attachments/assets/34e460ac-fbbc-44ef-bfbb-99a84c2ae2be)
|
|
|
|
</details>
|
|
|
|
<details id='feature-auto-widget-conversion'>
|
|
<summary>v1.3.4: **Litegraph** Auto widget to input conversion</summary>
|
|
|
|
Dropping a link of correct type on node widget will automatically convert the widget to input.
|
|
|
|
[rec.webm](https://github.com/user-attachments/assets/15cea0b0-b225-4bec-af50-2cdb16dc46bf)
|
|
|
|
</details>
|
|
|
|
<details id='feature-pan-mode'>
|
|
<summary>v1.3.4: **Litegraph** Canvas pan mode</summary>
|
|
|
|
The canvas becomes readonly in pan mode. Pan mode is activated by clicking the pan mode button on the canvas menu
|
|
or by holding the space key.
|
|
|
|
[rec.webm](https://github.com/user-attachments/assets/c7872532-a2ac-44c1-9e7d-9e03b5d1a80b)
|
|
|
|
</details>
|
|
|
|
<details id='feature-shift-drag-link-creation'>
|
|
<summary>v1.3.1: **Litegraph** Shift drag link to create a new link</summary>
|
|
|
|
[rec.webm](https://github.com/user-attachments/assets/7e73aaf9-79e2-4c3c-a26a-911cba3b85e4)
|
|
|
|
</details>
|
|
|
|
<details id='feature-optional-input-donuts'>
|
|
<summary>v1.2.62: **Litegraph** Show optional input slots as donuts</summary>
|
|
|
|
|
|
|
|
</details>
|
|
|
|
<details id='feature-group-title-edit'>
|
|
<summary>v1.2.44: **Litegraph** Double click group title to edit</summary>
|
|
|
|
https://github.com/user-attachments/assets/5bf0e2b6-8b3a-40a7-b44f-f0879e9ad26f
|
|
|
|
</details>
|
|
|
|
<details id='feature-group-selection-shortcut'>
|
|
<summary>v1.2.39: **Litegraph** Group selected nodes with Ctrl + G</summary>
|
|
|
|
https://github.com/user-attachments/assets/7805dc54-0854-4a28-8bcd-4b007fa01151
|
|
|
|
</details>
|
|
|
|
<details id='feature-node-title-edit'>
|
|
<summary>v1.2.38: **Litegraph** Double click node title to edit</summary>
|
|
|
|
https://github.com/user-attachments/assets/d61d5d0e-f200-4153-b293-3e3f6a212b30
|
|
|
|
</details>
|
|
|
|
<details id='feature-drag-multi-link'>
|
|
<summary>v1.2.7: **Litegraph** drags multiple links with shift pressed</summary>
|
|
|
|
https://github.com/user-attachments/assets/68826715-bb55-4b2a-be6e-675cfc424afe
|
|
|
|
https://github.com/user-attachments/assets/c142c43f-2fe9-4030-8196-b3bfd4c6977d
|
|
|
|
</details>
|
|
|
|
<details id='feature-auto-connect-link'>
|
|
<summary>v1.2.2: **Litegraph** auto connects to correct slot</summary>
|
|
|
|
#### Before
|
|
https://github.com/user-attachments/assets/c253f778-82d5-4e6f-aec0-ea2ccf421651
|
|
|
|
#### After
|
|
https://github.com/user-attachments/assets/b6360ac0-f0d2-447c-9daa-8a2e20c0dc1d
|
|
</details>
|
|
|
|
<details id='feature-hide-text-overflow'>
|
|
<summary>v1.1.8: **Litegraph** hides text overflow on widget value</summary>
|
|
|
|
https://github.com/user-attachments/assets/5696a89d-4a47-4fcc-9e8c-71e1264943f2
|
|
</details>
|
|
|
|
### Developer APIs
|
|
|
|
<details>
|
|
<summary>v1.6.13: prompt/confirm/alert replacements for ComfyUI desktop</summary>
|
|
|
|
Several browser-only APIs are not available in ComfyUI desktop's electron environment.
|
|
|
|
- `window.prompt`
|
|
- `window.confirm`
|
|
- `window.alert`
|
|
|
|
Please use the following APIs as replacements.
|
|
|
|
```js
|
|
// window.prompt
|
|
window['app'].extensionManager.dialog
|
|
.prompt({
|
|
title: 'Test Prompt',
|
|
message: 'Test Prompt Message'
|
|
})
|
|
.then((value: string) => {
|
|
// Do something with the value user entered
|
|
})
|
|
```
|
|
|
|
|
|
|
|
```js
|
|
// window.confirm
|
|
window['app'].extensionManager.dialog
|
|
.confirm({
|
|
title: 'Test Confirm',
|
|
message: 'Test Confirm Message'
|
|
})
|
|
.then((value: boolean) => {
|
|
// Do something with the value user entered
|
|
})
|
|
```
|
|
|
|
|
|
|
|
```js
|
|
// window.alert
|
|
window['app'].extensionManager.toast
|
|
.addAlert("Test Alert")
|
|
```
|
|
|
|
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>v1.3.34: Register about panel badges</summary>
|
|
|
|
```js
|
|
app.registerExtension({
|
|
name: 'TestExtension1',
|
|
aboutPageBadges: [
|
|
{
|
|
label: 'Test Badge',
|
|
url: 'https://example.com',
|
|
icon: 'pi pi-box'
|
|
}
|
|
]
|
|
})
|
|
```
|
|
|
|
|
|
|
|
</details>
|
|
|
|
<details id='extension-api-bottom-panel-tabs'>
|
|
<summary>v1.3.22: Register bottom panel tabs</summary>
|
|
|
|
```js
|
|
app.registerExtension({
|
|
name: 'TestExtension',
|
|
bottomPanelTabs: [
|
|
{
|
|
id: 'TestTab',
|
|
title: 'Test Tab',
|
|
type: 'custom',
|
|
render: (el) => {
|
|
el.innerHTML = '<div>Custom tab</div>'
|
|
}
|
|
}
|
|
]
|
|
})
|
|
```
|
|
|
|
|
|
|
|
</details>
|
|
|
|
<details id='extension-api-settings'>
|
|
<summary>v1.3.22: New settings API</summary>
|
|
|
|
Legacy settings API.
|
|
|
|
```js
|
|
// Register a new setting
|
|
app.ui.settings.addSetting({
|
|
id: 'TestSetting',
|
|
name: 'Test Setting',
|
|
type: 'text',
|
|
defaultValue: 'Hello, world!'
|
|
})
|
|
|
|
// Get the value of a setting
|
|
const value = app.ui.settings.getSettingValue('TestSetting')
|
|
|
|
// Set the value of a setting
|
|
app.ui.settings.setSettingValue('TestSetting', 'Hello, universe!')
|
|
```
|
|
|
|
New settings API.
|
|
|
|
```js
|
|
// Register a new setting
|
|
app.registerExtension({
|
|
name: 'TestExtension1',
|
|
settings: [
|
|
{
|
|
id: 'TestSetting',
|
|
name: 'Test Setting',
|
|
type: 'text',
|
|
defaultValue: 'Hello, world!'
|
|
}
|
|
]
|
|
})
|
|
|
|
// Get the value of a setting
|
|
const value = app.extensionManager.setting.get('TestSetting')
|
|
|
|
// Set the value of a setting
|
|
app.extensionManager.setting.set('TestSetting', 'Hello, universe!')
|
|
```
|
|
|
|
</details>
|
|
|
|
<details id='extension-api-commands-keybindings'>
|
|
<summary>v1.3.7: Register commands and keybindings</summary>
|
|
|
|
Extensions can call the following API to register commands and keybindings. Do
|
|
note that keybindings defined in core cannot be overwritten, and some keybindings
|
|
are reserved by the browser.
|
|
|
|
```js
|
|
app.registerExtension({
|
|
name: 'TestExtension1',
|
|
commands: [
|
|
{
|
|
id: 'TestCommand',
|
|
function: () => {
|
|
alert('TestCommand')
|
|
}
|
|
}
|
|
],
|
|
keybindings: [
|
|
{
|
|
combo: { key: 'k' },
|
|
commandId: 'TestCommand'
|
|
}
|
|
]
|
|
})
|
|
```
|
|
|
|
</details>
|
|
|
|
<details id='extension-api-topbar-menu'>
|
|
<summary>v1.3.1: Extension API to register custom topbar menu items</summary>
|
|
|
|
Extensions can call the following API to register custom topbar menu items.
|
|
|
|
```js
|
|
app.registerExtension({
|
|
name: 'TestExtension1',
|
|
commands: [
|
|
{
|
|
id: 'foo-id',
|
|
label: 'foo',
|
|
function: () => {
|
|
alert(1)
|
|
}
|
|
}
|
|
],
|
|
menuCommands: [
|
|
{
|
|
path: ['ext', 'ext2'],
|
|
commands: ['foo-id']
|
|
}
|
|
]
|
|
})
|
|
```
|
|
|
|
|
|
</details>
|
|
|
|
<details id='extension-api-toast'>
|
|
<summary>v1.2.27: Extension API to add toast message</summary>i
|
|
|
|
Extensions can call the following API to add toast messages.
|
|
|
|
```js
|
|
app.extensionManager.toast.add({
|
|
severity: 'info',
|
|
summary: 'Loaded!',
|
|
detail: 'Extension loaded!',
|
|
life: 3000
|
|
})
|
|
```
|
|
Documentation of all supported options can be found here: <https://primevue.org/toast/#api.toast.interfaces.ToastMessageOptions>
|
|
|
|
|
|
</details>
|
|
|
|
<details id='extension-api-sidebar-tab'>
|
|
<summary>v1.2.4: Extension API to register custom sidebar tab</summary>
|
|
|
|
Extensions now can call the following API to register a sidebar tab.
|
|
|
|
```js
|
|
app.extensionManager.registerSidebarTab({
|
|
id: "search",
|
|
icon: "pi pi-search",
|
|
title: "search",
|
|
tooltip: "search",
|
|
type: "custom",
|
|
render: (el) => {
|
|
el.innerHTML = "<div>Custom search tab</div>";
|
|
},
|
|
});
|
|
```
|
|
|
|
The list of supported icons can be found here: <https://primevue.org/icons/#list>
|
|
|
|
We will support custom icons later.
|
|
|
|
|
|
</details>
|
|
|
|
<details id='extension-api-selection-toolbox'>
|
|
<summary>v1.10.9: Selection Toolbox API</summary>
|
|
|
|
Extensions can register commands that appear in the selection toolbox when specific items are selected on the canvas.
|
|
|
|
```js
|
|
app.registerExtension({
|
|
name: 'TestExtension1',
|
|
commands: [
|
|
{
|
|
id: 'test.selection.command',
|
|
label: 'Test Command',
|
|
icon: 'pi pi-star',
|
|
function: () => {
|
|
// Command logic here
|
|
}
|
|
}
|
|
],
|
|
// Return an array of command IDs to show in the selection toolbox
|
|
// when an item is selected
|
|
getSelectionToolboxCommands: (selectedItem) => ['test.selection.command']
|
|
})
|
|
```
|
|
|
|
The selection toolbox will display the command button when items are selected:
|
|
|
|
|
|
</details>
|
|
|
|
## Development
|
|
|
|
### Tech Stack
|
|
|
|
- [Vue 3](https://vuejs.org/) with [TypeScript](https://www.typescriptlang.org/)
|
|
- [Pinia](https://pinia.vuejs.org/) for state management
|
|
- [PrimeVue](https://primevue.org/) with [TailwindCSS](https://tailwindcss.com/) for UI
|
|
- [Litegraph](https://github.com/Comfy-Org/litegraph.js) for node editor
|
|
- [zod](https://zod.dev/) for schema validation
|
|
- [vue-i18n](https://github.com/intlify/vue-i18n) for internationalization
|
|
|
|
### Git pre-commit hooks
|
|
|
|
Run `npm run prepare` to install Git pre-commit hooks. Currently, the pre-commit
|
|
hook is used to auto-format code on commit.
|
|
|
|
### Dev Server
|
|
|
|
Note: The dev server will NOT load any extension from the ComfyUI server. Only
|
|
core extensions will be loaded.
|
|
|
|
- Start local ComfyUI backend at `localhost:8188`
|
|
- Run `npm run dev` to start the dev server
|
|
- Run `npm run dev:electron` to start the dev server with electron API mocked
|
|
|
|
#### Access dev server on touch devices
|
|
|
|
Enable remote access to the dev server by setting `VITE_REMOTE_DEV` in `.env` to `true`.
|
|
|
|
After you start the dev server, you should see following logs:
|
|
|
|
```
|
|
> comfyui-frontend@1.3.42 dev
|
|
> vite
|
|
|
|
|
|
VITE v5.4.6 ready in 488 ms
|
|
|
|
➜ Local: http://localhost:5173/
|
|
➜ Network: http://172.21.80.1:5173/
|
|
➜ Network: http://192.168.2.20:5173/
|
|
➜ press h + enter to show help
|
|
```
|
|
|
|
Make sure your desktop machine and touch device are on the same network. On your touch device,
|
|
navigate to `http://<server_ip>:5173` (e.g. `http://192.168.2.20:5173` here), to access the ComfyUI frontend.
|
|
|
|
### Unit Test
|
|
|
|
- `npm i` to install all dependencies
|
|
- `npm run test:jest` to execute all unit tests.
|
|
|
|
### Component Test
|
|
|
|
Component test verifies Vue components in `src/components/`.
|
|
|
|
- `npm run test:component` to execute all component tests.
|
|
|
|
### Playwright Test
|
|
|
|
Playwright test verifies the whole app. See <https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/browser_tests/README.md> for details.
|
|
|
|
### LiteGraph
|
|
|
|
This repo is using litegraph package hosted on <https://github.com/Comfy-Org/litegraph.js>. Any changes to litegraph should be submitted in that repo instead.
|
|
|
|
### Test litegraph changes
|
|
|
|
- Run `npm link` in the local litegraph repo.
|
|
- Run `npm link @comfyorg/litegraph` in this repo.
|
|
|
|
This will replace the litegraph package in this repo with the local litegraph repo.
|
|
|
|
## Internationalization (i18n)
|
|
|
|
Our project supports multiple languages using `vue-i18n`. This allows users around the world to use the application in their preferred language.
|
|
|
|
### Supported Languages
|
|
|
|
- en (English)
|
|
- zh (中文)
|
|
- ru (Русский)
|
|
- ja (日本語)
|
|
- ko (한국어)
|
|
- fr (Français)
|
|
|
|
### How to Add a New Language
|
|
|
|
We welcome the addition of new languages. You can add a new language by following these steps:
|
|
|
|
#### 1. Generate language files
|
|
We use [lobe-i18n](https://github.com/lobehub/lobe-cli-toolbox/blob/master/packages/lobe-i18n/README.md) as our translation tool, which integrates with LLM for efficient localization.
|
|
|
|
Update the configuration file to include the new language(s) you wish to add:
|
|
|
|
|
|
```javascript
|
|
const { defineConfig } = require('@lobehub/i18n-cli');
|
|
|
|
module.exports = defineConfig({
|
|
entry: 'src/locales/en.json', // Base language file
|
|
entryLocale: 'en',
|
|
output: 'src/locales',
|
|
outputLocales: ['zh', 'ru', 'ja'], // Add the new language(s) here
|
|
});
|
|
```
|
|
|
|
Set your OpenAI API Key by running the following command:
|
|
|
|
```sh
|
|
npx lobe-i18n --option
|
|
```
|
|
|
|
Once configured, generate the translation files with:
|
|
|
|
```sh
|
|
npx lobe-i18n locale
|
|
```
|
|
|
|
This will create the language files for the specified languages in the configuration.
|
|
|
|
#### 2. Update i18n Configuration
|
|
|
|
Import the newly generated locale file(s) in the `src/i18n.ts` file to include them in the application's i18n setup.
|
|
|
|
#### 3. Enable Selection of the New Language
|
|
|
|
Add the newly added language to the following item in `src/constants/coreSettings.ts`:
|
|
|
|
```typescript
|
|
{
|
|
id: 'Comfy.Locale',
|
|
name: 'Locale',
|
|
type: 'combo',
|
|
// Add the new language(s) here
|
|
options: [
|
|
{ value: 'en', text: 'English' },
|
|
{ value: 'zh', text: '中文' },
|
|
{ value: 'ru', text: 'Русский' },
|
|
{ value: 'ja', text: '日本語' }
|
|
],
|
|
defaultValue: navigator.language.split('-')[0] || 'en'
|
|
},
|
|
```
|
|
|
|
This will make the new language selectable in the application's settings.
|
|
|
|
#### 4. Test the Translations
|
|
|
|
Start the development server, switch to the new language, and verify the translations.
|
|
You can switch languages by opening the ComfyUI Settings and selecting from the `ComfyUI > Locale` dropdown box.
|
|
|
|
## Deploy
|
|
|
|
- Option 1: Set `DEPLOY_COMFYUI_DIR` in `.env` and run `npm run deploy`.
|
|
- Option 2: Copy everything under `dist/` to `ComfyUI/web/` in your ComfyUI checkout manually.
|