@slickgrid-universal/excel-export 1.2.4 → 1.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +20 -20
- package/README.md +71 -71
- package/dist/commonjs/interfaces/index.js +5 -1
- package/dist/commonjs/interfaces/index.js.map +1 -1
- package/package.json +3 -3
package/LICENSE
CHANGED
|
@@ -1,20 +1,20 @@
|
|
|
1
|
-
Copyright (c) 2020-2022, Ghislain B. - Slickgrid-Universal
|
|
2
|
-
|
|
3
|
-
Permission is hereby granted, free of charge, to any person obtaining
|
|
4
|
-
a copy of this software and associated documentation files (the
|
|
5
|
-
"Software"), to deal in the Software without restriction, including
|
|
6
|
-
without limitation the rights to use, copy, modify, merge, publish,
|
|
7
|
-
distribute, sublicense, and/or sell copies of the Software, and to
|
|
8
|
-
permit persons to whom the Software is furnished to do so, subject to
|
|
9
|
-
the following conditions:
|
|
10
|
-
|
|
11
|
-
The above copyright notice and this permission notice shall be
|
|
12
|
-
included in all copies or substantial portions of the Software.
|
|
13
|
-
|
|
14
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
15
|
-
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
16
|
-
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
17
|
-
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
18
|
-
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
19
|
-
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
20
|
-
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
1
|
+
Copyright (c) 2020-2022, Ghislain B. - Slickgrid-Universal
|
|
2
|
+
|
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
|
4
|
+
a copy of this software and associated documentation files (the
|
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
|
9
|
+
the following conditions:
|
|
10
|
+
|
|
11
|
+
The above copyright notice and this permission notice shall be
|
|
12
|
+
included in all copies or substantial portions of the Software.
|
|
13
|
+
|
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,71 +1,71 @@
|
|
|
1
|
-
[](https://opensource.org/licenses/MIT)
|
|
2
|
-
[](http://www.typescriptlang.org/)
|
|
3
|
-
[](https://github.com/ghiscoding/lerna-lite)
|
|
4
|
-
[](https://www.npmjs.com/package/@slickgrid-universal/excel-export)
|
|
5
|
-
[](https://www.npmjs.com/package/@slickgrid-universal/excel-export)
|
|
6
|
-
|
|
7
|
-
[](https://github.com/ghiscoding/slickgrid-universal/actions)
|
|
8
|
-
[](https://www.cypress.io/)
|
|
9
|
-
[](https://github.com/facebook/jest)
|
|
10
|
-
[](https://codecov.io/gh/ghiscoding/slickgrid-universal)
|
|
11
|
-
|
|
12
|
-
## Excel Export Service
|
|
13
|
-
#### @slickgrid-universal/excel-export
|
|
14
|
-
|
|
15
|
-
Simple Export to Excel Service that allows to exporting as `.xls` or `.xlsx`.
|
|
16
|
-
|
|
17
|
-
### Internal Dependencies
|
|
18
|
-
- [@slickgrid-universal/common](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/common)
|
|
19
|
-
|
|
20
|
-
### External Dependencies
|
|
21
|
-
This package requires [excel-builder-webpacker](https://www.npmjs.com/package/excel-builder-webpacker) which itself requires [jszip](https://www.npmjs.com/package/jszip) and [lodash](https://www.npmjs.com/package/lodash), the later not being a small lib, so make sure that you are fine with the bundle size. For our use case, the extra bundle size is totally worth the feature.
|
|
22
|
-
|
|
23
|
-
### Installation
|
|
24
|
-
Follow the instruction provided in the main [README](https://github.com/ghiscoding/slickgrid-universal#installation), you can see a demo by looking at the [GitHub Demo](https://ghiscoding.github.io/slickgrid-universal) page and click on "Export to Excel" from the Grid Menu (aka hamburger menu).
|
|
25
|
-
|
|
26
|
-
### Usage
|
|
27
|
-
In order to use the Service, you will need to register it in your grid options via the `registerExternalResources` as shown below.
|
|
28
|
-
|
|
29
|
-
##### ViewModel
|
|
30
|
-
```ts
|
|
31
|
-
import { ExcelExportService } from '@slickgrid-universal/excel-export';
|
|
32
|
-
|
|
33
|
-
export class MyExample {
|
|
34
|
-
initializeGrid {
|
|
35
|
-
this.gridOptions = {
|
|
36
|
-
enableExcelExport: true,
|
|
37
|
-
excelExportOptions: {
|
|
38
|
-
sanitizeDataExport: true
|
|
39
|
-
},
|
|
40
|
-
registerExternalResources: [new ExcelExportService()],
|
|
41
|
-
}
|
|
42
|
-
}
|
|
43
|
-
}
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
If you wish to reference the service to use it with external export button, then simply create a reference while instantiating it.
|
|
47
|
-
```ts
|
|
48
|
-
import { ExcelExportService } from '@slickgrid-universal/excel-export';
|
|
49
|
-
|
|
50
|
-
export class MyExample {
|
|
51
|
-
excelExportService: ExcelExportService;
|
|
52
|
-
|
|
53
|
-
constructor() {
|
|
54
|
-
this.excelExportService = new ExcelExportService();
|
|
55
|
-
}
|
|
56
|
-
|
|
57
|
-
initializeGrid {
|
|
58
|
-
this.gridOptions = {
|
|
59
|
-
enableExcelExport: true,
|
|
60
|
-
excelExportOptions: {
|
|
61
|
-
sanitizeDataExport: true
|
|
62
|
-
},
|
|
63
|
-
registerExternalResources: [this.excelExportService],
|
|
64
|
-
}
|
|
65
|
-
}
|
|
66
|
-
|
|
67
|
-
exportToExcel() {
|
|
68
|
-
this.excelExportService.exportToExcel({ filename: 'export', format: FileType.xlsx });
|
|
69
|
-
}
|
|
70
|
-
}
|
|
71
|
-
```
|
|
1
|
+
[](https://opensource.org/licenses/MIT)
|
|
2
|
+
[](http://www.typescriptlang.org/)
|
|
3
|
+
[](https://github.com/ghiscoding/lerna-lite)
|
|
4
|
+
[](https://www.npmjs.com/package/@slickgrid-universal/excel-export)
|
|
5
|
+
[](https://www.npmjs.com/package/@slickgrid-universal/excel-export)
|
|
6
|
+
|
|
7
|
+
[](https://github.com/ghiscoding/slickgrid-universal/actions)
|
|
8
|
+
[](https://www.cypress.io/)
|
|
9
|
+
[](https://github.com/facebook/jest)
|
|
10
|
+
[](https://codecov.io/gh/ghiscoding/slickgrid-universal)
|
|
11
|
+
|
|
12
|
+
## Excel Export Service
|
|
13
|
+
#### @slickgrid-universal/excel-export
|
|
14
|
+
|
|
15
|
+
Simple Export to Excel Service that allows to exporting as `.xls` or `.xlsx`.
|
|
16
|
+
|
|
17
|
+
### Internal Dependencies
|
|
18
|
+
- [@slickgrid-universal/common](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/common)
|
|
19
|
+
|
|
20
|
+
### External Dependencies
|
|
21
|
+
This package requires [excel-builder-webpacker](https://www.npmjs.com/package/excel-builder-webpacker) which itself requires [jszip](https://www.npmjs.com/package/jszip) and [lodash](https://www.npmjs.com/package/lodash), the later not being a small lib, so make sure that you are fine with the bundle size. For our use case, the extra bundle size is totally worth the feature.
|
|
22
|
+
|
|
23
|
+
### Installation
|
|
24
|
+
Follow the instruction provided in the main [README](https://github.com/ghiscoding/slickgrid-universal#installation), you can see a demo by looking at the [GitHub Demo](https://ghiscoding.github.io/slickgrid-universal) page and click on "Export to Excel" from the Grid Menu (aka hamburger menu).
|
|
25
|
+
|
|
26
|
+
### Usage
|
|
27
|
+
In order to use the Service, you will need to register it in your grid options via the `registerExternalResources` as shown below.
|
|
28
|
+
|
|
29
|
+
##### ViewModel
|
|
30
|
+
```ts
|
|
31
|
+
import { ExcelExportService } from '@slickgrid-universal/excel-export';
|
|
32
|
+
|
|
33
|
+
export class MyExample {
|
|
34
|
+
initializeGrid {
|
|
35
|
+
this.gridOptions = {
|
|
36
|
+
enableExcelExport: true,
|
|
37
|
+
excelExportOptions: {
|
|
38
|
+
sanitizeDataExport: true
|
|
39
|
+
},
|
|
40
|
+
registerExternalResources: [new ExcelExportService()],
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
If you wish to reference the service to use it with external export button, then simply create a reference while instantiating it.
|
|
47
|
+
```ts
|
|
48
|
+
import { ExcelExportService } from '@slickgrid-universal/excel-export';
|
|
49
|
+
|
|
50
|
+
export class MyExample {
|
|
51
|
+
excelExportService: ExcelExportService;
|
|
52
|
+
|
|
53
|
+
constructor() {
|
|
54
|
+
this.excelExportService = new ExcelExportService();
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
initializeGrid {
|
|
58
|
+
this.gridOptions = {
|
|
59
|
+
enableExcelExport: true,
|
|
60
|
+
excelExportOptions: {
|
|
61
|
+
sanitizeDataExport: true
|
|
62
|
+
},
|
|
63
|
+
registerExternalResources: [this.excelExportService],
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
exportToExcel() {
|
|
68
|
+
this.excelExportService.exportToExcel({ filename: 'export', format: FileType.xlsx });
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
```
|
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
3
|
if (k2 === undefined) k2 = k;
|
|
4
|
-
Object.
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
5
9
|
}) : (function(o, m, k, k2) {
|
|
6
10
|
if (k2 === undefined) k2 = k;
|
|
7
11
|
o[k2] = m[k];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/interfaces/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/interfaces/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8DAA4C;AAC5C,gEAA8C;AAC9C,4DAA0C;AAC1C,8DAA4C;AAC5C,4DAA0C;AAC1C,6DAA2C"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@slickgrid-universal/excel-export",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.5",
|
|
4
4
|
"description": "Excel Export (xls/xlsx) Service.",
|
|
5
5
|
"main": "dist/commonjs/index.js",
|
|
6
6
|
"module": "dist/esm/index.js",
|
|
@@ -47,7 +47,7 @@
|
|
|
47
47
|
"not dead"
|
|
48
48
|
],
|
|
49
49
|
"dependencies": {
|
|
50
|
-
"@slickgrid-universal/common": "^1.2.
|
|
50
|
+
"@slickgrid-universal/common": "^1.2.5",
|
|
51
51
|
"excel-builder-webpacker": "^2.1.6",
|
|
52
52
|
"moment-mini": "^2.24.0"
|
|
53
53
|
},
|
|
@@ -60,5 +60,5 @@
|
|
|
60
60
|
"type": "ko_fi",
|
|
61
61
|
"url": "https://ko-fi.com/N4N679OT"
|
|
62
62
|
},
|
|
63
|
-
"gitHead": "
|
|
63
|
+
"gitHead": "3e31b6633e5fa2dc9cd64ce73c5fb8dc25cbc485"
|
|
64
64
|
}
|