react-csv-downloader - npm Package Compare versions

Comparing version 3.0.0 to 3.1.0

CHANGELOG.md

 # Change Log
 
+## [3.1.0] - 2024-01-06
+
+### Added
+
+- Ability to add title at top of the csv [#386](https://github.com/dolezel/react-csv-downloader/pull/386)
+
 ## [3.0.0] - 2023-10-29
@@ -4,0 +10,0 @@

dist/cjs/index.d.ts

@@ -16,2 +16,3 @@ import * as React from 'react';
     handleEmpty?: () => void;
+    title?: string;
 }
@@ -18,0 +19,0 @@ export default class CsvDownload extends React.Component<ICsvDownloadProps> {

dist/cjs/lib/csv.d.ts

@@ -18,3 +18,4 @@ export interface IColumn {
     chunkSize?: number;
+    title?: string;
 }
-export default function csv({ columns, datas, separator, noHeader, wrapColumnChar, newLineAtEnd, chunkSize, }: ICsvProps): Promise<string | void>;
+export default function csv({ columns, datas, separator, noHeader, wrapColumnChar, newLineAtEnd, chunkSize, title, }: ICsvProps): Promise<string | void>;

dist/cjs/lib/csv.js

@@ -74,3 +74,3 @@ "use strict";
 };
-function csv({ columns, datas, separator = ',', noHeader = false, wrapColumnChar = '', newLineAtEnd = false, chunkSize = 1000, }) {
+function csv({ columns, datas, separator = ',', noHeader = false, wrapColumnChar = '', newLineAtEnd = false, chunkSize = 1000, title = '', }) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -91,2 +91,5 @@ // eslint-disable-next-line no-async-promise-executor
                     if (headerNames.length > 0) {
+                        if (title !== '') {
+                            content.push(title);
+                        }
                         content.push(headerNames.map(wrap).join(separator));
@@ -93,0 +96,0 @@ }

dist/esm/index.d.ts

@@ -16,2 +16,3 @@ import * as React from 'react';
     handleEmpty?: () => void;
+    title?: string;
 }
@@ -18,0 +19,0 @@ export default class CsvDownload extends React.Component<ICsvDownloadProps> {

dist/esm/lib/csv.d.ts

@@ -18,3 +18,4 @@ export interface IColumn {
     chunkSize?: number;
+    title?: string;
 }
-export default function csv({ columns, datas, separator, noHeader, wrapColumnChar, newLineAtEnd, chunkSize, }: ICsvProps): Promise<string | void>;
+export default function csv({ columns, datas, separator, noHeader, wrapColumnChar, newLineAtEnd, chunkSize, title, }: ICsvProps): Promise<string | void>;

dist/esm/lib/csv.js

@@ -72,3 +72,3 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
 };
-export default function csv({ columns, datas, separator = ',', noHeader = false, wrapColumnChar = '', newLineAtEnd = false, chunkSize = 1000, }) {
+export default function csv({ columns, datas, separator = ',', noHeader = false, wrapColumnChar = '', newLineAtEnd = false, chunkSize = 1000, title = '', }) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -89,2 +89,5 @@ // eslint-disable-next-line no-async-promise-executor
                     if (headerNames.length > 0) {
+                        if (title !== '') {
+                            content.push(title);
+                        }
                         content.push(headerNames.map(wrap).join(separator));
@@ -91,0 +94,0 @@ }

package.json

 {
   "name": "react-csv-downloader",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "React csv downloader",
@@ -44,22 +44,23 @@ "main": "dist/cjs/index.js",
   "devDependencies": {
-    "@types/chai": "4.3.9",
-    "@types/file-saver": "2.0.6",
-    "@types/mocha": "10.0.3",
-    "@types/node": "18.17.12",
-    "@types/react": "18.2.33",
-    "@typescript-eslint/eslint-plugin": "6.9.0",
-    "@typescript-eslint/parser": "6.9.0",
+    "@types/chai": "4.3.11",
+    "@types/file-saver": "2.0.7",
+    "@types/mocha": "10.0.6",
+    "@types/node": "20.10.6",
+    "@types/react": "18.2.46",
+    "@typescript-eslint/eslint-plugin": "6.16.0",
+    "@typescript-eslint/parser": "6.16.0",
     "chai": "4.3.10",
-    "eslint": "8.52.0",
-    "eslint-config-prettier": "9.0.0",
-    "eslint-plugin-import": "2.29.0",
+    "eslint": "8.56.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-import": "2.29.1",
+    "eslint-plugin-prettier": "5.1.2",
     "eslint-plugin-react": "7.33.2",
     "eslint-plugin-react-hooks": "4.6.0",
-    "eslint-plugin-sonarjs": "0.21.0",
+    "eslint-plugin-sonarjs": "0.23.0",
     "mocha": "10.2.0",
-    "prettier": "3.0.3",
+    "prettier": "3.1.1",
     "react": "18.2.0",
     "rimraf": "5.0.5",
-    "ts-node": "10.9.1",
-    "typescript": "5.2.2"
+    "ts-node": "10.9.2",
+    "typescript": "5.3.3"
   },
@@ -66,0 +67,0 @@ "peerDependencies": {

README.md

@@ -114,3 +114,4 @@ # React CSV Downloader
 | handleError    | function                     | undefined | false    | Function to be invoked on error data                                                                                                        |
-| handleEmpty    | function                     | undefined | false    | Function to be invoked on empty result data                                                                                                 |
+| handleEmpty    | function                     | undefined | false    | Function to be invoked on empty result data     
+| title          | string                       | undefined | false    | You can pass a string to be added as a title at the top of the sheet
 
@@ -117,0 +118,0 @@ All other props are passed to button or wrapping component.

src/lib/csv.ts

@@ -110,2 +110,3 @@ export interface IColumn {
   chunkSize?: number
+  title?: string
 }
@@ -121,2 +122,3 @@
   chunkSize = 1000,
+  title = '',
 }: ICsvProps) {
@@ -141,2 +143,5 @@ // eslint-disable-next-line no-async-promise-executor
         if (headerNames.length > 0) {
+          if (title !== '') {
+            content.push(title)
+          }
           content.push(headerNames.map(wrap).join(separator))
@@ -143,0 +148,0 @@ }

No alert changes

Improved metrics

Total package byte prevSize

118810

1.12%

Lines of code

1554

1.04%

Number of lines in readme file

177

0.57%

Worsened metrics

Dev dependency count

21

5%

No dependency changes