Comfy-Org/ComfyUI_frontend
1
0
Fork 0
mirror of https://github.com/Comfy-Org/ComfyUI_frontend.git synced 2026-03-04 04:30:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

[TS] Fix ContextMenu types (#649)

Browse Source 
- No runtime changes
- Drastically improves ContextMenu type accuracy / safety
- Allows TS strict conversion
This commit is contained in:
filtered
2025-03-01 01:52:07 +11:00
committed by GitHub
parent b877312336
commit c4faaf4210
6 changed files with 92 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
src/ContextMenu.ts
View File

@@ -1,28 +1,21 @@
import type { IContextMenuOptions, IContextMenuValue } from "./interfaces"
import type { ContextMenuDivElement, IContextMenuOptions, IContextMenuValue } from "./interfaces"
import { LiteGraph } from "./litegraph"
interface ContextMenuDivElement extends HTMLDivElement {
value?: IContextMenuValue | string
onclick_callback?: never
closing_timer?: number
}
// TODO: Replace this pattern with something more modern.
// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
export interface ContextMenu {
constructor: new (...args: ConstructorParameters<typeof ContextMenu>) => ContextMenu
export interface ContextMenu<TValue = unknown> {
constructor: new (...args: ConstructorParameters<typeof ContextMenu<TValue>>) => ContextMenu<TValue>
}
/**
* ContextMenu from LiteGUI
*/
// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
export class ContextMenu {
options: IContextMenuOptions
parentMenu?: ContextMenu
root: ContextMenuDivElement
current_submenu?: ContextMenu
export class ContextMenu<TValue = unknown> {
options: IContextMenuOptions<TValue>
parentMenu?: ContextMenu<TValue>
root: ContextMenuDivElement<TValue>
current_submenu?: ContextMenu<TValue>
lock?: boolean
/**
@@ -35,7 +28,7 @@ export class ContextMenu {
* - ignore_item_callbacks: ignores the callback inside the item, it just calls the options.callback
* - event: you can pass a MouseEvent, this way the ContextMenu appears in that position
*/
constructor(values: (IContextMenuValue | string | null)[], options: IContextMenuOptions) {
constructor(values: (string | IContextMenuValue<TValue> | null)[], options: IContextMenuOptions<TValue>) {
options ||= {}
this.options = options
@@ -68,7 +61,7 @@ export class ContextMenu {
options.event = undefined
}
const root: ContextMenuDivElement = document.createElement("div")
const root: ContextMenuDivElement<TValue> = document.createElement("div")
let classes = "litegraph litecontextmenu litemenubar-panel"
if (options.className) classes += " " + options.className
root.className = classes
@@ -189,12 +182,12 @@ export class ContextMenu {
addItem(
name: string | null,
value: IContextMenuValue | string | null,
options: IContextMenuOptions,
value: string | IContextMenuValue<TValue> | null,
options: IContextMenuOptions<TValue>,
): HTMLElement {
options ||= {}
const element: ContextMenuDivElement = document.createElement("div")
const element: ContextMenuDivElement<TValue> = document.createElement("div")
element.className = "litemenu-entry submenu"
let disabled = false
@@ -246,7 +239,7 @@ export class ContextMenu {
element.setAttribute("aria-expanded", "true")
}
function inner_over(this: ContextMenuDivElement, e: MouseEvent) {
function inner_over(this: ContextMenuDivElement<TValue>, e: MouseEvent) {
const value = this.value
if (!value || !(value as IContextMenuValue).has_submenu) return
@@ -257,7 +250,7 @@ export class ContextMenu {
// menu option clicked
const that = this
function inner_onclick(this: ContextMenuDivElement, e: MouseEvent) {
function inner_onclick(this: ContextMenuDivElement<TValue>, e: MouseEvent) {
const value = this.value
let close_parent = true
@@ -358,7 +351,7 @@ export class ContextMenu {
}
// returns the top most menu
getTopMenu(): ContextMenu {
getTopMenu(): ContextMenu<TValue> {
return this.options.parentMenu
? this.options.parentMenu.getTopMenu()
: this