@slickgrid-universal/text-export 0.19.1 → 1.2.0
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/CHANGELOG.md +39 -2
- package/README.md +75 -75
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -3,17 +3,54 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
# [1.2.0](https://github.com/ghiscoding/slickgrid-universal/compare/v1.1.1...v1.2.0) (2022-01-06)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @slickgrid-universal/text-export
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## [1.1.1](https://github.com/ghiscoding/slickgrid-universal/compare/v1.1.0...v1.1.1) (2021-12-11)
|
|
7
15
|
|
|
8
16
|
|
|
9
17
|
### Bug Fixes
|
|
10
18
|
|
|
11
|
-
* **
|
|
19
|
+
* **build:** bump version manually bcoz of previous force push ([5e9a610](https://github.com/ghiscoding/slickgrid-universal/commit/5e9a610ad01d752673856591f9b5de73b0ece0e9))
|
|
20
|
+
|
|
21
|
+
|
|
12
22
|
|
|
13
23
|
|
|
14
24
|
|
|
25
|
+
# [1.1.0](https://github.com/ghiscoding/slickgrid-universal/compare/v0.19.2...v1.1.0) (2021-12-11)
|
|
15
26
|
|
|
27
|
+
**Note:** Version bump only for package @slickgrid-universal/text-export
|
|
16
28
|
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
## [0.19.2](https://github.com/ghiscoding/slickgrid-universal/compare/v0.19.1...v0.19.2) (2021-11-19)
|
|
35
|
+
|
|
36
|
+
**Note:** Version bump only for package @slickgrid-universal/text-export
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
## [0.19.1](https://github.com/ghiscoding/slickgrid-universal/compare/v0.19.0...v0.19.1) (2021-11-15)
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### Bug Fixes
|
|
47
|
+
|
|
48
|
+
* **export:** sanitize any html that could exist in header titles ([abdae52](https://github.com/ghiscoding/slickgrid-universal/commit/abdae52822c4496286a653ed84be964213e1d32f))
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
|
|
17
54
|
|
|
18
55
|
# [0.19.0](https://github.com/ghiscoding/slickgrid-universal/compare/v0.18.0...v0.19.0) (2021-10-28)
|
|
19
56
|
|
package/README.md
CHANGED
|
@@ -1,75 +1,75 @@
|
|
|
1
|
-
[](https://opensource.org/licenses/MIT)
|
|
2
|
-
[](http://www.typescriptlang.org/)
|
|
3
|
-
[](https://lerna.js.org/)
|
|
4
|
-
[](https://www.npmjs.com/package/@slickgrid-universal/text-export)
|
|
5
|
-
[](https://www.npmjs.com/package/@slickgrid-universal/text-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
|
-
## Text Export Service (text file)
|
|
13
|
-
#### @slickgrid-universal/text-export
|
|
14
|
-
|
|
15
|
-
Simple Export to File Service that allows to export as CSV or Text, user can also choose which separator to use (comma, colon, semicolon, ...).
|
|
16
|
-
|
|
17
|
-
There are a couple of reasons to use this package (instead of the `excel-export`)
|
|
18
|
-
- if you want to export to a text file with any type of separator (tab, colon, semicolon, comma)
|
|
19
|
-
- if you have a very large dataset, this export consumes a lot less memory
|
|
20
|
-
|
|
21
|
-
### Internal Dependencies
|
|
22
|
-
- [@slickgrid-universal/common](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/common)
|
|
23
|
-
|
|
24
|
-
### External Dependencies
|
|
25
|
-
This package requires [text-encoding-utf-8](https://www.npmjs.com/package/text-encoding-utf-8) which is use to ensure proper UTF-8 encoding, even emoji will be exported without issues.
|
|
26
|
-
|
|
27
|
-
### Installation
|
|
28
|
-
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 CSV" from the Grid Menu (aka hamburger menu).
|
|
29
|
-
|
|
30
|
-
### Usage
|
|
31
|
-
In order to use the Service, you will need to register it in your grid options via the `registerExternalResources` as shown below.
|
|
32
|
-
|
|
33
|
-
##### ViewModel
|
|
34
|
-
```ts
|
|
35
|
-
import { TextExportService } from '@slickgrid-universal/text-export';
|
|
36
|
-
|
|
37
|
-
export class MyExample {
|
|
38
|
-
initializeGrid {
|
|
39
|
-
this.gridOptions = {
|
|
40
|
-
enableTextExport: true,
|
|
41
|
-
exportOptions: {
|
|
42
|
-
sanitizeDataExport: true
|
|
43
|
-
},
|
|
44
|
-
registerExternalResources: [new TextExportService()],
|
|
45
|
-
}
|
|
46
|
-
}
|
|
47
|
-
}
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
If you wish to reference the service to use it with external export button, then simply create a reference while instantiating it.
|
|
51
|
-
```ts
|
|
52
|
-
import { TextExportService } from '@slickgrid-universal/text-export';
|
|
53
|
-
|
|
54
|
-
export class MyExample {
|
|
55
|
-
exportService: TextExportService;
|
|
56
|
-
|
|
57
|
-
constructor() {
|
|
58
|
-
this.exportService = new TextExportService();
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
initializeGrid {
|
|
62
|
-
this.gridOptions = {
|
|
63
|
-
enableTextExport: true,
|
|
64
|
-
exportOptions: {
|
|
65
|
-
sanitizeDataExport: true
|
|
66
|
-
},
|
|
67
|
-
registerExternalResources: [this.exportService],
|
|
68
|
-
}
|
|
69
|
-
}
|
|
70
|
-
|
|
71
|
-
exportToFile() {
|
|
72
|
-
this.exportService.exportToFile({ filename: 'export', format: FileType.csv });
|
|
73
|
-
}
|
|
74
|
-
}
|
|
75
|
-
```
|
|
1
|
+
[](https://opensource.org/licenses/MIT)
|
|
2
|
+
[](http://www.typescriptlang.org/)
|
|
3
|
+
[](https://lerna.js.org/)
|
|
4
|
+
[](https://www.npmjs.com/package/@slickgrid-universal/text-export)
|
|
5
|
+
[](https://www.npmjs.com/package/@slickgrid-universal/text-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
|
+
## Text Export Service (text file)
|
|
13
|
+
#### @slickgrid-universal/text-export
|
|
14
|
+
|
|
15
|
+
Simple Export to File Service that allows to export as CSV or Text (`.csv` or `.txt`), user can also choose which data separator to use for the export (comma, colon, semicolon, ...).
|
|
16
|
+
|
|
17
|
+
There are a couple of reasons to use this package (it could be used instead of the `excel-export`)
|
|
18
|
+
- if you want to export to a text file with any type of separator (tab, colon, semicolon, comma)
|
|
19
|
+
- if you have a very large dataset, this export consumes a lot less memory in comparison to the `excel-export`
|
|
20
|
+
|
|
21
|
+
### Internal Dependencies
|
|
22
|
+
- [@slickgrid-universal/common](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/common)
|
|
23
|
+
|
|
24
|
+
### External Dependencies
|
|
25
|
+
This package requires [text-encoding-utf-8](https://www.npmjs.com/package/text-encoding-utf-8) which is use to ensure proper UTF-8 encoding, even emoji will be exported without issues.
|
|
26
|
+
|
|
27
|
+
### Installation
|
|
28
|
+
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 CSV" from the Grid Menu (aka hamburger menu).
|
|
29
|
+
|
|
30
|
+
### Usage
|
|
31
|
+
In order to use the Service, you will need to register it in your grid options via the `registerExternalResources` as shown below.
|
|
32
|
+
|
|
33
|
+
##### ViewModel
|
|
34
|
+
```ts
|
|
35
|
+
import { TextExportService } from '@slickgrid-universal/text-export';
|
|
36
|
+
|
|
37
|
+
export class MyExample {
|
|
38
|
+
initializeGrid {
|
|
39
|
+
this.gridOptions = {
|
|
40
|
+
enableTextExport: true,
|
|
41
|
+
exportOptions: {
|
|
42
|
+
sanitizeDataExport: true
|
|
43
|
+
},
|
|
44
|
+
registerExternalResources: [new TextExportService()],
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
If you wish to reference the service to use it with external export button, then simply create a reference while instantiating it.
|
|
51
|
+
```ts
|
|
52
|
+
import { TextExportService } from '@slickgrid-universal/text-export';
|
|
53
|
+
|
|
54
|
+
export class MyExample {
|
|
55
|
+
exportService: TextExportService;
|
|
56
|
+
|
|
57
|
+
constructor() {
|
|
58
|
+
this.exportService = new TextExportService();
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
initializeGrid {
|
|
62
|
+
this.gridOptions = {
|
|
63
|
+
enableTextExport: true,
|
|
64
|
+
exportOptions: {
|
|
65
|
+
sanitizeDataExport: true
|
|
66
|
+
},
|
|
67
|
+
registerExternalResources: [this.exportService],
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
exportToFile() {
|
|
72
|
+
this.exportService.exportToFile({ filename: 'export', format: FileType.csv });
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@slickgrid-universal/text-export",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "1.2.0",
|
|
4
4
|
"description": "Export to Text File (csv/txt) 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": "^
|
|
50
|
+
"@slickgrid-universal/common": "^1.2.0",
|
|
51
51
|
"text-encoding-utf-8": "^1.0.2"
|
|
52
52
|
},
|
|
53
53
|
"devDependencies": {
|
|
@@ -56,5 +56,5 @@
|
|
|
56
56
|
"npm-run-all": "^4.1.5",
|
|
57
57
|
"rimraf": "^3.0.2"
|
|
58
58
|
},
|
|
59
|
-
"gitHead": "
|
|
59
|
+
"gitHead": "af25eecf8994d5b6ec9eb13bfd266cba71c1cfcb"
|
|
60
60
|
}
|