Skip to content
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

Native demos in the docs #1447

Open
wants to merge 41 commits into
base: develop
Choose a base branch
from
Open

Native demos in the docs #1447

wants to merge 41 commits into from

Conversation

sequba
Copy link
Contributor

@sequba sequba commented Sep 26, 2024

Changes

After this PR, the basic demo looks like this:
image

  • add vuepress plugins and script necessary for compilation and running native HTML+JS+CSS demos
  • add the Open in Stackblitz button
  • add code-examples-generator script to HyperFormula project
  • migrate all demos to 3-files format in the docs/examples directory in the main HyperFormula repo

Demos migrated:

  • advanced usage
  • basic operations
  • basic usage
  • batch operations
  • clipboard operations
  • date and time handling
  • demo
  • i18n
  • localizing functions
  • named expressions
  • sorting data
  • 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.

  • react demo
  • angular demo
  • vue demo
  • svelte demo
  • 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?

  • 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)
  • Change to the documentation

Related issues:

  1. Fixes Migrate documentation demos to native HTML+JS #1441

Checklist:

  • 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.
  • My change is compliant with the OpenDocument standard.
  • My change is compatible with Microsoft Excel.
  • 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.

@sequba sequba changed the title Native demos in docs Native demos in the docs Sep 26, 2024
@sequba sequba self-assigned this Sep 26, 2024
@sequba sequba added the Docs Improvements or additions to documentation label Sep 26, 2024
@sequba sequba changed the base branch from master to develop September 26, 2024 09:46
docs/examples/demo/example1.ts Fixed Show fixed Hide fixed
docs/examples/demo/example1.ts Fixed Show fixed Hide fixed
Copy link

github-actions bot commented Sep 27, 2024

Performance comparison of head (95ff6d7) vs base (fa09de2)

                                     testName |   base |   head |  change
-------------------------------------------------------------------------
                                      Sheet A | 499.18 | 502.63 |  +0.69%
                                      Sheet B | 160.03 | 161.57 |  +0.96%
                                      Sheet T | 141.23 | 140.65 |  -0.41%
                                Column ranges | 505.49 | 511.99 |  +1.29%
Sheet A:  change value, add/remove row/column |  13.09 |  14.58 | +11.38%
 Sheet B: change value, add/remove row/column | 125.22 | 127.27 |  +1.64%
                   Column ranges - add column | 146.68 | 150.18 |  +2.39%
                Column ranges - without batch | 430.75 | 436.72 |  +1.39%
                        Column ranges - batch |  107.5 | 109.48 |  +1.84%

Copy link

codecov bot commented Oct 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.22%. Comparing base (d7ee29f) to head (d810cd1).
Report is 25 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@             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     

see 1 file with indirect coverage changes

docs/examples/date-time/example1.ts Fixed Show fixed Hide fixed
docs/examples/date-time/example1.ts Fixed Show fixed Hide fixed
docs/examples/i18n/example1.ts Fixed Show fixed Hide fixed
docs/examples/i18n/example1.ts Fixed Show fixed Hide fixed
docs/examples/i18n/example1.ts Fixed Show fixed Hide fixed
docs/examples/i18n/example1.ts Fixed Show fixed Hide fixed
docs/examples/i18n/example1.ts Fixed Show fixed Hide fixed
@sequba sequba marked this pull request as ready for review October 8, 2024 14:56
docs/examples/i18n/example1.ts Dismissed Show dismissed Hide dismissed
docs/examples/i18n/example1.ts Dismissed Show dismissed Hide dismissed
docs/examples/localizing-functions/example1.ts Dismissed Show dismissed Hide dismissed
docs/examples/localizing-functions/example1.ts Dismissed Show dismissed Hide dismissed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Migrate documentation demos to native HTML+JS
2 participants