Skip to content

[update] docs related to export with json2excel/excel2json libraries #62

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.

Sign up for GitHub

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

Open
mafanya23 wants to merge 2 commits into
base: next
Choose a base branch
from
+20 −10
Open

[update] docs related to export with json2excel/excel2json libraries #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b38899c
[update] docs related to export with json2excel/excel2json libraries
mafanya23 May 25, 2026
0c8f90e
[update] clarify Json2Excel/Excel2Json export URL options in Spreadsh…
mafanya23 Jun 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions docs/api/spreadsheet_exportmodulepath_config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ exportModulePath?: string;

~~~jsx {2}
const spreadsheet = new dhx.Spreadsheet("spreadsheet", {
exportModulePath: "../libs/json2excel/1.0/worker.js",
exportModulePath: "../libs/json2excel/next/worker.js", // latest version; use x.x instead of next for a specific version
Copy link
Copy Markdown

@SergMitMin SergMitMin Jun 6, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

комментарий можно убрать
// latest version; use x.x instead of next for a specific version

// other config parameters
});
~~~
Expand All @@ -35,10 +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/1.0/worker.js"`
- by providing a link to the file from CDN: `"https://cdn.dhtmlx.com/libs/json2excel/1.0/worker.js"`

By default the link to CDN is used.
- by providing a local path to the file on your computer:
Copy link
Copy Markdown

@SergMitMin SergMitMin Jun 6, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

По поводу фрагмента - by providing a local path to the file on your computer

не оч корректная формулировка и лучше использовать тож самое что и в Suite
For a local export server, set the path to the worker.js file relative to your server:

актуально ко всем местам где оно встречается

- 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))
Copy link
Copy Markdown

@SergMitMin SergMitMin Jun 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

для cdn можно не указывать эту часть (актуально ко всем cdn фрагментам):
- 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)


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)

Expand Down
10 changes: 7 additions & 3 deletions docs/loading_data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,12 +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/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:
- 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))
Copy link
Copy Markdown

@SergMitMin SergMitMin Jun 5, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

наверное ссылки на версионные файлы в cdn(те которые не next) не нужно давать, оч мало шансов что юзерам понадобится неактуальная версия

в целом(как я понимаю) - ожидаемые сценарии:

  1. юзеры берут next с cdn

  2. или используют экспорт локально, тогда они как раз могут сами указывать версию x.x в пути, чтобы знать какая у них версия лежит

так что в моментах с локальным экспорта - можно писать про x.x, а в моментах с cdn - стоит оставить next


~~~jsx
var spreadsheet = new dhx.Spreadsheet(document.body, {
exportModulePath: "../libs/json2excel/1.0/worker.js"
exportModulePath: "../libs/json2excel/next/worker.js" // latest version; use x.x instead of next for a specific version
Copy link
Copy Markdown

@SergMitMin SergMitMin Jun 6, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

можно не добавлять комментарий
// latest version; use x.x instead of next for a specific version

});
~~~

Expand Down
6 changes: 4 additions & 2 deletions docs/react/props.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,11 +169,13 @@ Enable sheet tabs with `multiSheets={true}`. Pass `false` to hide the tab bar en
~~~tsx
<ReactSpreadsheet
sheets={sheets}
importModulePath="../libs/excel2json/1.0/worker.js"
exportModulePath="../libs/json2excel/1.0/worker.js"
importModulePath="../libs/excel2json/next/worker.js" // latest version; use x.x instead of next for a specific version
exportModulePath="../libs/json2excel/next/worker.js" // latest version; use x.x instead of next for a specific version
Comment on lines +172 to +173
Copy link
Copy Markdown

@SergMitMin SergMitMin Jun 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

можно не добавлять комментарии
// latest version; use x.x instead of next for a specific version

/>
~~~

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

~~~tsx
Expand Down