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

Set iframe height for Vue and Svelte demos in the docs #1363

Merged
merged 4 commits into from
Jan 30, 2024

Conversation

sequba
Copy link
Contributor

@sequba sequba commented Jan 6, 2024

Context

This PR:

  • sets the height of the iframes to make them show the entire demos
  • removes the invalid sandbox flag 'allow-autoplay' from all demos

image

Other notes:

  • It is possible to force running these demos in a regular codesandbox (instead of devbox) by setting "template": "static" in sandbox.config.json. But then, the demo would not run. I guess some bundlers are not supported in regular codesandboxes, and there is a reason these demos are automatically converted to devboxes.
  • Embedding devboxes is a beta feature and configuring the layout of the demo is currently impossible contrary to regular sandboxes. Even the official example of a devbox doesn't seem to work as expected (it doesn't display a file by default).
  • I tried different undocumented URL params, but nothing works for devboxes
  • I tried different configurations in sandbox.config.json, but nothing works for devboxes
  • If codesandbox didn't fix these issues with embedded devboxes, I recommend moving away from codesandbox and trying another service to embed the demos in the documentation

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:

Fixes #1358

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 self-assigned this Jan 6, 2024
@sequba sequba linked an issue Jan 6, 2024 that may be closed by this pull request
Copy link

github-actions bot commented Jan 6, 2024

Performance comparison of head (8f108d5) vs base (3a7aafb)

                                     testName |   base |   head | change
------------------------------------------------------------------------
                                      Sheet A | 545.72 | 542.51 | -0.59%
                                      Sheet B | 177.82 |  177.8 | -0.01%
                                      Sheet T | 155.02 | 156.02 | +0.65%
                                Column ranges | 565.83 | 566.47 | +0.11%
Sheet A:  change value, add/remove row/column |  14.54 |  15.66 | +7.70%
 Sheet B: change value, add/remove row/column | 135.03 |  135.3 | +0.20%
                   Column ranges - add column | 148.24 | 161.58 | +9.00%
                Column ranges - without batch | 447.06 | 483.37 | +8.12%
                        Column ranges - batch | 129.08 | 138.94 | +7.64%

@sequba sequba marked this pull request as ready for review January 6, 2024 11:48
@sequba sequba requested a review from evanSe January 6, 2024 12:11
Copy link

codecov bot commented Jan 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (fcafd79) 97.36% compared to head (84351e2) 97.36%.
Report is 1 commits behind head on develop.

❗ Current head 84351e2 differs from pull request most recent head 8f108d5. Consider uploading reports for the commit 8f108d5 to get more accurate results

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #1363   +/-   ##
========================================
  Coverage    97.36%   97.36%           
========================================
  Files          169      169           
  Lines        14423    14423           
  Branches      3023     3023           
========================================
  Hits         14043    14043           
  Misses         380      380           

@sequba sequba merged commit 2cb63b1 into develop Jan 30, 2024
21 checks passed
@sequba sequba deleted the feature/issue-1358 branch January 30, 2024 10:27
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.

Improve DX with documentation demos
2 participants