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 1 commit into
base: next
Choose a base branch
from
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
1 commit
Select commit
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
8 changes: 5 additions & 3 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/x.x/worker.js",
// other config parameters
});
~~~
Expand All @@ -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.

Expand Down
8 changes: 5 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,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"
});
~~~

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/x.x/worker.js"
exportModulePath="../libs/json2excel/x.x/worker.js"
/>
~~~

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
Expand Down