Migrate domWidget from js to ts (#3)

* Rename js to ts * Migrate domWidget.js * Fix global declare
Comfy-Org · Jun 14, 2024 · 74abc34 · 74abc34
1 parent 3fbb75c
commit 74abc34
Show file tree

Hide file tree

Showing 5 changed files with 232 additions and 202 deletions.
diff --git a/src/scripts/app.js b/src/scripts/app.js
@@ -4,7 +4,7 @@ import { ComfyUI, $el } from "./ui.js";
 import { api } from "./api.js";
 import { defaultGraph } from "./defaultGraph.js";
 import { getPngMetadata, getWebpMetadata, importA1111, getLatentMetadata } from "./pnginfo.js";
-import { addDomClippingSetting } from "./domWidget.js";
+import { addDomClippingSetting } from "./domWidget";
 import { createImageHost, calculateImageGrid } from "./ui/imagePreview.js"
 
 export const ANIM_PREVIEW_WIDGET = "$$comfy_animation_preview"

diff --git a/src/scripts/domWidget.js → src/scripts/domWidget.ts b/src/scripts/domWidget.js → src/scripts/domWidget.ts
@@ -1,8 +1,32 @@
 import { app, ANIM_PREVIEW_WIDGET } from "./app.js";
+import type { LGraphNode, Vector4 } from "/types/litegraph";
+
 
 const SIZE = Symbol();
 
-function intersect(a, b) {
+
+interface Rect {
+	height: number;
+	width: number;
+	x: number;
+	y: number;
+}
+
+interface DOMWidget {
+	type: string;
+	name: string;
+	computedHeight?: number;
+	element?: HTMLElement;
+	options: any;
+	value?: any;
+	y?: number;
+	callback?: (value: any) => void;
+	draw?: (ctx: CanvasRenderingContext2D, node: LGraphNode, widgetWidth: number, y: number, widgetHeight: number) => void;
+	onRemove?: () => void;
+}
+
+
+function intersect(a: Rect, b: Rect): Vector4 | null {
 	const x = Math.max(a.x, b.x);
 	const num1 = Math.min(a.x + a.width, b.x + b.width);
 	const y = Math.max(a.y, b.y);
@@ -11,8 +35,8 @@ function intersect(a, b) {
 	else return null;
 }
 
-function getClipPath(node, element) {
-	const selectedNode = Object.values(app.canvas.selected_nodes)[0];
+function getClipPath(node: LGraphNode, element: HTMLElement): string {
+	const selectedNode: LGraphNode = Object.values(app.canvas.selected_nodes)[0] as LGraphNode;
 	if (selectedNode && selectedNode !== node) {
 		const elRect = element.getBoundingClientRect();
 		const MARGIN = 7;
@@ -44,7 +68,7 @@ function getClipPath(node, element) {
 	return "";
 }
 
-function computeSize(size) {
+function computeSize(size: [number, number]): void {
 	if (this.widgets?.[0]?.last_y == null) return;
 
 	let y = this.widgets[0].last_y;
@@ -170,7 +194,7 @@ function computeSize(size) {
 // Override the compute visible nodes function to allow us to hide/show DOM elements when the node goes offscreen
 const elementWidgets = new Set();
 const computeVisibleNodes = LGraphCanvas.prototype.computeVisibleNodes;
-LGraphCanvas.prototype.computeVisibleNodes = function () {
+LGraphCanvas.prototype.computeVisibleNodes = function (): LGraphNode[] {
 	const visibleNodes = computeVisibleNodes.apply(this, arguments);
 	for (const node of app.graph._nodes) {
 		if (elementWidgets.has(node)) {
@@ -192,7 +216,7 @@ LGraphCanvas.prototype.computeVisibleNodes = function () {
 
 let enableDomClipping = true;
 
-export function addDomClippingSetting() {
+export function addDomClippingSetting(): void {
 	app.ui.settings.addSetting({
 		id: "Comfy.DOMClippingEnabled",
 		name: "Enable DOM element clipping (enabling may reduce performance)",
@@ -204,7 +228,12 @@ export function addDomClippingSetting() {
 	});
 }
 
-LGraphNode.prototype.addDOMWidget = function (name, type, element, options) {
+LGraphNode.prototype.addDOMWidget = function (
+	name: string,
+	type: string,
+	element: HTMLElement,
+	options: Record<string, any>
+): DOMWidget {
 	options = { hideOnZoom: true, selectOn: ["focus", "click"], ...options };
 
 	if (!element.parentElement) {
@@ -221,7 +250,7 @@ LGraphNode.prototype.addDOMWidget = function (name, type, element, options) {
 		document.addEventListener("mousedown", mouseDownHandler);
 	}
 
-	const widget = {
+	const widget: DOMWidget = {
 		type,
 		name,
 		get value() {
@@ -231,7 +260,7 @@ LGraphNode.prototype.addDOMWidget = function (name, type, element, options) {
 			options.setValue?.(v);
 			widget.callback?.(widget.value);
 		},
-		draw: function (ctx, node, widgetWidth, y, widgetHeight) {
+		draw: function (ctx: CanvasRenderingContext2D, node: LGraphNode, widgetWidth: number, y: number, widgetHeight: number) {
 			if (widget.computedHeight == null) {
 				computeSize.call(node, node.size);
 			}
@@ -240,7 +269,7 @@ LGraphNode.prototype.addDOMWidget = function (name, type, element, options) {
 				node.flags?.collapsed ||
 				(!!options.hideOnZoom && app.canvas.ds.scale < 0.5) ||
 				widget.computedHeight <= 0 ||
-				widget.type === "converted-widget"||
+				widget.type === "converted-widget" ||
 				widget.type === "hidden";
 			element.hidden = hidden;
 			element.style.display = hidden ? "none" : null;
@@ -297,9 +326,9 @@ LGraphNode.prototype.addDOMWidget = function (name, type, element, options) {
 	elementWidgets.add(this);
 
 	const collapse = this.collapse;
-	this.collapse = function() {
+	this.collapse = function () {
 		collapse.apply(this, arguments);
-		if(this.flags?.collapsed) {
+		if (this.flags?.collapsed) {
 			element.hidden = true;
 			element.style.display = "none";
 		}

diff --git a/src/scripts/widgets.js b/src/scripts/widgets.js
@@ -1,5 +1,5 @@
 import { api } from "./api.js"
-import "./domWidget.js";
+import "./domWidget";
 
 let controlValueRunBefore = false;
 export function updateControlWidgetLabel(widget) {