Skip to content

docs(DEV-878): Add cells note to the Performance guide#12270

Merged
qunabu merged 2 commits into
developfrom
feature/DEV-878_Add-cells-note-to-Performance-guide
Apr 7, 2026
Merged

docs(DEV-878): Add cells note to the Performance guide#12270
qunabu merged 2 commits into
developfrom
feature/DEV-878_Add-cells-note-to-Performance-guide

Conversation

@qunabu
Copy link
Copy Markdown
Contributor

@qunabu qunabu commented Apr 2, 2026

Summary

[skip changelog]

  • Adds a new "Avoid the cells option when possible" section to the Performance guide explaining that cells is a function called before every rendering cycle for every visible cell, making it heavier than alternatives.
  • Lists lighter alternatives (cell, columns, setCellMeta()) and when to prefer them.
  • Expands the Related API reference section with cell, cells, columns, and setCellMeta() entries.

ClickUp task

https://app.clickup.com/t/9015210959/DEV-878

Test plan

  • Open the Performance guide page and verify the new section appears between "Rule of thumb: don't use too much styling" and "Suspend rendering".
  • Verify all links in the new section (cells, cell, columns, setCellMeta(), rendering cycles) resolve correctly.
  • Verify the Related API reference at the bottom includes the new entries.

https://claude.ai/code/session_011NCnBtswtc4PSGbpAaASsr


Note

Low Risk
Low risk documentation-only change; the main risk is incorrect guidance or broken links in the added references.

Overview
Adds a new performance-guide section warning that the cells option is evaluated on every render for every visible cell and can significantly impact grid performance.

Recommends lower-overhead alternatives (cell, columns, and setCellMeta()) and expands the “Related API reference” to include these options plus a new “Core methods” entry for setCellMeta().

Reviewed by Cursor Bugbot for commit ec7afab. Bugbot is set up for automated code reviews on this repo. Configure here.

Explain that the `cells` option is a function invoked before every
rendering cycle and runs for each visible cell, making it heavier than
the static `cell`/`columns` options or `setCellMeta()`. Direct users to
prefer lighter alternatives and reserve `cells` for logic that can't be
expressed otherwise.

https://claude.ai/code/session_011NCnBtswtc4PSGbpAaASsr
@qunabu
Copy link
Copy Markdown
Contributor Author

qunabu commented Apr 2, 2026

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 2, 2026

✅ Preview documentation is is available now
Current staging version of documentation is available at: https://dev-handsontable-feature-dev-878-add.netlify.app/docs

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Apr 2, 2026

More templates

npm i https://pkg.pr.new/handsontable@12270
npm i https://pkg.pr.new/@handsontable/react-wrapper@12270
npm i https://pkg.pr.new/@handsontable/vue3@12270
npm i https://pkg.pr.new/@handsontable/angular-wrapper@12270

commit: ec7afab

@qunabu qunabu self-assigned this Apr 2, 2026
@qunabu qunabu requested a review from GreenFlux April 2, 2026 20:50
GreenFlux
GreenFlux previously approved these changes Apr 3, 2026
…d adapt API reference format

Resolve conflict in performance.md: adopt the new Astro Starlight
<div class="boxes-list"> format for the Related API reference section
while preserving the new cell/cells/columns/setCellMeta() entries added
for DEV-878.

https://claude.ai/code/session_011NCnBtswtc4PSGbpAaASsr
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 7, 2026

Performance tests results

Artifacts: performance-tests-output (open the workflow run, then download performance-tests-output).


Metric latest current % change Value change
Total (ms) 15308 15229 -0.5% -79
System (ms) 504 513 +1.8% +9
Scripting (ms) 5163 3058 -40.8% -2105
Rendering (ms) 2974 2448 -17.7% -526
Loading (ms) 0 0 0% 0
Painting (ms) 532 489 -8.1% -43
Experience (ms)
Idle (ms) 6135 8721 +42.2% +2586
Min JS heap (kb) 924 kb 924 kb +0.0% 0
Max JS heap (Mb) 39.6 Mb 53.1 Mb +34.1% +13.5 Mb
Min Documents (count) 2 2 +0.0% 0
Max Documents (count) 4 4 +0.0% 0
Min Nodes (count) 20 20 +0.0% 0
Max Nodes (count) 150744 150798 +0.0% +54
Min Listeners (count) 0 0 0% 0
Max Listeners (count) 153 156 +2.0% +3

@qunabu
Copy link
Copy Markdown
Contributor Author

qunabu commented Apr 7, 2026

@qunabu qunabu marked this pull request as ready for review April 7, 2026 12:46
@qunabu qunabu merged commit 39839bb into develop Apr 7, 2026
37 checks passed
@qunabu qunabu deleted the feature/DEV-878_Add-cells-note-to-Performance-guide branch April 7, 2026 12:46
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.

3 participants