dce-reactkit 4.1.2 → 4.1.4

package/dist/cjs/types/components/CSVDownloadButton.d.ts

@@ -6,6 +6,7 @@ import React from 'react';
 type Props = {
     filename: string;
     csv: string;
+    label?: string;
     id?: string;
     className?: string;
     ariaLabel?: string;

package/dist/cjs/types/helpers/genCSV.d.ts

@@ -2,7 +2,10 @@
  * Generate a CSV file
  * @author Gabe Abrams
  * @param data list of row data in the form of json objects
- * @param columns list of columns to include in the csv
+ * @param columns list of columns to include in the csv where each column is an object with:
+ * - title: the column title
+ * - param: the key in the data object to use for this column
+ * - textIfUndefined: optional text to use if the value is undefined (defaults to empty string)
  * @returns multiline csv string
  */
 declare const genCSV: (data: {
@@ -10,5 +13,6 @@ declare const genCSV: (data: {
 }[], columns: {
     title: string;
     param: string;
+    textIfUndefined?: string;
 }[]) => string;
 export default genCSV;

package/dist/esm/index.js

@@ -3902,7 +3902,10 @@ const escapeCellText = (text) => {
  * Generate a CSV file
  * @author Gabe Abrams
  * @param data list of row data in the form of json objects
- * @param columns list of columns to include in the csv
+ * @param columns list of columns to include in the csv where each column is an object with:
+ * - title: the column title
+ * - param: the key in the data object to use for this column
+ * - textIfUndefined: optional text to use if the value is undefined (defaults to empty string)
  * @returns multiline csv string
  */
 const genCSV = (data, columns) => {
@@ -3918,16 +3921,20 @@ const genCSV = (data, columns) => {
         csv += '\n';
         csv += (columns
             .map((column) => {
+            var _a;
             let contents;
             const cell = datum[column.param];
             if (typeof cell === 'string'
-                || typeof cell === 'number') {
+                || typeof cell === 'number'
+                || typeof cell === 'boolean') {
                 contents = String(cell);
             }
-            else if (typeof cell === 'undefined'
-                || cell === null) {
+            else if (cell === null) {
                 contents = '';
             }
+            else if (typeof cell === 'undefined') {
+                contents = ((_a = column.textIfUndefined) !== null && _a !== void 0 ? _a : '');
+            }
             else if (typeof cell === 'object') {
                 contents = JSON.stringify(cell);
             }
@@ -3955,7 +3962,7 @@ const CSVDownloadButton = (props) => {
     /*------------------------------------------------------------------------*/
     /* -------------- Props ------------- */
     // Destructure all props
-    const { filename, csv, id, className, ariaLabel, style, onClick, children, } = props;
+    const { filename, csv, id, className, ariaLabel, style, onClick, children, label = 'Download CSV', } = props;
     /*------------------------------------------------------------------------*/
     /* ------------------------------- Render ------------------------------- */
     /*------------------------------------------------------------------------*/
@@ -3969,7 +3976,7 @@ const CSVDownloadButton = (props) => {
         !children && (React__default.createElement(React__default.Fragment, null,
             React__default.createElement(FontAwesomeIcon, { icon: faCloudDownloadAlt }),
             ' ',
-            "Download CSV")),
+            label)),
         children));
 };