Files
ComfyUI_frontend/src/composables/maskeditor/useKeyboard.ts
Terry Jia 1a6913c466 fully refactor mask editor into vue-based (#6629)
## Summary

This PR refactors the mask editor from a vanilla JavaScript
implementation to Vue 3 + Composition API, aligning it with the ComfyUI
frontend's modern architecture. This is a structural refactor without UI
changes - all visual appearances and user interactions remain identical.

Net change: +1,700 lines (mostly tests)

## Changes

- Converted from class-based managers to Vue 3 Composition API
- Migrated state management to Pinia stores (maskEditorStore,
maskEditorDataStore)
- Split monolithic managers into focused composables:
    - useBrushDrawing - Brush rendering and drawing logic
    - useCanvasManager - Canvas lifecycle and operations
    - useCanvasTools - Tool-specific canvas operations
    - usePanAndZoom - Pan and zoom functionality
    - useToolManager - Tool selection and coordination
    - useKeyboard - Keyboard shortcuts
    - useMaskEditorLoader/Saver - Data loading and saving
    - useCoordinateTransform - Coordinate system transformations
- Replaced imperative DOM manipulation with Vue components
- Added comprehensive test coverage

## What This PR Does NOT Change

  Preserved Original Styling:
  - Original CSS retained in packages/design-system/src/css/style.css
- Some generic controls (DropdownControl, SliderControl, ToggleControl)
preserved as-is
- Future migration to Tailwind and PrimeVue components is planned but
out of scope for this PR

  Preserved Core Functionality:
  - Drawing algorithms and brush rendering logic remain unchanged
  - Pan/zoom calculations preserved
  - Canvas operations (composite modes, image processing) unchanged
  - Tool behaviors (brush, color select, paint bucket) identical
  - No changes to mask generation or export logic

DO NOT Review:
  -  CSS styling choices (preserved from original)
  - Drawing algorithm implementations (unchanged)
  -  Canvas rendering logic (ported as-is)
  - UI/UX changes (none exist)
  - Component library choices (future work)

┆Issue is synchronized with this [Notion
page](https://www.notion.so/PR-6629-fully-refactor-mask-editor-into-vue-based-2a46d73d36508114ab8bd2984b4b54e4)
by [Unito](https://www.unito.io)
2025-11-13 20:57:03 -08:00

63 lines
1.6 KiB
TypeScript

import { ref } from 'vue'
import { useMaskEditorStore } from '@/stores/maskEditorStore'
export function useKeyboard() {
const store = useMaskEditorStore()
const keysDown = ref<string[]>([])
const isKeyDown = (key: string): boolean => {
return keysDown.value.includes(key)
}
const clearKeys = (): void => {
keysDown.value = []
}
const handleKeyDown = (event: KeyboardEvent): void => {
if (!keysDown.value.includes(event.key)) {
keysDown.value.push(event.key)
}
if (event.key === ' ') {
event.preventDefault()
const activeElement = document.activeElement as HTMLElement
if (activeElement && activeElement.blur) {
activeElement.blur()
}
}
if ((event.ctrlKey || event.metaKey) && !event.altKey) {
const key = event.key.toUpperCase()
if ((key === 'Y' && !event.shiftKey) || (key === 'Z' && event.shiftKey)) {
store.canvasHistory.redo()
} else if (key === 'Z' && !event.shiftKey) {
store.canvasHistory.undo()
}
}
}
const handleKeyUp = (event: KeyboardEvent): void => {
keysDown.value = keysDown.value.filter((key) => key !== event.key)
}
const addListeners = (): void => {
document.addEventListener('keydown', handleKeyDown)
document.addEventListener('keyup', handleKeyUp)
window.addEventListener('blur', clearKeys)
}
const removeListeners = (): void => {
document.removeEventListener('keydown', handleKeyDown)
document.removeEventListener('keyup', handleKeyUp)
window.removeEventListener('blur', clearKeys)
}
return {
isKeyDown,
addListeners,
removeListeners
}
}