Skip to content

docs(custom-nodes): publish frontend extension migration guides and canvas pointer API - #2223

Merged
DrJKL merged 3 commits into
mainfrom
drjkl/front-3790-frontend-extension-migration-notes
Nov 3, 2026
Merged

DrJKL merged 3 commits into
mainfrom
drjkl/front-3790-frontend-extension-migration-notes

Conversation

@DrJKL

@DrJKL DrJKL commented Nov 2, 2026

Copy link
Copy Markdown
Contributor

Publishes the ComfyUI frontend's extension migration notes, which until now lived only in the frontend repo, under Custom Nodes > Migration Guides:

  • Node ID, link registration, widget system, connection callbacks, serialization callbacks, node geometry, PrimeVue removal (with the tooltip notes merged in).
  • A Canvas Pointer API page under JavaScript (UI), covering widget onPointerDown and cursor control.

Changes from the frontend originals: examples use APIs extensions can reach at runtime. The connection-callbacks guide no longer imports from the internal @/lib/litegraph alias, the widget guide uses addCustomWidget instead of subclassing the internal BaseWidget, and the node ID guide compares against the string sentinels. English only; translations are left to the i18n pipeline.

mint broken-links passes.

Removes the originals from the frontend: Comfy-Org/ComfyUI_frontend#22731 (Linear FRONT-3790)

@mintlify

mintlify Bot commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
comfy 🟢 Ready View Preview Nov 2, 2026, 9:09 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@github-actions

github-actions Bot commented Nov 2, 2026

Copy link
Copy Markdown
Contributor

🌐 i18n translation sync check

English docs changed in this PR. 64 files in 4 languages may not be synced yet. The automated translation workflow handles these updates. Expand a language to see the files.

Japanese (ja): 16 files
  • ja/custom-nodes/js/canvas-pointer-api.mdx
  • ja/custom-nodes/js/connection-callbacks-migration.mdx
  • ja/custom-nodes/js/link-registration-migration.mdx
  • ja/custom-nodes/js/node-geometry-migration.mdx
  • ja/custom-nodes/js/node-id-migration.mdx
  • ja/custom-nodes/js/primevue-removal-migration.mdx
  • ja/custom-nodes/js/serialization-callbacks-migration.mdx
  • ja/custom-nodes/js/widgets-migration.mdx
  • ja/custom-nodes/js/canvas-pointer-api.mdx
  • ja/custom-nodes/js/connection-callbacks-migration.mdx
  • ja/custom-nodes/js/link-registration-migration.mdx
  • ja/custom-nodes/js/node-geometry-migration.mdx
  • ja/custom-nodes/js/node-id-migration.mdx
  • ja/custom-nodes/js/primevue-removal-migration.mdx
  • ja/custom-nodes/js/serialization-callbacks-migration.mdx
  • ja/custom-nodes/js/widgets-migration.mdx
Simplified Chinese (zh): 16 files
  • zh/custom-nodes/js/canvas-pointer-api.mdx
  • zh/custom-nodes/js/connection-callbacks-migration.mdx
  • zh/custom-nodes/js/link-registration-migration.mdx
  • zh/custom-nodes/js/node-geometry-migration.mdx
  • zh/custom-nodes/js/node-id-migration.mdx
  • zh/custom-nodes/js/primevue-removal-migration.mdx
  • zh/custom-nodes/js/serialization-callbacks-migration.mdx
  • zh/custom-nodes/js/widgets-migration.mdx
  • zh/custom-nodes/js/canvas-pointer-api.mdx
  • zh/custom-nodes/js/connection-callbacks-migration.mdx
  • zh/custom-nodes/js/link-registration-migration.mdx
  • zh/custom-nodes/js/node-geometry-migration.mdx
  • zh/custom-nodes/js/node-id-migration.mdx
  • zh/custom-nodes/js/primevue-removal-migration.mdx
  • zh/custom-nodes/js/serialization-callbacks-migration.mdx
  • zh/custom-nodes/js/widgets-migration.mdx
Korean (ko): 16 files
  • ko/custom-nodes/js/canvas-pointer-api.mdx
  • ko/custom-nodes/js/connection-callbacks-migration.mdx
  • ko/custom-nodes/js/link-registration-migration.mdx
  • ko/custom-nodes/js/node-geometry-migration.mdx
  • ko/custom-nodes/js/node-id-migration.mdx
  • ko/custom-nodes/js/primevue-removal-migration.mdx
  • ko/custom-nodes/js/serialization-callbacks-migration.mdx
  • ko/custom-nodes/js/widgets-migration.mdx
  • ko/custom-nodes/js/canvas-pointer-api.mdx
  • ko/custom-nodes/js/connection-callbacks-migration.mdx
  • ko/custom-nodes/js/link-registration-migration.mdx
  • ko/custom-nodes/js/node-geometry-migration.mdx
  • ko/custom-nodes/js/node-id-migration.mdx
  • ko/custom-nodes/js/primevue-removal-migration.mdx
  • ko/custom-nodes/js/serialization-callbacks-migration.mdx
  • ko/custom-nodes/js/widgets-migration.mdx
Spanish (es): 16 files
  • es/custom-nodes/js/canvas-pointer-api.mdx
  • es/custom-nodes/js/connection-callbacks-migration.mdx
  • es/custom-nodes/js/link-registration-migration.mdx
  • es/custom-nodes/js/node-geometry-migration.mdx
  • es/custom-nodes/js/node-id-migration.mdx
  • es/custom-nodes/js/primevue-removal-migration.mdx
  • es/custom-nodes/js/serialization-callbacks-migration.mdx
  • es/custom-nodes/js/widgets-migration.mdx
  • es/custom-nodes/js/canvas-pointer-api.mdx
  • es/custom-nodes/js/connection-callbacks-migration.mdx
  • es/custom-nodes/js/link-registration-migration.mdx
  • es/custom-nodes/js/node-geometry-migration.mdx
  • es/custom-nodes/js/node-id-migration.mdx
  • es/custom-nodes/js/primevue-removal-migration.mdx
  • es/custom-nodes/js/serialization-callbacks-migration.mdx
  • es/custom-nodes/js/widgets-migration.mdx

Local sync: npm run translate (see README: Automated translation)

@coderabbitai

coderabbitai Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Warning

Review limit reached

  • Run on-demand review

This review includes 5 billable files and costs up to $1.25.

  • Ask an admin to make reviews automatic

Open in CodeRabbit

Reviews can continue after your included limit without a manual trigger. An admin must approve usage-based billing.

Or wait 30 minutes for your next included review.

Check out review usage here.

View limit details

Limit details: You’ve used all 2 included reviews currently available. Your 80 included PR review attempts over the past 7 days set your current allowance at 2 reviews per hour.

Learn how review limits work.

Review configuration:

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Team
  • Run ID: cc0f98c7-e17a-443b-98f6-1dafb4263b4f
Commits

Reviewing files that changed from the base of the PR and between d241c6a and 87e8cc6.

Files selected for processing: 5
  • custom-nodes/js/canvas-pointer-api.mdx
  • custom-nodes/js/connection-callbacks-migration.mdx
  • custom-nodes/js/link-registration-migration.mdx
  • custom-nodes/js/serialization-callbacks-migration.mdx
  • custom-nodes/js/widgets-migration.mdx
Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Team
  • Run ID: 5091e1e5-c835-41f4-843f-60ce435898e4
Commits

Reviewing files that changed from the base of the PR and between 9cb07df and d241c6a.

Files selected for processing: 7
  • custom-nodes/js/canvas-pointer-api.mdx
  • custom-nodes/js/connection-callbacks-migration.mdx
  • custom-nodes/js/link-registration-migration.mdx
  • custom-nodes/js/node-geometry-migration.mdx
  • custom-nodes/js/node-id-migration.mdx
  • custom-nodes/js/serialization-callbacks-migration.mdx
  • custom-nodes/js/widgets-migration.mdx

Included review availability: This review used your included allowance. 0 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 2 reviews per hour.

Walkthrough

The pull request adds a canvas pointer API page and seven JavaScript migration guides for custom-node extensions. It also adds the pages to the English documentation navigation. The changes add documentation and do not modify implementation code.

Changes: Custom-Node JavaScript Documentation

Layer / File(s) Summary
Canvas pointer handling
custom-nodes/js/canvas-pointer-api.mdx, docs.json
Documents click, drag, double-click, and selection handling; widget pointer callbacks; hover state; and custom cursor control. Adds the page to navigation.
Link registration and connection callbacks
custom-nodes/js/link-registration-migration.mdx, custom-nodes/js/connection-callbacks-migration.mdx, docs.json
Documents link registration results and views, callback ordering, workflow and API prompt loading, and node lifecycle events. Adds the migration pages to navigation.
Widget migration
custom-nodes/js/widgets-migration.mdx
Documents widget registration and store-backed values, gallery inputs, removal, and Agent updates through widget APIs.
Serialization callbacks
custom-nodes/js/serialization-callbacks-migration.mdx
Documents Pinia requirements, callback data, persistence surfaces, serialization behavior, and node property enumeration.
Node identity and geometry
custom-nodes/js/node-id-migration.mdx, custom-nodes/js/node-geometry-migration.mdx
Documents string node IDs, geometry APIs, rendered bounds, z-order, and updates to detached objects.
PrimeVue removal
custom-nodes/js/primevue-removal-migration.mdx, docs.json
Documents PrimeVue removal, theme variable mappings, tooltip changes, and icon usage. Adds the migration page to navigation.

Possibly related PRs

  • Comfy-Org/docs#1575: Maps legacy frontend extension surfaces to the published V2 JavaScript SDK, a connected migration path.

Suggested reviewers: comfyui-wiki

Merge Risk: Low · previous review d241c

This PR only adds documentation. Some examples and statements, mainly on serialization hooks and connection rejection, could lead extension authors to lose data or leave links in a bad state if copied as written. The PrimeIcons guidance also conflicts with two existing pages. These are fixable text edits and should be corrected before or shortly after merge.

Pre-merge checks: Passed 2
Check name Status Explanation
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Finishing Touches
Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
Simplify code
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

@coderabbitai coderabbitai Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Fix comments: Fix CodeRabbit comments on this PR

Comment thread custom-nodes/js/canvas-pointer-api.mdx Resolved
Comment thread custom-nodes/js/canvas-pointer-api.mdx Resolved
Comment thread custom-nodes/js/canvas-pointer-api.mdx Resolved
Comment thread custom-nodes/js/canvas-pointer-api.mdx Resolved
Comment thread custom-nodes/js/canvas-pointer-api.mdx Resolved
Comment thread custom-nodes/js/widgets-migration.mdx Resolved
Comment thread custom-nodes/js/widgets-migration.mdx Resolved
Comment thread custom-nodes/js/widgets-migration.mdx Resolved
Comment thread custom-nodes/js/widgets-migration.mdx Resolved

@coderabbitai coderabbitai Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Fix comments: Fix CodeRabbit comments on this PR

Comment thread custom-nodes/js/canvas-pointer-api.mdx Resolved
Comment thread custom-nodes/js/canvas-pointer-api.mdx Resolved
Comment thread custom-nodes/js/widgets-migration.mdx Resolved
Comment thread custom-nodes/js/widgets-migration.mdx Resolved

This branch was successfully deployed

1 active deployment
staging — 87e8cc6d Deployed Nov 2, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants