Skip to content

docs: rewrite Vue integration guide around markRaw pattern#1689

Merged
Haxikowy merged 2 commits into
developfrom
refactor/integration-with-vue
Jun 3, 2026
Merged

docs: rewrite Vue integration guide around markRaw pattern#1689
Haxikowy merged 2 commits into
developfrom
refactor/integration-with-vue

Conversation

@Haxikowy

@Haxikowy Haxikowy commented Jun 3, 2026

Copy link
Copy Markdown

Summary

  • Replaces the SpreadsheetProvider class example with the idiomatic markRaw pattern as the primary recommendation
  • Reframes the SSR section: HyperFormula is SSR-safe by default, <ClientOnly> is an optional optimization
  • Adds a TypeScript tip with a plain JS note
  • Tightens prose throughout (net -20 lines)

Test plan

  • Review the rendered docs page for clarity and correctness
  • Verify all internal links resolve (basic-operations.md, configuration-options.md, etc.)
  • Confirm the Vue 3 StackBlitz demo link still works

Note

Low Risk
Documentation-only edits to integration guides; no application code, auth, or data paths change.

Overview
Aligns the Vue and React integration guides around the same TypeScript-first docs pattern and makes markRaw the primary Vue integration story instead of a separate provider class.

Vue (integration-with-vue.md): Drops the SpreadsheetProvider wrapper and spreadsheet-provider.ts example in favor of a single <script setup> sample that builds HyperFormula inside markRaw, keeps sheet output in a ref, and calls destroy() on unmount. Template buttons gain disabled states tied to whether results are shown. Copy explains that only values is reactive and points mutators at Basic operations. The Nuxt/SSR section is shortened: HyperFormula is fine on the server; <ClientOnly> is framed as an optional way to skip server work, not a requirement. Troubleshooting keeps the same licenseKeyValidityState error but uses consistent markRaw snippets (including hf naming).

React (integration-with-react.md): Adds the same ::: tip TypeScript block (remove annotations for plain JS) and removes the redundant standalone “drop type annotations” paragraph after the example.

No runtime or API changes—docs and examples only.

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

- Replace SpreadsheetProvider class with markRaw as the primary pattern
- Remove Updating cells section; mutation hint moved inline after the example
- Reframe SSR section: HyperFormula is SSR-safe by default, ClientOnly is optional
- Add TypeScript tip with JS note
- Tighten prose throughout
@netlify

netlify Bot commented Jun 3, 2026

Copy link
Copy Markdown

Deploy Preview for hyperformula-docs ready!

Name Link
🔨 Latest commit fbd8be3
🔍 Latest deploy log https://app.netlify.com/projects/hyperformula-docs/deploys/6a2014b7d6832000087270ee
😎 Deploy Preview https://deploy-preview-1689--hyperformula-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.

@Haxikowy Haxikowy self-assigned this Jun 3, 2026
@Haxikowy Haxikowy changed the base branch from master to develop June 3, 2026 11:49
@netlify

netlify Bot commented Jun 3, 2026

Copy link
Copy Markdown

Deploy Preview for hyperformula-dev-docs ready!

Name Link
🔨 Latest commit 650eb19
🔍 Latest deploy log https://app.netlify.com/projects/hyperformula-dev-docs/deploys/6a2015d7f4780400088518b3
😎 Deploy Preview https://deploy-preview-1689--hyperformula-dev-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.

@github-actions

github-actions Bot commented Jun 3, 2026

Copy link
Copy Markdown

Performance comparison of head (650eb19) vs base (0e047ee)

                                     testName |   base |   head | change
------------------------------------------------------------------------
                                      Sheet A | 492.16 | 487.12 | -1.02%
                                      Sheet B | 156.89 | 154.85 | -1.30%
                                      Sheet T | 135.09 | 137.77 | +1.98%
                                Column ranges | 512.67 | 516.23 | +0.69%
Sheet A:  change value, add/remove row/column |  16.04 |  15.46 | -3.62%
 Sheet B: change value, add/remove row/column | 130.19 | 137.66 | +5.74%
                   Column ranges - add column |  159.3 | 154.69 | -2.89%
                Column ranges - without batch | 470.09 | 474.79 | +1.00%
                        Column ranges - batch | 118.12 | 120.82 | +2.29%

@Haxikowy

Haxikowy commented Jun 3, 2026

Copy link
Copy Markdown
Author

Verified on preview

@Haxikowy Haxikowy requested a review from sequba June 3, 2026 12:10
@codecov

codecov Bot commented Jun 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.16%. Comparing base (0e047ee) to head (650eb19).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #1689   +/-   ##
========================================
  Coverage    97.16%   97.16%           
========================================
  Files          176      176           
  Lines        15322    15322           
  Branches      3356     3356           
========================================
  Hits         14887    14887           
  Misses         427      427           
  Partials         8        8           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@sequba sequba left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍

@Haxikowy Haxikowy merged commit 79f2f15 into develop Jun 3, 2026
36 checks passed
@Haxikowy Haxikowy deleted the refactor/integration-with-vue branch June 3, 2026 12:54
GreenFlux added a commit that referenced this pull request Jun 3, 2026
Brings in two content-only commits that landed on develop after the
last sync:

- 0e047ee docs: fix SSR section framing in React integration guide (#1688)
- 79f2f15 docs: rewrite Vue integration guide around markRaw pattern (#1689)

Both touch files we migrated from `docs/guide/` to
`docs/src/content/docs/guide/`. Git's rename detection auto-applied
the develop-side edits to the new locations — no conflicts.

GitHub had flagged the PR as CONFLICTING because its mergeability check
hadn't recomputed since develop's last push; pushing this merge clears
that flag.
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