From b38899c5835ee4b3374c66dae5a80d1c4e2f41ef Mon Sep 17 00:00:00 2001 From: Masha_Rudenko Date: Mon, 25 May 2026 15:43:28 +0300 Subject: [PATCH 1/3] [update] docs related to export with json2excel/excel2json libraries --- docs/api/spreadsheet_exportmodulepath_config.md | 8 +++++--- docs/loading_data.md | 8 +++++--- docs/react/props.md | 6 ++++-- 3 files changed, 14 insertions(+), 8 deletions(-) diff --git a/docs/api/spreadsheet_exportmodulepath_config.md b/docs/api/spreadsheet_exportmodulepath_config.md index 1a050977..6f5590c2 100644 --- a/docs/api/spreadsheet_exportmodulepath_config.md +++ b/docs/api/spreadsheet_exportmodulepath_config.md @@ -20,7 +20,7 @@ exportModulePath?: string; ~~~jsx {2} const spreadsheet = new dhx.Spreadsheet("spreadsheet", { - exportModulePath: "../libs/json2excel/1.0/worker.js", + exportModulePath: "../libs/json2excel/x.x/worker.js", // other config parameters }); ~~~ @@ -35,8 +35,10 @@ To export files you need to: - install the **JSON2excel** library - set the path to the **worker.js** file via the **exportModulePath** option in one of the two ways: - - by providing a local path to the file on your computer, like: `"../libs/json2excel/1.0/worker.js"` - - by providing a link to the file from CDN: `"https://cdn.dhtmlx.com/libs/json2excel/1.0/worker.js"` + - by providing a local path to the file on your computer, like: `"../libs/json2excel/x.x/worker.js"` + - by providing a link to the file from CDN: `"https://cdn.dhtmlx.com/libs/json2excel/x.x/worker.js"` + +Replace `x.x` with the actual version number (check the [GitHub repository](https://github.com/dhtmlx/json2excel)). By default the link to CDN is used. diff --git a/docs/loading_data.md b/docs/loading_data.md index 2173468f..1c1f137e 100644 --- a/docs/loading_data.md +++ b/docs/loading_data.md @@ -306,12 +306,14 @@ The library uses the WebAssembly-based library [Json2Excel](https://github.com/d - install the **JSON2Excel** library - specify the [](api/spreadsheet_exportmodulepath_config.md) option in the Spreadsheet configuration and set the path to the **worker.js** file in one of the two ways: - - by providing a local path to the file on your computer, like: `"../libs/json2excel/1.0/worker.js"` - - by providing a link to the file from CDN: `"https://cdn.dhtmlx.com/libs/json2excel/1.0/worker.js"` + - by providing a local path to the file on your computer, like: `"../libs/json2excel/x.x/worker.js"` + - by providing a link to the file from CDN: `"https://cdn.dhtmlx.com/libs/json2excel/x.x/worker.js"` + +Replace `x.x` with the actual version number (check the [GitHub repository](https://github.com/dhtmlx/json2excel)). ~~~jsx var spreadsheet = new dhx.Spreadsheet(document.body, { - exportModulePath: "../libs/json2excel/1.0/worker.js" + exportModulePath: "../libs/json2excel/x.x/worker.js" }); ~~~ diff --git a/docs/react/props.md b/docs/react/props.md index fbdd48fb..58466d15 100644 --- a/docs/react/props.md +++ b/docs/react/props.md @@ -169,11 +169,13 @@ Enable sheet tabs with `multiSheets={true}`. Pass `false` to hide the tab bar en ~~~tsx ~~~ +Replace `x.x` with the actual version numbers (check the [Excel2Json](https://github.com/dhtmlx/excel2json) and [Json2Excel](https://github.com/dhtmlx/json2excel) GitHub repositories). + ### European number formatting ~~~tsx From 0c8f90e7cb20a5b93cd0d256922effbe82eb499d Mon Sep 17 00:00:00 2001 From: Masha_Rudenko Date: Fri, 5 Jun 2026 12:06:48 +0300 Subject: [PATCH 2/3] [update] clarify Json2Excel/Excel2Json export URL options in Spreadsheet docs - add next (latest) and x.x (specific version) as parallel options with bullet lists - update code examples to use next as default with inline comment for x.x alternative - add default CDN URL (next/worker.js?vx) explicitly in exportModulePath config - add ?vx suffix to all CDN URLs - remove standalone 'Replace x.x' sentences, fold version note into descriptions - update react/props.md example and note for both importModulePath and exportModulePath --- docs/api/spreadsheet_exportmodulepath_config.md | 16 +++++++++------- docs/loading_data.md | 12 +++++++----- docs/react/props.md | 6 +++--- 3 files changed, 19 insertions(+), 15 deletions(-) diff --git a/docs/api/spreadsheet_exportmodulepath_config.md b/docs/api/spreadsheet_exportmodulepath_config.md index 6f5590c2..e3112d4e 100644 --- a/docs/api/spreadsheet_exportmodulepath_config.md +++ b/docs/api/spreadsheet_exportmodulepath_config.md @@ -20,7 +20,7 @@ exportModulePath?: string; ~~~jsx {2} const spreadsheet = new dhx.Spreadsheet("spreadsheet", { - exportModulePath: "../libs/json2excel/x.x/worker.js", + exportModulePath: "../libs/json2excel/next/worker.js", // latest version; use x.x instead of next for a specific version // other config parameters }); ~~~ @@ -35,12 +35,14 @@ To export files you need to: - install the **JSON2excel** library - set the path to the **worker.js** file via the **exportModulePath** option in one of the two ways: - - by providing a local path to the file on your computer, like: `"../libs/json2excel/x.x/worker.js"` - - by providing a link to the file from CDN: `"https://cdn.dhtmlx.com/libs/json2excel/x.x/worker.js"` - -Replace `x.x` with the actual version number (check the [GitHub repository](https://github.com/dhtmlx/json2excel)). - -By default the link to CDN is used. + - by providing a local path to the file on your computer: + - use `"../libs/json2excel/next/worker.js"` for the latest version + - use `"../libs/json2excel/x.x/worker.js"` for a specific version (replace `x.x` with the actual version from the [GitHub repository](https://github.com/dhtmlx/json2excel)) + - by providing a link to the file from CDN: + - use `"https://cdn.dhtmlx.com/libs/json2excel/next/worker.js?vx"` for the latest version + - use `"https://cdn.dhtmlx.com/libs/json2excel/x.x/worker.js?vx"` for a specific version (replace `x.x` with the actual version from the [GitHub repository](https://github.com/dhtmlx/json2excel)) + +By default, `https://cdn.dhtmlx.com/libs/json2excel/next/worker.js?vx` is used. **Related articles:** [Data loading and export](loading_data.md#exporting-data) diff --git a/docs/loading_data.md b/docs/loading_data.md index 1c1f137e..466667d2 100644 --- a/docs/loading_data.md +++ b/docs/loading_data.md @@ -306,14 +306,16 @@ The library uses the WebAssembly-based library [Json2Excel](https://github.com/d - install the **JSON2Excel** library - specify the [](api/spreadsheet_exportmodulepath_config.md) option in the Spreadsheet configuration and set the path to the **worker.js** file in one of the two ways: - - by providing a local path to the file on your computer, like: `"../libs/json2excel/x.x/worker.js"` - - by providing a link to the file from CDN: `"https://cdn.dhtmlx.com/libs/json2excel/x.x/worker.js"` - -Replace `x.x` with the actual version number (check the [GitHub repository](https://github.com/dhtmlx/json2excel)). + - by providing a local path to the file on your computer: + - use `"../libs/json2excel/next/worker.js"` for the latest version + - use `"../libs/json2excel/x.x/worker.js"` for a specific version (replace `x.x` with the actual version from the [GitHub repository](https://github.com/dhtmlx/json2excel)) + - by providing a link to the file from CDN: + - use `"https://cdn.dhtmlx.com/libs/json2excel/next/worker.js?vx"` for the latest version + - use `"https://cdn.dhtmlx.com/libs/json2excel/x.x/worker.js?vx"` for a specific version (replace `x.x` with the actual version from the [GitHub repository](https://github.com/dhtmlx/json2excel)) ~~~jsx var spreadsheet = new dhx.Spreadsheet(document.body, { - exportModulePath: "../libs/json2excel/x.x/worker.js" + exportModulePath: "../libs/json2excel/next/worker.js" // latest version; use x.x instead of next for a specific version }); ~~~ diff --git a/docs/react/props.md b/docs/react/props.md index 58466d15..e2fe9097 100644 --- a/docs/react/props.md +++ b/docs/react/props.md @@ -169,12 +169,12 @@ Enable sheet tabs with `multiSheets={true}`. Pass `false` to hide the tab bar en ~~~tsx ~~~ -Replace `x.x` with the actual version numbers (check the [Excel2Json](https://github.com/dhtmlx/excel2json) and [Json2Excel](https://github.com/dhtmlx/json2excel) GitHub repositories). +To use a specific version, replace `next` with the version number (check the [Excel2Json](https://github.com/dhtmlx/excel2json) and [Json2Excel](https://github.com/dhtmlx/json2excel) GitHub repositories). ### European number formatting From d9e1d483bc069f19b45b0d18b016ec8d25906419 Mon Sep 17 00:00:00 2001 From: Masha_Rudenko Date: Mon, 8 Jun 2026 12:53:10 +0300 Subject: [PATCH 3/3] [update] rework export path docs to public vs own server framing - replace local-path/CDN bullet structure with public-vs-own-server approach - update code examples to use x.x/worker.js?vx instead of next - fix admonition syntax from {{note}} to :::note in loading_data.md - remove inline comments from React props code example --- .../spreadsheet_exportmodulepath_config.md | 18 +++++-------- docs/loading_data.md | 25 ++++++++++--------- docs/react/props.md | 4 +-- 3 files changed, 21 insertions(+), 26 deletions(-) diff --git a/docs/api/spreadsheet_exportmodulepath_config.md b/docs/api/spreadsheet_exportmodulepath_config.md index e3112d4e..f339213d 100644 --- a/docs/api/spreadsheet_exportmodulepath_config.md +++ b/docs/api/spreadsheet_exportmodulepath_config.md @@ -20,7 +20,7 @@ exportModulePath?: string; ~~~jsx {2} const spreadsheet = new dhx.Spreadsheet("spreadsheet", { - exportModulePath: "../libs/json2excel/next/worker.js", // latest version; use x.x instead of next for a specific version + exportModulePath: "../libs/json2excel/x.x/worker.js?vx", // a local path to the `worker.js` file of the export module // other config parameters }); ~~~ @@ -31,18 +31,12 @@ const spreadsheet = new dhx.Spreadsheet("spreadsheet", { DHTMLX Spreadsheet uses the WebAssembly-based library [JSON2Excel](https://github.com/dhtmlx/json2excel) for export of data into Excel. ::: -To export files you need to: +To export files you need to set the path to the **worker.js** file of the [Json2Excel](https://github.com/dhtmlx/json2excel) library (where export will be processed) via the **exportModulePath** option. By default, `https://cdn.dhtmlx.com/libs/json2excel/next/worker.js?vx` is used. +- if you use the public export server, you don't need to specify the link to it, since it is used by default +- if you use your own export server, you need to: + - install the [**Json2Excel**](https://github.com/dhtmlx/json2excel) library + - use `"../libs/json2excel/x.x/worker.js?vx"` for a specific version (replace `x.x` with the version deployed on your server) -- install the **JSON2excel** library -- set the path to the **worker.js** file via the **exportModulePath** option in one of the two ways: - - by providing a local path to the file on your computer: - - use `"../libs/json2excel/next/worker.js"` for the latest version - - use `"../libs/json2excel/x.x/worker.js"` for a specific version (replace `x.x` with the actual version from the [GitHub repository](https://github.com/dhtmlx/json2excel)) - - by providing a link to the file from CDN: - - use `"https://cdn.dhtmlx.com/libs/json2excel/next/worker.js?vx"` for the latest version - - use `"https://cdn.dhtmlx.com/libs/json2excel/x.x/worker.js?vx"` for a specific version (replace `x.x` with the actual version from the [GitHub repository](https://github.com/dhtmlx/json2excel)) - -By default, `https://cdn.dhtmlx.com/libs/json2excel/next/worker.js?vx` is used. **Related articles:** [Data loading and export](loading_data.md#exporting-data) diff --git a/docs/loading_data.md b/docs/loading_data.md index 466667d2..8ebafbba 100644 --- a/docs/loading_data.md +++ b/docs/loading_data.md @@ -300,22 +300,21 @@ DHTMLX Spreadsheet provides the ability to export data from a spreadsheet into a #### How to export data -{{note Please note that the export feature won't work in the Internet Explorer browser.}} +:::note +Please note that the export feature won't work in the Internet Explorer browser. +::: -The library uses the WebAssembly-based library [Json2Excel](https://github.com/dhtmlx/json2excel) to enable the functionality of export to Excel. Thus, to have the possibility of exporting files you need to: +The library uses the WebAssembly-based library [Json2Excel](https://github.com/dhtmlx/json2excel) to enable the functionality of export to Excel. Export is processed at the **worker.js** file of the **Json2Excel** library (the default link is `https://cdn.dhtmlx.com/libs/json2excel/next/worker.js?vx`). You can use either the public export server or a local export server. Thus, to have the possibility of exporting files you need to: -- install the **JSON2Excel** library -- specify the [](api/spreadsheet_exportmodulepath_config.md) option in the Spreadsheet configuration and set the path to the **worker.js** file in one of the two ways: - - by providing a local path to the file on your computer: - - use `"../libs/json2excel/next/worker.js"` for the latest version - - use `"../libs/json2excel/x.x/worker.js"` for a specific version (replace `x.x` with the actual version from the [GitHub repository](https://github.com/dhtmlx/json2excel)) - - by providing a link to the file from CDN: - - use `"https://cdn.dhtmlx.com/libs/json2excel/next/worker.js?vx"` for the latest version - - use `"https://cdn.dhtmlx.com/libs/json2excel/x.x/worker.js?vx"` for a specific version (replace `x.x` with the actual version from the [GitHub repository](https://github.com/dhtmlx/json2excel)) +- specify the [](api/spreadsheet_exportmodulepath_config.md) option in the Spreadsheet configuration and set the path to the **worker.js** file: + - if you use the public export server, you don't need to specify the link to it, since it is used by default + - if you use your own export server, you need to: + - install the [**Json2Excel**](https://github.com/dhtmlx/json2excel) library + - use `"../libs/json2excel/x.x/worker.js?vx"` for a specific version (replace `x.x` with the version deployed on your server) ~~~jsx var spreadsheet = new dhx.Spreadsheet(document.body, { - exportModulePath: "../libs/json2excel/next/worker.js" // latest version; use x.x instead of next for a specific version + exportModulePath: "../libs/json2excel/x.x/worker.js?vx" // the path to the export module, if a local export server is used }); ~~~ @@ -329,7 +328,9 @@ spreadsheet.export.xlsx(); **Related sample**: [Spreadsheet. Export Xlsx](https://snippet.dhtmlx.com/btyo3j8s?tag=spreadsheet) -{{note Please note that the component supports export to Excel files with the **.xlsx** extension only.}} +:::note +Please note that the component supports export to Excel files with the `.xlsx` extension only. +::: #### How to set a custom name for an exported file diff --git a/docs/react/props.md b/docs/react/props.md index e2fe9097..16a05170 100644 --- a/docs/react/props.md +++ b/docs/react/props.md @@ -169,8 +169,8 @@ Enable sheet tabs with `multiSheets={true}`. Pass `false` to hide the tab bar en ~~~tsx ~~~