Skip to content

fix(grid): fix drag error when tbody not render #3538

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 26, 2025
Merged

fix(grid): fix drag error when tbody not render #3538

merged 1 commit into from
Jun 26, 2025

Conversation

gimmyhehe
Copy link
Member

@gimmyhehe gimmyhehe commented Jun 26, 2025

PR

修复拖拽功能异常,修改初始化拖拽逻辑时机

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Refactor
    • Improved the initialization of row and column drag-and-drop functionality for tables, ensuring immediate and reliable setup when the table body becomes available. No changes to user-facing features or settings.

Copy link

coderabbitai bot commented Jun 26, 2025

Walkthrough

The initialization logic for row and column drag-and-drop in the grid body component has been moved from a delayed execution within the onMounted lifecycle hook to a reactive watcher on the tbody element. This ensures immediate and repeated setup of drag-and-drop functionality whenever tbody changes, removing the previous reliance on setTimeout.

Changes

File(s) Change Summary
.../grid/src/body/src/body.tsx Moved drag-and-drop initialization from delayed onMounted hook to a reactive watcher on tbody.

Poem

The table’s rows and columns now leap,
Reacting to changes, not waiting for sleep.
No more delays, the drag-and-drop’s spry,
With watchers alert and code standing by.
A hop, a skip, and features align,
Grid bunnies rejoice—everything’s fine! 🐇

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/vue/src/grid/src/body/src/body.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the bug Something isn't working label Jun 26, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 768fc7b and dedef3c.

📒 Files selected for processing (1)
  • packages/vue/src/grid/src/body/src/body.tsx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*`: 用于写产品需求和开发文档的文件,需求应尽量写得简单清晰易懂。 在需求设计阶段应遵从逐步迭代的原则,早期版本可以尽量简洁。

**/*: 用于写产品需求和开发文档的文件,需求应尽量写得简单清晰易懂。
在需求设计阶段应遵从逐步迭代的原则,早期版本可以尽量简洁。

📄 Source: CodeRabbit Inference Engine (.cursor/rules/product.mdc)

List of files the instruction was applied to:

  • packages/vue/src/grid/src/body/src/body.tsx
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: PR E2E Test (pnpm test:e2e3)

Comment on lines +753 to +764
hooks.watch(tbody, (tbody) => {
if (tbody && $table.dropConfig) {
// 初始化行列拖拽
const { plugin, row = true, column = true, scheme } = $table.dropConfig

plugin && row && (vm.rowSortable = $table.rowDrop(body.value))

if (scheme !== 'v2') {
plugin && column && (vm.columnSortable = $table.columnDrop(body.value))
}
}
})
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add cleanup logic to prevent memory leaks when tbody changes.

The implementation correctly fixes the timing issue by using a reactive watcher instead of setTimeout. However, since watchers can trigger multiple times, you should destroy existing sortable instances before creating new ones to prevent memory leaks.

Apply this diff to add proper cleanup:

 hooks.watch(tbody, (tbody) => {
   if (tbody && $table.dropConfig) {
+    // 清理之前的拖拽实例
+    if (vm.rowSortable) {
+      vm.rowSortable.destroy()
+      vm.rowSortable = null
+    }
+    if (vm.columnSortable) {
+      vm.columnSortable.destroy()
+      vm.columnSortable = null
+    }
+
     // 初始化行列拖拽
     const { plugin, row = true, column = true, scheme } = $table.dropConfig

     plugin && row && (vm.rowSortable = $table.rowDrop(body.value))

     if (scheme !== 'v2') {
       plugin && column && (vm.columnSortable = $table.columnDrop(body.value))
     }
   }
 })
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
hooks.watch(tbody, (tbody) => {
if (tbody && $table.dropConfig) {
// 初始化行列拖拽
const { plugin, row = true, column = true, scheme } = $table.dropConfig
plugin && row && (vm.rowSortable = $table.rowDrop(body.value))
if (scheme !== 'v2') {
plugin && column && (vm.columnSortable = $table.columnDrop(body.value))
}
}
})
hooks.watch(tbody, (tbody) => {
if (tbody && $table.dropConfig) {
// 清理之前的拖拽实例
if (vm.rowSortable) {
vm.rowSortable.destroy()
vm.rowSortable = null
}
if (vm.columnSortable) {
vm.columnSortable.destroy()
vm.columnSortable = null
}
// 初始化行列拖拽
const { plugin, row = true, column = true, scheme } = $table.dropConfig
plugin && row && (vm.rowSortable = $table.rowDrop(body.value))
if (scheme !== 'v2') {
plugin && column && (vm.columnSortable = $table.columnDrop(body.value))
}
}
})
🤖 Prompt for AI Agents
In packages/vue/src/grid/src/body/src/body.tsx around lines 753 to 764, the
watcher on tbody creates new sortable instances each time it triggers without
cleaning up previous instances, causing potential memory leaks. Modify the
watcher to first check if vm.rowSortable and vm.columnSortable exist and call
their destroy methods to clean up before assigning new sortable instances. This
ensures old instances are properly disposed before creating new ones.

@zzcr zzcr merged commit 0e74d5f into dev Jun 26, 2025
10 of 11 checks passed
@zzcr zzcr deleted the cgm/fix-drag-bug branch June 26, 2025 07:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants