Skip to content

fix(grid): optimize render count #3613

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

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

fix(grid): optimize render count #3613

wants to merge 2 commits into from

Conversation

gimmyhehe
Copy link
Member

@gimmyhehe gimmyhehe commented Jul 25, 2025

PR

减少column.renderWidth的多次赋值导致的表格render重新执行

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 performance of table rendering by optimizing how column widths are calculated and assigned, reducing unnecessary re-renders.
    • Streamlined internal logic for managing temporary data used in header calculations.
    • Adjusted the scheduling of table recalculations for more predictable updates.
  • Chores

    • Removed an unnecessary debug log statement from table utilities.

Copy link

coderabbitai bot commented Jul 25, 2025

Walkthrough

The changes refactor internal logic in three grid-related Vue source files. They optimize array reuse in a header utility, adjust the timing of a recalculation callback in a table method, and consolidate column width assignments in an auto-width utility to minimize unnecessary re-renders. No public APIs or function signatures are modified.

Changes

Files Change Summary
packages/vue/src/grid/src/composable/useHeader.ts Moves subTable array from function-local to module-level, reusing and clearing it between calls to reduce allocations.
packages/vue/src/grid/src/table/src/methods.ts Simplifies recalculate invocation: removes nested setTimeout in favor of direct this.$nextTick(this.recalculate).
packages/vue/src/grid/src/table/src/utils/autoCellWidth.ts Refactors width calculations to use temporary arrays, consolidates assignments to reduce re-renders, removes a debug log.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

A bunny hopped through lines of code,
Arrays now cleared, not thrown away,
Widths set once, no flickers showed,
NextTick hops—no timeout delay.
In tidy fields, the grid now gleams—
Clean code, efficient as a dream!
🐇✨

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/table/src/utils/autoCellWidth.ts

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.

packages/vue/src/grid/src/table/src/methods.ts

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.

packages/vue/src/grid/src/composable/useHeader.ts

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.

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch cgm/grid-render-dix

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 generate unit tests to generate unit tests for 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 Jul 25, 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 6b27c30 and 558b9e9.

📒 Files selected for processing (3)
  • packages/vue/src/grid/src/composable/useHeader.ts (1 hunks)
  • packages/vue/src/grid/src/table/src/methods.ts (1 hunks)
  • packages/vue/src/grid/src/table/src/utils/autoCellWidth.ts (4 hunks)
🔇 Additional comments (7)
packages/vue/src/grid/src/composable/useHeader.ts (1)

56-56: Efficient array clearing implementation.

Good use of length = 0 for clearing the reused array - this preserves the reference while removing all elements, which is exactly what's needed for the performance optimization.

packages/vue/src/grid/src/table/src/methods.ts (1)

829-829: No timing dependencies found for recalculate() – manual verification recommended

We’ve replaced:

  • From:
    this.$nextTick(() => { setTimeout(() => { this.recalculate() }) })
  • To:
    this.$nextTick(this.recalculate)

Since $nextTick already waits for the DOM to update, the extra setTimeout appears redundant. A repository-wide search yielded no comments or code relying on a delayed recalculate() call.

Please manually verify that no timing-sensitive behavior breaks, for example:

  • Table rendering after data changes (filters, sorts, pagination)
  • Resizing or dynamic column updates
  • Any custom callbacks that assumed the extra tick
packages/vue/src/grid/src/table/src/utils/autoCellWidth.ts (5)

49-50: Excellent optimization to reduce re-renders.

The introduction of minArr to batch width assignments is a smart approach to prevent multiple column.renderWidth modifications that could trigger unnecessary re-renders during width calculations.


53-58: Correct indexing for batched width storage.

The indexing logic minArr[index + scaleMinArr.length] correctly places pxMinArr widths after scaleMinArr entries in the temporary array.


63-68: Consistent batching strategy for scale minimum widths.

Storing scaleMinArr widths at the beginning of minArr is consistent with the overall batching strategy and indexing logic.


109-125: Deferred assignment optimization for auto columns.

Using a local renderWidth variable and deferring the assignment to column.renderWidth until after all calculations are complete follows the same optimization pattern and prevents intermediate re-renders.


139-142: Correct final batch assignment of calculated widths.

The final assignment loop correctly applies all calculated widths from minArr back to the columns using consistent indexing, completing the render optimization effectively.

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.

1 participant