hyperformula
hyperformula copied to clipboard
Native demos in the docs
Changes
After this PR, the basic demo looks like this:
- [x] add vuepress plugins and script necessary for compilation and running native HTML+JS+CSS demos
- [x] add the
Open in Stackblitzbutton - [x] add code-examples-generator script to HyperFormula project
- [x] migrate all demos to 3-files format in the
docs/examplesdirectory in the main HyperFormula repo
Demos migrated:
- [x] advanced usage
- [x] basic operations
- [x] basic usage
- [x] batch operations
- [x] clipboard operations
- [x] date and time handling
- [x] demo
- [x] i18n
- [x] localizing functions
- [x] named expressions
- [x] sorting data
- [x] undo-redo
Exceptions
The framework demos and custom functions demo are more complex and they cannot be converted to the 3-files format easily. In my opinion, it's best to keep them as Codesandbox iframes. Stackblitz is not an option since it doesn't work in Safari.
- [x] react demo
- [x] angular demo
- [x] vue demo
- [x] svelte demo
- [x] custom functions
hyperformula-demos repo
I think, we should archive this repository and continue maintaining the demos in docs/examples directory in the main repo.
How did you test your changes?
- [x] local docs build
Types of changes
- [ ] Breaking change (a fix or a feature because of which an existing functionality doesn't work as expected anymore)
- [ ] New feature or improvement (a non-breaking change that adds functionality)
- [ ] Bug fix (a non-breaking change that fixes an issue)
- [ ] Additional language file, or a change to an existing language file (translations)
- [x] Change to the documentation
Related issues:
- Fixes #1441
Checklist:
- [x] I have reviewed the guidelines about Contributing to HyperFormula and I confirm that my code follows the code style of this project.
- [ ] I have signed the Contributor License Agreement.
- [x] My change is compliant with the OpenDocument standard.
- [x] My change is compatible with Microsoft Excel.
- [x] My change is compatible with Google Sheets.
- [ ] I described my changes in the CHANGELOG.md file.
- [ ] My changes require a documentation update.
- [ ] My changes require a migration guide.
Performance comparison of head (bb267d2fbe85bdc5546e3594174c3c5c6abe79ec) vs base (fa09de2563906b9403dc03904ede37c7d45dbd16)
testName | base | head | change
------------------------------------------------------------------------
Sheet A | 511.52 | 521.17 | +1.89%
Sheet B | 173.22 | 173.51 | +0.17%
Sheet T | 154.28 | 148.3 | -3.88%
Column ranges | 516.85 | 530.51 | +2.64%
Sheet A: change value, add/remove row/column | 14.8 | 15.71 | +6.15%
Sheet B: change value, add/remove row/column | 133.41 | 138.65 | +3.93%
Column ranges - add column | 154.8 | 158.7 | +2.52%
Column ranges - without batch | 468.5 | 461.84 | -1.42%
Column ranges - batch | 118.63 | 114.43 | -3.54%
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 97.22%. Comparing base (
d7ee29f) to head (d810cd1). Report is 25 commits behind head on develop.
Additional details and impacted files
@@ Coverage Diff @@
## develop #1447 +/- ##
===========================================
- Coverage 97.37% 97.22% -0.16%
===========================================
Files 169 169
Lines 14428 14430 +2
Branches 3099 3101 +2
===========================================
- Hits 14049 14029 -20
- Misses 376 395 +19
- Partials 3 6 +3