diff --git a/src/composables/README.md b/src/composables/README.md index 38e8e669b..a19473ee6 100644 --- a/src/composables/README.md +++ b/src/composables/README.md @@ -110,21 +110,21 @@ Composables for billing and subscription management: Composables for terminal and bottom panel functionality: -| Composable | Description | -| ------------------------ | ---------------------------------------- | -| `useCommandSubcategories` | Manages command subcategories | -| `useShortcutsTab` | Handles shortcuts tab functionality | -| `useTerminal` | Core terminal functionality | -| `useTerminalTabs` | Handles multiple terminal tab management | +| Composable | Description | +| ------------------------- | ---------------------------------------- | +| `useCommandSubcategories` | Manages command subcategories | +| `useShortcutsTab` | Handles shortcuts tab functionality | +| `useTerminal` | Core terminal functionality | +| `useTerminalTabs` | Handles multiple terminal tab management | ### Canvas Composables for canvas and graph selection: -| Composable | Description | -| ----------------------------- | -------------------------------------------- | -| `useSelectedLiteGraphItems` | Manages selected items on LiteGraph canvas | -| `useSelectionToolboxPosition` | Handles selection toolbox positioning | +| Composable | Description | +| ----------------------------- | ------------------------------------------ | +| `useSelectedLiteGraphItems` | Manages selected items on LiteGraph canvas | +| `useSelectionToolboxPosition` | Handles selection toolbox positioning | ### Element @@ -149,44 +149,44 @@ Utility composables for common patterns: Composables for graph and node operations: -| Composable | Description | -| -------------------------- | ------------------------------------------- | -| `useCanvasRefresh` | Handles canvas refresh operations | -| `useFrameNodes` | Manages node framing functionality | -| `useGraphHierarchy` | Handles graph hierarchy operations | -| `useGraphNodeManager` | Manages graph node lifecycle | -| `useGroupMenuOptions` | Provides group-specific menu options | -| `useImageMenuOptions` | Provides image-specific menu options | -| `useMoreOptionsMenu` | Handles more options menu | -| `useNodeArrangement` | Manages node arrangement on canvas | -| `useNodeCustomization` | Handles node customization | -| `useNodeMenuOptions` | Provides node-specific menu options | -| `useSelectedNodeActions` | Manages actions for selected nodes | -| `useSelectionMenuOptions` | Provides selection-specific menu options | -| `useSelectionOperations` | Handles selection operations | -| `useSelectionState` | Manages selection state | -| `useSubgraphOperations` | Handles subgraph operations | -| `useVueNodeLifecycle` | Manages Vue node lifecycle integration | +| Composable | Description | +| ------------------------- | ---------------------------------------- | +| `useCanvasRefresh` | Handles canvas refresh operations | +| `useFrameNodes` | Manages node framing functionality | +| `useGraphHierarchy` | Handles graph hierarchy operations | +| `useGraphNodeManager` | Manages graph node lifecycle | +| `useGroupMenuOptions` | Provides group-specific menu options | +| `useImageMenuOptions` | Provides image-specific menu options | +| `useMoreOptionsMenu` | Handles more options menu | +| `useNodeArrangement` | Manages node arrangement on canvas | +| `useNodeCustomization` | Handles node customization | +| `useNodeMenuOptions` | Provides node-specific menu options | +| `useSelectedNodeActions` | Manages actions for selected nodes | +| `useSelectionMenuOptions` | Provides selection-specific menu options | +| `useSelectionOperations` | Handles selection operations | +| `useSelectionState` | Manages selection state | +| `useSubgraphOperations` | Handles subgraph operations | +| `useVueNodeLifecycle` | Manages Vue node lifecycle integration | ### Mask Editor Composables for mask editing functionality: -| Composable | Description | -| ----------------------- | -------------------------------------- | -| `useBrushDrawing` | Handles brush drawing operations | -| `useCanvasHistory` | Manages canvas history and undo/redo | -| `useCanvasManager` | Core canvas management | -| `useCanvasTools` | Manages canvas tools | -| `useCanvasTransform` | Handles canvas transformations | -| `useCoordinateTransform`| Transforms coordinates | -| `useImageLoader` | Loads images into mask editor | -| `useKeyboard` | Handles keyboard interactions | -| `useMaskEditor` | Core mask editor functionality | -| `useMaskEditorLoader` | Loads mask editor state | -| `useMaskEditorSaver` | Saves mask editor state | -| `usePanAndZoom` | Handles pan and zoom operations | -| `useToolManager` | Manages mask editor tools | +| Composable | Description | +| ------------------------ | ------------------------------------ | +| `useBrushDrawing` | Handles brush drawing operations | +| `useCanvasHistory` | Manages canvas history and undo/redo | +| `useCanvasManager` | Core canvas management | +| `useCanvasTools` | Manages canvas tools | +| `useCanvasTransform` | Handles canvas transformations | +| `useCoordinateTransform` | Transforms coordinates | +| `useImageLoader` | Loads images into mask editor | +| `useKeyboard` | Handles keyboard interactions | +| `useMaskEditor` | Core mask editor functionality | +| `useMaskEditorLoader` | Loads mask editor state | +| `useMaskEditorSaver` | Saves mask editor state | +| `usePanAndZoom` | Handles pan and zoom operations | +| `useToolManager` | Manages mask editor tools | ### Node @@ -211,14 +211,14 @@ Composables for node-specific functionality: Composables for queue and execution management: -| Composable | Description | -| ------------------------------- | ------------------------------------------ | -| `useJobActions` | Manages job actions | -| `useJobList` | Handles job list functionality | -| `useJobMenu` | Provides job menu operations | -| `useQueueNotificationBanners` | Manages queue notification banners | -| `useQueueProgress` | Tracks queue progress | -| `useResultGallery` | Manages result gallery display | +| Composable | Description | +| ----------------------------- | ---------------------------------- | +| `useJobActions` | Manages job actions | +| `useJobList` | Handles job list functionality | +| `useJobMenu` | Provides job menu operations | +| `useQueueNotificationBanners` | Manages queue notification banners | +| `useQueueProgress` | Tracks queue progress | +| `useResultGallery` | Manages result gallery display | ### Sidebar Tabs @@ -238,51 +238,50 @@ Composables for tree structure operations: | ------------------------- | --------------------------------------- | | `useTreeFolderOperations` | Handles folder operations in tree views | - ### Root-level Composables General-purpose composables: -| Composable | Description | -| ---------------------------------- | --------------------------------------------------------- | -| `useBrowserTabTitle` | Manages browser tab title updates | -| `useCachedRequest` | Provides request caching functionality | -| `useCanvasDrop` | Handles drop operations on canvas | -| `useCivitaiModel` | Integrates with Civitai model API | -| `useContextMenuTranslation` | Handles context menu translations | -| `useCopy` | Provides copy functionality | -| `useCopyToClipboard` | Manages clipboard operations | -| `useCoreCommands` | Provides core command functionality | -| `useDownload` | Handles file download operations | -| `useErrorHandling` | Centralized error handling | -| `useExternalLink` | Handles external link operations | -| `useFeatureFlags` | Manages feature flag checks | -| `useGlobalLitegraph` | Access to global LiteGraph instance | -| `useHelpCenter` | Manages help center functionality | -| `useImageCrop` | Handles image cropping operations | -| `useIntersectionObserver` | Provides intersection observer functionality | -| `useLazyPagination` | Manages lazy-loaded paginated lists | -| `useLoad3d` | Handles 3D model loading | -| `useLoad3dDrag` | Manages 3D model drag operations | -| `useLoad3dViewer` | Provides 3D model viewer functionality | -| `useModelSelectorDialog` | Manages model selector dialog | -| `useNodeHelpContent` | Provides node help content | -| `usePaste` | Provides paste functionality | -| `usePopoverSizing` | Manages popover sizing | -| `usePragmaticDragAndDrop` | Integrates Atlassian's drag-and-drop library | -| `useProgressBarBackground` | Manages progress bar background styling | -| `useProgressFavicon` | Updates favicon with progress indicator | -| `useRefreshableSelection` | Manages refreshable selections | -| `useServerLogs` | Manages server log display | -| `useTemplateFiltering` | Provides template filtering functionality | -| `useTooltipConfig` | Manages tooltip configuration | -| `useTransformCompatOverlayProps` | Transforms compat overlay props | -| `useTreeExpansion` | Handles tree node expansion state | -| `useValueTransform` | Transforms values between formats | -| `useVueFeatureFlags` | Vue-specific feature flag integration | -| `useWorkflowActionsMenu` | Manages workflow actions menu | -| `useWorkflowTemplateSelectorDialog`| Manages workflow template selector dialog | -| `useZoomControls` | Handles zoom control operations | +| Composable | Description | +| ----------------------------------- | -------------------------------------------- | +| `useBrowserTabTitle` | Manages browser tab title updates | +| `useCachedRequest` | Provides request caching functionality | +| `useCanvasDrop` | Handles drop operations on canvas | +| `useCivitaiModel` | Integrates with Civitai model API | +| `useContextMenuTranslation` | Handles context menu translations | +| `useCopy` | Provides copy functionality | +| `useCopyToClipboard` | Manages clipboard operations | +| `useCoreCommands` | Provides core command functionality | +| `useDownload` | Handles file download operations | +| `useErrorHandling` | Centralized error handling | +| `useExternalLink` | Handles external link operations | +| `useFeatureFlags` | Manages feature flag checks | +| `useGlobalLitegraph` | Access to global LiteGraph instance | +| `useHelpCenter` | Manages help center functionality | +| `useImageCrop` | Handles image cropping operations | +| `useIntersectionObserver` | Provides intersection observer functionality | +| `useLazyPagination` | Manages lazy-loaded paginated lists | +| `useLoad3d` | Handles 3D model loading | +| `useLoad3dDrag` | Manages 3D model drag operations | +| `useLoad3dViewer` | Provides 3D model viewer functionality | +| `useModelSelectorDialog` | Manages model selector dialog | +| `useNodeHelpContent` | Provides node help content | +| `usePaste` | Provides paste functionality | +| `usePopoverSizing` | Manages popover sizing | +| `usePragmaticDragAndDrop` | Integrates Atlassian's drag-and-drop library | +| `useProgressBarBackground` | Manages progress bar background styling | +| `useProgressFavicon` | Updates favicon with progress indicator | +| `useRefreshableSelection` | Manages refreshable selections | +| `useServerLogs` | Manages server log display | +| `useTemplateFiltering` | Provides template filtering functionality | +| `useTooltipConfig` | Manages tooltip configuration | +| `useTransformCompatOverlayProps` | Transforms compat overlay props | +| `useTreeExpansion` | Handles tree node expansion state | +| `useValueTransform` | Transforms values between formats | +| `useVueFeatureFlags` | Vue-specific feature flag integration | +| `useWorkflowActionsMenu` | Manages workflow actions menu | +| `useWorkflowTemplateSelectorDialog` | Manages workflow template selector dialog | +| `useZoomControls` | Handles zoom control operations | ## Usage Guidelines