Skip to content

docs: worker option in 1.x; main-thread writer yields; engine ^2.0.0-beta.0 and beta wording; #110 bundle size measured - #214

Merged
securedeveloper merged 2 commits into
mainfrom
rde-docs-1x-worker
Nov 17, 2026
Merged

securedeveloper merged 2 commits into
mainfrom
rde-docs-1x-worker

Conversation

@securedeveloper

@securedeveloper securedeveloper commented Nov 17, 2026 •

Copy link
Copy Markdown
Owner

Brings the docs in line with the decision of 2026-11-17: the background-worker export lands in 1.x, not 1.0. Until then, the main-thread export yields to the browser (as of javascript-excel 2.0.0-alpha.7). This PR also moves the engine to javascript-excel's first beta, switches the wording to beta, and replaces the [placeholder] for the #110 bundle size with measured numbers.

Engine range

  • react-data-export and the playground now depend on javascript-excel@^2.0.0-beta.0 (was ^2.0.0-alpha.3). The lockfile moves from alpha.3 to beta.0.
  • beta.0 is javascript-excel's first 2.0.0 beta. Since alpha.7, toBlob returns to the event loop about every 16 ms while it writes, so a large .xlsx export on the main thread no longer freezes the page, and an abort takes effect mid-write. The output bytes are unchanged.
  • Rebased onto main after RDE-1.10: javascript-excel's conformance corpus through the public API #213. The conformance corpus is unchanged at the v2.0.0-beta.0 tag, so node scripts/sync-jse-corpus.mjs --check passes without a new copy. The Conformance job runs here.
  • Patch changesets: .changeset/javascript-excel-beta-0.md and .changeset/beta-wording.md.

Beta wording

The README, the playground banner (apps/playground/src/App.tsx) and the docs/api.md status line no longer say "alpha". They say that the 1.0 feature set is complete and that, until 1.0.0, changes are limited to fixes found in testing. The banner keeps showing {version}.

Docs

  • docs/api.md:
    • §7 now says that exports run on the main thread in 1.0 and that the writer yields as of alpha.7, while building the sheet and CSV stay synchronous.
    • It also says that the worker?: WorkerClient option comes in a 1.x minor release (decided 2026-11-17). javascript-excel/worker has existed since 2.0.0-alpha.1, so the "planned (JSE-8)" wording in §9 was stale.
    • §9 states the new range (^2.0.0-beta.0) and gains a row for the yielding writer (since alpha.7).
    • §10 and Q6 are updated, and the status line now gives ≥ beta.0.
  • README.md gets a "Big exports stay responsive" bullet: the main thread yields, and the worker comes in 1.x. packages/react-data-export/README.md gets the same in one sentence.
  • docs/triage-1.0.md:

Bundle size (#110)

There's a new fixtures/bundle-size fixture in the bundler matrix. It's not a compatibility check. It makes one Vite production build per usage and one with React alone, and scripts/bundlers.mjs prints what each usage adds (minified, gzip -9, brotli -11). The table goes to the log and the Bundlers job summary. The 1.0 builds also get the same no-fs/tempa-xlsx/jszip scan as the other fixtures.

Measured locally on Node 26 with npm run bundlers -- bundle-size: Vite 8.3.8 + React 19.3.1, react-data-export 1.0.0-alpha.3 (packed from this branch) on javascript-excel 2.0.0-alpha.7. CI's fresh install resolved 2.0.0-beta.0 and gave exactly the same numbers. The baseline, React alone, is 213.7 KiB minified (65.8 KiB gzip).

app minified gzip -9 brotli -11
1.0: exportDataset behind a button +72.8 KiB +24.7 KiB +21.8 KiB
1.0: <ExportTableButton> on a table +78.4 KiB +27.7 KiB +24.1 KiB
1.0: every export of the main entry +90.0 KiB +31.5 KiB +27.4 KiB
0.6.0: <ExcelFile> + <ExcelSheet> + <ExcelColumn> +741.1 KiB +266.3 KiB +169.5 KiB

Dependencies

Local runs (Node 26), after the rebase onto main: npm test with openpyxl (204 passed, 2 skipped), the playground tests, npm run typecheck and docs:check pass, and so does npm run bundlers -- bundle-size.

…script-excel 2.0.0-alpha.7); measure the bundle size (#110)

- Depend on javascript-excel ^2.0.0-alpha.7, whose writer returns to the
  event loop about every 16 ms (library and playground).
- docs/api.md, README, the package README and docs/triage-1.0.md: the
  worker option comes in a 1.x release, not 1.0; until then a large export
  on the main thread keeps the page responsive.
- fixtures/bundle-size + scripts/bundlers.mjs: what react-data-export adds
  to a Vite + React 19 production build per usage, against React alone and
  0.6.0, printed in the Bundlers job summary. The numbers replace the #110
  placeholder in docs/triage-1.0.md.
javascript-excel 2.0.0-beta.0 is on npm. The library and the playground
depend on ^2.0.0-beta.0, and the lockfile resolves it. The conformance
corpus is unchanged at the beta.0 tag (sync --check passes). The README,
the playground banner and the docs/api.md status line say that the 1.0
feature set is complete, and that changes before 1.0.0 are limited to
fixes found in testing.
@securedeveloper securedeveloper changed the title docs: worker option in 1.x; main-thread writer yields (javascript-excel ^2.0.0-alpha.7); #110 bundle size measured docs: worker option in 1.x; main-thread writer yields; engine ^2.0.0-beta.0 and beta wording; #110 bundle size measured Nov 17, 2026
@securedeveloper
securedeveloper merged commit f48b7b6 into main Nov 17, 2026
38 checks passed
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.

1 participant