Skip to content

Commit eb8b67d

Browse files
christian-byrnechristian-byrne
authored
[docs] Update nested README files with comprehensive component listings (#4303)
1 parent d6a8f98 commit eb8b67d

File tree

4 files changed

+285
-75
lines changed

4 files changed

+285
-75
lines changed

‎src/composables/README.md‎

Lines changed: 126 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -66,50 +66,150 @@ The following diagram shows how composables fit into the application architectur
6666

6767
## Composable Categories
6868

69-
ComfyUI's composables are organized into several categories:
69+
The following tables list ALL composables in the system as of 2025-01-30:
7070

7171
### Auth
72-
7372
Composables for authentication and user management:
74-
- `useCurrentUser` - Provides access to the current user information
75-
- `useFirebaseAuthActions` - Handles Firebase authentication operations
7673

77-
### Element
74+
| Composable | Description |
75+
|------------|-------------|
76+
| `useCurrentUser` | Provides access to the current user information |
77+
| `useFirebaseAuthActions` | Handles Firebase authentication operations |
78+
79+
### Bottom Panel Tabs
80+
Composables for terminal and bottom panel functionality:
7881

82+
| Composable | Description |
83+
|------------|-------------|
84+
| `useTerminal` | Core terminal functionality |
85+
| `useTerminalBuffer` | Manages terminal output buffer |
86+
| `useTerminalTabs` | Handles multiple terminal tab management |
87+
88+
### Element
7989
Composables for DOM and element interactions:
80-
- `useAbsolutePosition` - Handles element positioning
81-
- `useDomClipping` - Manages clipping of DOM elements
82-
- `useResponsiveCollapse` - Manages responsive collapsing of elements
8390

84-
### Node
91+
| Composable | Description |
92+
|------------|-------------|
93+
| `useAbsolutePosition` | Handles element positioning |
94+
| `useCanvasPositionConversion` | Converts between canvas and DOM coordinates |
95+
| `useDomClipping` | Manages clipping of DOM elements |
96+
| `useResponsiveCollapse` | Manages responsive collapsing of elements |
97+
98+
### Functional
99+
Utility composables for common patterns:
100+
101+
| Composable | Description |
102+
|------------|-------------|
103+
| `useChainCallback` | Chains multiple callbacks together |
104+
105+
### Manager
106+
Composables for ComfyUI Manager integration:
107+
108+
| Composable | Description |
109+
|------------|-------------|
110+
| `useManagerStatePersistence` | Persists manager UI state |
85111

112+
### Node Pack
113+
Composables for node package management:
114+
115+
| Composable | Description |
116+
|------------|-------------|
117+
| `useInstalledPacks` | Manages installed node packages |
118+
| `useMissingNodes` | Detects and handles missing nodes |
119+
| `useNodePacks` | Core node package functionality |
120+
| `usePackUpdateStatus` | Tracks package update availability |
121+
| `useWorkflowPacks` | Manages packages used in workflows |
122+
123+
### Node
86124
Composables for node-specific functionality:
87-
- `useNodeBadge` - Handles node badge display and interaction
88-
- `useNodeImage` - Manages node image preview
89-
- `useNodeDragAndDrop` - Handles drag and drop for nodes
90-
- `useNodeChatHistory` - Manages chat history for nodes
91125

92-
### Settings
126+
| Composable | Description |
127+
|------------|-------------|
128+
| `useNodeAnimatedImage` | Handles animated images in nodes |
129+
| `useNodeBadge` | Handles node badge display and interaction |
130+
| `useNodeCanvasImagePreview` | Canvas-based image preview for nodes |
131+
| `useNodeChatHistory` | Manages chat history for nodes |
132+
| `useNodeDragAndDrop` | Handles drag and drop for nodes |
133+
| `useNodeFileInput` | Manages file input widgets in nodes |
134+
| `useNodeImage` | Manages node image preview |
135+
| `useNodeImageUpload` | Handles image upload for nodes |
136+
| `useNodePaste` | Manages paste operations for nodes |
137+
| `useNodePricing` | Handles pricing display for nodes |
138+
| `useNodeProgressText` | Displays progress text in nodes |
139+
| `useWatchWidget` | Watches widget value changes |
93140

141+
### Settings
94142
Composables for settings management:
95-
- `useSettingSearch` - Provides search functionality for settings
96-
- `useSettingUI` - Manages settings UI interactions
97143

98-
### Sidebar
144+
| Composable | Description |
145+
|------------|-------------|
146+
| `useSettingSearch` | Provides search functionality for settings |
147+
| `useSettingUI` | Manages settings UI interactions |
99148

149+
### Sidebar Tabs
100150
Composables for sidebar functionality:
101-
- `useNodeLibrarySidebarTab` - Manages the node library sidebar tab
102-
- `useQueueSidebarTab` - Manages the queue sidebar tab
103-
- `useWorkflowsSidebarTab` - Manages the workflows sidebar tab
104-
- `useTemplateWorkflows` - Manages template workflow loading, selection, and display
105151

106-
### Widgets
152+
| Composable | Description |
153+
|------------|-------------|
154+
| `useModelLibrarySidebarTab` | Manages the model library sidebar tab |
155+
| `useNodeLibrarySidebarTab` | Manages the node library sidebar tab |
156+
| `useQueueSidebarTab` | Manages the queue sidebar tab |
157+
| `useWorkflowsSidebarTab` | Manages the workflows sidebar tab |
158+
159+
### Tree
160+
Composables for tree structure operations:
161+
162+
| Composable | Description |
163+
|------------|-------------|
164+
| `useTreeFolderOperations` | Handles folder operations in tree views |
107165

166+
### Widgets
108167
Composables for widget functionality:
109-
- `useBooleanWidget` - Manages boolean widget interactions
110-
- `useComboWidget` - Manages combo box widget interactions
111-
- `useFloatWidget` - Manages float input widget interactions
112-
- `useImagePreviewWidget` - Manages image preview widget
168+
169+
| Composable | Description |
170+
|------------|-------------|
171+
| `useBooleanWidget` | Manages boolean widget interactions |
172+
| `useChatHistoryWidget` | Handles chat history widget |
173+
| `useComboWidget` | Manages combo box widget interactions |
174+
| `useFloatWidget` | Manages float input widget interactions |
175+
| `useImagePreviewWidget` | Manages image preview widget |
176+
| `useImageUploadWidget` | Handles image upload widget |
177+
| `useIntWidget` | Manages integer input widget |
178+
| `useMarkdownWidget` | Handles markdown display widget |
179+
| `useProgressTextWidget` | Manages progress text widget |
180+
| `useRemoteWidget` | Handles remote widget connections |
181+
| `useStringWidget` | Manages string input widget |
182+
183+
### Root-level Composables
184+
General-purpose composables:
185+
186+
| Composable | Description |
187+
|------------|-------------|
188+
| `useBrowserTabTitle` | Manages browser tab title updates |
189+
| `useCachedRequest` | Provides request caching functionality |
190+
| `useCanvasDrop` | Handles drop operations on canvas |
191+
| `useCivitaiModel` | Integrates with Civitai model API |
192+
| `useContextMenuTranslation` | Handles context menu translations |
193+
| `useCopy` | Provides copy functionality |
194+
| `useCopyToClipboard` | Manages clipboard operations |
195+
| `useCoreCommands` | Provides core command functionality |
196+
| `useDownload` | Handles file download operations |
197+
| `useErrorHandling` | Centralized error handling |
198+
| `useGlobalLitegraph` | Access to global LiteGraph instance |
199+
| `useLitegraphSettings` | Manages LiteGraph configuration |
200+
| `useManagerQueue` | Handles manager queue operations |
201+
| `usePaste` | Provides paste functionality |
202+
| `usePragmaticDragAndDrop` | Integrates Atlassian's drag-and-drop library |
203+
| `useProgressFavicon` | Updates favicon with progress indicator |
204+
| `useRefreshableSelection` | Manages refreshable selections |
205+
| `useRegistrySearch` | Searches the ComfyUI registry |
206+
| `useServerLogs` | Manages server log display |
207+
| `useTemplateWorkflows` | Manages template workflow loading, selection, and display |
208+
| `useTreeExpansion` | Handles tree node expansion state |
209+
| `useValueTransform` | Transforms values between formats |
210+
| `useWorkflowAutoSave` | Handles automatic workflow saving |
211+
| `useWorkflowPersistence` | Manages workflow persistence |
212+
| `useWorkflowValidation` | Validates workflow integrity |
113213

114214
## Usage Guidelines
115215

‎src/extensions/core/README.md‎

Lines changed: 79 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,85 @@ ComfyUI's extension system follows these key principles:
2525

2626
## Core Extensions List
2727

28-
The core extensions include:
29-
30-
| Extension | Description |
31-
|-----------|-------------|
32-
| clipspace.ts | Implements the Clipspace feature for temporary image storage |
33-
| dynamicPrompts.ts | Provides dynamic prompt generation capabilities |
34-
| groupNode.ts | Implements the group node functionality to organize workflows |
35-
| load3d.ts | Supports 3D model loading and visualization |
36-
| maskeditor.ts | Implements the mask editor for image masking operations |
37-
| noteNode.ts | Adds note nodes for documentation within workflows |
38-
| rerouteNode.ts | Implements reroute nodes for cleaner workflow connections |
39-
| uploadImage.ts | Handles image upload functionality |
40-
| webcamCapture.ts | Provides webcam capture capabilities |
41-
| widgetInputs.ts | Implements various widget input types |
28+
The following table lists ALL core extensions in the system as of 2025-01-30:
29+
30+
### Main Extensions
31+
32+
| Extension | Description | Category |
33+
|-----------|-------------|----------|
34+
| clipspace.ts | Implements the Clipspace feature for temporary image storage | Image |
35+
| contextMenuFilter.ts | Provides context menu filtering capabilities | UI |
36+
| dynamicPrompts.ts | Provides dynamic prompt generation capabilities | Prompts |
37+
| editAttention.ts | Implements attention editing functionality | Text |
38+
| electronAdapter.ts | Adapts functionality for Electron environment | Platform |
39+
| groupNode.ts | Implements the group node functionality to organize workflows | Graph |
40+
| groupNodeManage.ts | Provides group node management operations | Graph |
41+
| groupOptions.ts | Handles group node configuration options | Graph |
42+
| index.ts | Main extension registration and coordination | Core |
43+
| load3d.ts | Supports 3D model loading and visualization | 3D |
44+
| maskEditorOld.ts | Legacy mask editor implementation | Image |
45+
| maskeditor.ts | Implements the mask editor for image masking operations | Image |
46+
| nodeTemplates.ts | Provides node template functionality | Templates |
47+
| noteNode.ts | Adds note nodes for documentation within workflows | Graph |
48+
| previewAny.ts | Universal preview functionality for various data types | Preview |
49+
| rerouteNode.ts | Implements reroute nodes for cleaner workflow connections | Graph |
50+
| saveImageExtraOutput.ts | Handles additional image output saving | Image |
51+
| saveMesh.ts | Implements 3D mesh saving functionality | 3D |
52+
| simpleTouchSupport.ts | Provides basic touch interaction support | Input |
53+
| slotDefaults.ts | Manages default values for node slots | Nodes |
54+
| uploadAudio.ts | Handles audio file upload functionality | Audio |
55+
| uploadImage.ts | Handles image upload functionality | Image |
56+
| webcamCapture.ts | Provides webcam capture capabilities | Media |
57+
| widgetInputs.ts | Implements various widget input types | Widgets |
58+
59+
### load3d Subdirectory
60+
Located in `extensions/core/load3d/`:
61+
62+
| File | Description | Type |
63+
|------|-------------|------|
64+
| AnimationManager.ts | Manages 3D animations | Manager |
65+
| CameraManager.ts | Handles camera controls and positioning | Manager |
66+
| ControlsManager.ts | Manages 3D scene controls | Manager |
67+
| EventManager.ts | Handles 3D scene events | Manager |
68+
| interfaces.ts | TypeScript interfaces for 3D functionality | Types |
69+
| LightingManager.ts | Manages scene lighting | Manager |
70+
| Load3DConfiguration.ts | Configuration for 3D loading | Config |
71+
| Load3d.ts | Core 3D loading functionality | Core |
72+
| Load3dAnimation.ts | Animation-specific 3D operations | Animation |
73+
| Load3dUtils.ts | Utility functions for 3D operations | Utils |
74+
| LoaderManager.ts | Manages various 3D file loaders | Manager |
75+
| ModelExporter.ts | Exports 3D models to different formats | Export |
76+
| ModelManager.ts | Manages 3D model lifecycle | Manager |
77+
| NodeStorage.ts | Handles storage for 3D nodes | Storage |
78+
| PreviewManager.ts | Manages 3D model previews | Manager |
79+
| RecordingManager.ts | Handles 3D scene recording | Manager |
80+
| SceneManager.ts | Core 3D scene management | Manager |
81+
| ViewHelperManager.ts | Manages 3D view helpers and gizmos | Manager |
82+
83+
### Conditional Lines Subdirectory
84+
Located in `extensions/core/load3d/conditional-lines/`:
85+
86+
| File | Description |
87+
|------|-------------|
88+
| ColoredShadowMaterial.js | Material for colored shadow rendering |
89+
| ConditionalEdgesGeometry.js | Geometry for conditional edge rendering |
90+
| ConditionalEdgesShader.js | Shader for conditional edges |
91+
| OutsideEdgesGeometry.js | Geometry for outside edge detection |
92+
93+
### Lines2 Subdirectory
94+
Located in `extensions/core/load3d/conditional-lines/Lines2/`:
95+
96+
| File | Description |
97+
|------|-------------|
98+
| ConditionalLineMaterial.js | Material for conditional line rendering |
99+
| ConditionalLineSegmentsGeometry.js | Geometry for conditional line segments |
100+
101+
### ThreeJS Override Subdirectory
102+
Located in `extensions/core/load3d/threejsOverride/`:
103+
104+
| File | Description |
105+
|------|-------------|
106+
| OverrideMTLLoader.js | Custom MTL loader with enhanced functionality |
42107

43108
## Extension Development
44109

‎src/services/README.md‎

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -57,22 +57,42 @@ While services can interact with both UI components and stores (centralized stat
5757

5858
## Core Services
5959

60-
The core services include:
60+
The following table lists ALL services in the system as of 2025-01-30:
61+
62+
### Main Services
63+
64+
| Service | Description | Category |
65+
|---------|-------------|----------|
66+
| autoQueueService.ts | Manages automatic queue execution | Execution |
67+
| colorPaletteService.ts | Handles color palette management and customization | UI |
68+
| comfyManagerService.ts | Manages ComfyUI application packages and updates | Manager |
69+
| comfyRegistryService.ts | Handles registration and discovery of ComfyUI extensions | Registry |
70+
| dialogService.ts | Provides dialog and modal management | UI |
71+
| extensionService.ts | Manages extension registration and lifecycle | Extensions |
72+
| keybindingService.ts | Handles keyboard shortcuts and keybindings | Input |
73+
| litegraphService.ts | Provides utilities for working with the LiteGraph library | Graph |
74+
| load3dService.ts | Manages 3D model loading and visualization | 3D |
75+
| nodeHelpService.ts | Provides node documentation and help | Nodes |
76+
| nodeOrganizationService.ts | Handles node organization and categorization | Nodes |
77+
| nodeSearchService.ts | Implements node search functionality | Search |
78+
| releaseService.ts | Manages application release information and updates | System |
79+
| subgraphService.ts | Handles subgraph operations and navigation | Graph |
80+
| workflowService.ts | Handles workflow operations (save, load, execute) | Workflows |
81+
82+
### Gateway Services
83+
Located in `services/gateway/`:
6184

6285
| Service | Description |
6386
|---------|-------------|
64-
| algoliaSearchService.ts | Implements search functionality using Algolia |
65-
| autoQueueService.ts | Manages automatic queue execution |
66-
| colorPaletteService.ts | Handles color palette management and customization |
67-
| comfyManagerService.ts | Manages ComfyUI application packages and updates |
68-
| comfyRegistryService.ts | Handles registration and discovery of ComfyUI extensions |
69-
| dialogService.ts | Provides dialog and modal management |
70-
| extensionService.ts | Manages extension registration and lifecycle |
71-
| keybindingService.ts | Handles keyboard shortcuts and keybindings |
72-
| litegraphService.ts | Provides utilities for working with the LiteGraph library |
73-
| load3dService.ts | Manages 3D model loading and visualization |
74-
| nodeSearchService.ts | Implements node search functionality |
75-
| workflowService.ts | Handles workflow operations (save, load, execute) |
87+
| registrySearchGateway.ts | Gateway for registry search operations |
88+
89+
### Provider Services
90+
Located in `services/providers/`:
91+
92+
| Service | Description |
93+
|---------|-------------|
94+
| algoliaSearchProvider.ts | Implements search functionality using Algolia |
95+
| registrySearchProvider.ts | Provides registry search capabilities |
7696

7797
## Service Development Guidelines
7898

0 commit comments

Comments
 (0)