docs: rewrite Vue integration guide around markRaw pattern#1689
Merged
Conversation
- 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
✅ Deploy Preview for hyperformula-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for hyperformula-dev-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Performance comparison of head (650eb19) vs base (0e047ee) |
Author
|
Verified on preview |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ 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:
|
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
SpreadsheetProviderclass example with the idiomaticmarkRawpattern as the primary recommendation<ClientOnly>is an optional optimizationTest plan
basic-operations.md,configuration-options.md, etc.)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
markRawthe primary Vue integration story instead of a separate provider class.Vue (
integration-with-vue.md): Drops theSpreadsheetProviderwrapper andspreadsheet-provider.tsexample in favor of a single<script setup>sample that buildsHyperFormulainsidemarkRaw, keeps sheet output in aref, and callsdestroy()on unmount. Template buttons gain disabled states tied to whether results are shown. Copy explains that onlyvaluesis 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 samelicenseKeyValidityStateerror but uses consistentmarkRawsnippets (includinghfnaming).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.