react-markdown-table-ts 0.3.0 → 0.3.1

package/README.md

@@ -34,10 +34,10 @@ npm install react-markdown-table-ts
 
 |         Prop         |                     Type                      |   Default   |                 Description                 |
 | :------------------: | :-------------------------------------------: | :---------: | :-----------------------------------------: |
-|        `data`        |                 `string[][]`                  | (required)  |   The table data as a 2D array of strings   |
+|        `data`        |                 `string[][]`                  |   `null`    |   The table data as a 2D array of strings   |
 |  `columnAlignments`  | `('left' \| 'center' \| 'right' \| 'none')[]` |    `[]`     |          Alignment for each column          |
 |     `isCompact`      |                   `boolean`                   |   `false`   |          Use minimal column widths          |
-|     `className`      |                   `string`                    | `undefined` |      CSS class for the rendered table       |
+|     `className`      |                   `string`                    | `undefined` |        CSS class for the `<pre>` tag        |
 |      `hasTabs`       |                   `boolean`                   |   `false`   |       Add tabs between table columns        |
 | `canReplaceNewlines` |                   `boolean`                   |   `false`   | Replace newlines in cells with `<br>` tags  |
 |   `onTableCreate`    |      `(markdownString: string) => void`       | `undefined` |   Callback to receive the Markdown string   |

package/dist/index.cjs.js

@@ -4058,7 +4058,7 @@ var Prism$1 = /*@__PURE__*/getDefaultExportFromCjs(prismExports);
 }());
 
 // CSS styles
-var prismStyles = "\ncode[class*=language-],pre[class*=language-]{color:#000;background:0 0;text-shadow:0 1px #fff;font-family:Consolas,Monaco,\"Andale Mono\",\"Ubuntu Mono\",monospace;font-size:1em;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none}code[class*=language-] ::-moz-selection,code[class*=language-]::-moz-selection,pre[class*=language-] ::-moz-selection,pre[class*=language-]::-moz-selection{text-shadow:none;background:#b3d4fc}code[class*=language-] ::selection,code[class*=language-]::selection,pre[class*=language-] ::selection,pre[class*=language-]::selection{text-shadow:none;background:#b3d4fc}@media print{code[class*=language-],pre[class*=language-]{text-shadow:none}}pre[class*=language-]{padding:1em;margin:.5em 0;overflow:auto}:not(pre)>code[class*=language-],pre[class*=language-]{background:#f5f2f0}:not(pre)>code[class*=language-]{padding:.1em;border-radius:.3em;white-space:normal}pre[class*=language-].line-numbers{position:relative;padding-left:3.8em;counter-reset:linenumber}pre[class*=language-].line-numbers>code{position:relative;white-space:inherit}.line-numbers .line-numbers-rows{position:absolute;pointer-events:none;top:0;font-size:100%;left:-3.8em;width:3em;letter-spacing:-1px;border-right:1px solid #999;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.line-numbers-rows>span{display:block;counter-increment:linenumber}.line-numbers-rows>span:before{content:counter(linenumber);color:#999;display:block;padding-right:.8em;text-align:right}\n";
+var PRISM_CSS = "\ncode[class*=language-],pre[class*=language-]{color:#000;background:0 0;text-shadow:0 1px #fff;font-family:Consolas,Monaco,\"Andale Mono\",\"Ubuntu Mono\",monospace;font-size:1em;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none}code[class*=language-] ::-moz-selection,code[class*=language-]::-moz-selection,pre[class*=language-] ::-moz-selection,pre[class*=language-]::-moz-selection{text-shadow:none;background:#b3d4fc}code[class*=language-] ::selection,code[class*=language-]::selection,pre[class*=language-] ::selection,pre[class*=language-]::selection{text-shadow:none;background:#b3d4fc}@media print{code[class*=language-],pre[class*=language-]{text-shadow:none}}pre[class*=language-]{padding:1em;margin:.5em 0;overflow:auto}:not(pre)>code[class*=language-],pre[class*=language-]{background:#f5f2f0}:not(pre)>code[class*=language-]{padding:.1em;border-radius:.3em;white-space:normal}pre[class*=language-].line-numbers{position:relative;padding-left:3.8em;counter-reset:linenumber}pre[class*=language-].line-numbers>code{position:relative;white-space:inherit}.line-numbers .line-numbers-rows{position:absolute;pointer-events:none;top:0;font-size:100%;left:-3.8em;width:3em;letter-spacing:-1px;border-right:1px solid #999;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.line-numbers-rows>span{display:block;counter-increment:linenumber}.line-numbers-rows>span:before{content:counter(linenumber);color:#999;display:block;padding-right:.8em;text-align:right}\n";
 var MarkdownTableError = /** @class */ (function (_super) {
     __extends(MarkdownTableError, _super);
     function MarkdownTableError(message) {
@@ -4177,25 +4177,25 @@ function getColumnName(index) {
     return name;
 }
 var MarkdownTable = function (_a) {
-    var _b = _a.data, data = _b === void 0 ? null : _b, _c = _a.hasHeader, hasHeader = _c === void 0 ? true : _c, _d = _a.columnAlignments, columnAlignments = _d === void 0 ? [] : _d, _e = _a.isCompact, isCompact = _e === void 0 ? false : _e, _f = _a.hasTabs, hasTabs = _f === void 0 ? false : _f, _g = _a.canReplaceNewlines, canReplaceNewlines = _g === void 0 ? false : _g, className = _a.className, onTableCreate = _a.onTableCreate;
+    var _b = _a.inputData, inputData = _b === void 0 ? null : _b, _c = _a.hasHeader, hasHeader = _c === void 0 ? true : _c, _d = _a.columnAlignments, columnAlignments = _d === void 0 ? [] : _d, _e = _a.isCompact, isCompact = _e === void 0 ? false : _e, _f = _a.hasTabs, hasTabs = _f === void 0 ? false : _f, _g = _a.canReplaceNewlines, canReplaceNewlines = _g === void 0 ? false : _g, className = _a.className, onTableCreate = _a.onTableCreate;
     var adjustColumnWidths = !isCompact;
-    var preRef = require$$0.useRef(null);
-    var markdownSyntax = require$$0.useMemo(function () {
-        if (data === null) {
+    var preElementRef = require$$0.useRef(null);
+    var markdownTableSyntax = require$$0.useMemo(function () {
+        if (inputData === null) {
             return 'Error: No data provided for the table.';
         }
         try {
-            if (!Array.isArray(data) || data.length === 0) {
+            if (!Array.isArray(inputData) || inputData.length === 0) {
                 throw new MarkdownTableError("The 'data' prop must be a non-empty two-dimensional array.");
             }
             var tableData = hasHeader
                 ? {
-                    header: data[0],
-                    rows: data.slice(1),
+                    header: inputData[0],
+                    rows: inputData.slice(1),
                 }
                 : {
-                    header: generateAlphabetHeaders(data[0].length),
-                    rows: data,
+                    header: generateAlphabetHeaders(inputData[0].length),
+                    rows: inputData,
                 };
             return generateMarkdownTableString(tableData, columnAlignments, adjustColumnWidths, hasTabs, canReplaceNewlines);
         }
@@ -4208,7 +4208,7 @@ var MarkdownTable = function (_a) {
             }
         }
     }, [
-        data,
+        inputData,
         hasHeader,
         columnAlignments,
         isCompact,
@@ -4217,15 +4217,15 @@ var MarkdownTable = function (_a) {
     ]);
     require$$0.useEffect(function () {
         if (onTableCreate) {
-            onTableCreate(markdownSyntax);
+            onTableCreate(markdownTableSyntax);
         }
-    }, [markdownSyntax, onTableCreate]);
+    }, [markdownTableSyntax, onTableCreate]);
     require$$0.useEffect(function () {
-        if (preRef.current) {
-            Prism$1.highlightElement(preRef.current.querySelector('code'));
+        if (preElementRef.current) {
+            Prism$1.highlightElement(preElementRef.current.querySelector('code'));
         }
-    }, [markdownSyntax]);
-    return (jsxRuntimeExports.jsxs(jsxRuntimeExports.Fragment, { children: [jsxRuntimeExports.jsx("style", { children: prismStyles }), jsxRuntimeExports.jsx("pre", { ref: preRef, className: "".concat(className, " language-markdown line-numbers"), children: jsxRuntimeExports.jsx("code", { className: "language-markdown", role: "code", children: markdownSyntax }) })] }));
+    }, [markdownTableSyntax]);
+    return (jsxRuntimeExports.jsxs(jsxRuntimeExports.Fragment, { children: [jsxRuntimeExports.jsx("style", { children: PRISM_CSS }), jsxRuntimeExports.jsx("pre", { ref: preElementRef, className: "".concat(className, " language-markdown line-numbers"), children: jsxRuntimeExports.jsx("code", { className: "language-markdown", role: "code", children: markdownTableSyntax }) })] }));
 };
 
 exports.MarkdownTable = MarkdownTable;