Skip to content

fix(docs): correct parameters for edge event handlers#2029

Merged
bcakmakoglu merged 1 commit into
bcakmakoglu:masterfrom
yyc20057710-boop:fix-doc-params
May 14, 2026
Merged

fix(docs): correct parameters for edge event handlers#2029
bcakmakoglu merged 1 commit into
bcakmakoglu:masterfrom
yyc20057710-boop:fix-doc-params

Conversation

@yyc20057710-boop
Copy link
Copy Markdown
Contributor

Description

Fix incorrect parameter definitions for edge event handlers in the documentation.

Issue

The documentation currently shows handlers like:

onEdgeClick((event, edge) => {})

However, according to the source code, the handler only receives a single event parameter. The edge is included in the emitted payload instead.

Actual Behavior (from source code)

function onEdgeClick(event: MouseEvent) {
  const data = { event, edge: edge.value }
  emit.click(data)
}

Changes

Updated the documentation to reflect the correct function signature.

Notes

Let me know if any further adjustments are needed.
I can update other related handlers if needed.

@codesandbox
Copy link
Copy Markdown

codesandbox Bot commented Apr 1, 2026

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 1, 2026

Deploy Preview for vue-flow-docs ready!

Name Link
🔨 Latest commit fc56344
🔍 Latest deploy log https://app.netlify.com/projects/vue-flow-docs/deploys/69ccf8358ad2f300080a0336
😎 Deploy Preview https://deploy-preview-2029--vue-flow-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 1, 2026

⚠️ No Changeset found

Latest commit: fc56344

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@yyc20057710-boop
Copy link
Copy Markdown
Contributor Author

Netlify preview looks good.

@bcakmakoglu
Copy link
Copy Markdown
Owner

Thanks for the PR, will check it out later this week since I am not home currently 😅

@bcakmakoglu bcakmakoglu self-assigned this Apr 1, 2026
@bcakmakoglu bcakmakoglu added the documentation Changes only affect the documentation label Apr 1, 2026
@bcakmakoglu bcakmakoglu merged commit f4a42b5 into bcakmakoglu:master May 14, 2026
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Changes only affect the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants