mirror of
https://github.com/Comfy-Org/ComfyUI-Manager.git
synced 2025-12-17 02:12:58 +08:00
[docs] Add README for js directory
This commit is contained in:
parent
416122d61d
commit
6d8f1e242c
60
js/README.md
Normal file
60
js/README.md
Normal file
@ -0,0 +1,60 @@
|
|||||||
|
# ComfyUI-Manager: Frontend (js)
|
||||||
|
|
||||||
|
This directory contains the JavaScript frontend implementation for ComfyUI-Manager, providing the user interface components that interact with the backend API.
|
||||||
|
|
||||||
|
## Core Components
|
||||||
|
|
||||||
|
- **comfyui-manager.js**: Main entry point that initializes the manager UI and integrates with ComfyUI.
|
||||||
|
- **custom-nodes-manager.js**: Implements the UI for browsing, installing, and managing custom nodes.
|
||||||
|
- **model-manager.js**: Handles the model management interface for downloading and organizing AI models.
|
||||||
|
- **components-manager.js**: Manages reusable workflow components system.
|
||||||
|
- **snapshot.js**: Implements the snapshot system for backing up and restoring installations.
|
||||||
|
|
||||||
|
## Sharing Components
|
||||||
|
|
||||||
|
- **comfyui-share-common.js**: Base functionality for workflow sharing features.
|
||||||
|
- **comfyui-share-copus.js**: Integration with the ComfyUI Opus sharing platform.
|
||||||
|
- **comfyui-share-openart.js**: Integration with the OpenArt sharing platform.
|
||||||
|
- **comfyui-share-youml.js**: Integration with the YouML sharing platform.
|
||||||
|
|
||||||
|
## Utility Components
|
||||||
|
|
||||||
|
- **cm-api.js**: Client-side API wrapper for communication with the backend.
|
||||||
|
- **common.js**: Shared utilities and helper functions used across the frontend.
|
||||||
|
- **node_fixer.js**: Utilities for fixing and repairing broken node installations.
|
||||||
|
- **popover-helper.js**: UI component for popup tooltips and contextual information.
|
||||||
|
- **turbogrid.esm.js**: Grid component for displaying tabular data efficiently.
|
||||||
|
- **workflow-metadata.js**: Handles workflow metadata and associated operations.
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
The frontend follows a modular component-based architecture:
|
||||||
|
|
||||||
|
1. **Integration Layer**: Connects with ComfyUI's existing UI system
|
||||||
|
2. **Manager Components**: Individual functional UI components (node manager, model manager, etc.)
|
||||||
|
3. **Sharing Components**: Platform-specific sharing implementations
|
||||||
|
4. **Utility Layer**: Reusable UI components and helpers
|
||||||
|
|
||||||
|
## Implementation Details
|
||||||
|
|
||||||
|
- The frontend integrates directly with ComfyUI's UI system through `app.js`
|
||||||
|
- Dialog-based UI for most manager functions to avoid cluttering the main interface
|
||||||
|
- Asynchronous API calls to handle backend operations without blocking the UI
|
||||||
|
- Comprehensive error handling and user feedback mechanisms
|
||||||
|
- Support for various extension points to enable third-party integrations
|
||||||
|
|
||||||
|
## UI Features
|
||||||
|
|
||||||
|
- Tabbed interface for different management functions
|
||||||
|
- Grid-based displays for browsing available nodes and models
|
||||||
|
- File browse and upload interfaces for local operations
|
||||||
|
- Status indicators for installation, update, and operation progress
|
||||||
|
- Sharing dialogs for various platforms with appropriate metadata handling
|
||||||
|
|
||||||
|
## Styling
|
||||||
|
|
||||||
|
CSS files are included for specific components:
|
||||||
|
- **custom-nodes-manager.css**: Styling for the node management UI
|
||||||
|
- **model-manager.css**: Styling for the model management UI
|
||||||
|
|
||||||
|
This frontend implementation provides a comprehensive yet user-friendly interface for managing the ComfyUI ecosystem.
|
||||||
Loading…
Reference in New Issue
Block a user