react-markdown-table-ts 1.1.9 → 1.2.1

package/dist/types.d.ts

@@ -1,25 +1,36 @@
 /// <reference types="react" />
+/**
+ * Represents a single cell's data in the table.
+ */
+export interface CellData {
+    content: string;
+    alignment?: "left" | "center" | "right" | "inherit" | "justify";
+    bold?: boolean;
+    italic?: boolean;
+    code?: boolean;
+    link?: string;
+}
 /**
  * Represents a single row in a table, consisting of cells.
  */
-export type TableRow = readonly string[];
+export type TableRow = readonly CellData[];
 /**
  * Represents the structure of a Markdown table.
  */
 export interface InputData {
-    inputDataHeader: string[];
-    inputDataBody: readonly string[][];
+    inputDataHeader: CellData[];
+    inputDataBody: readonly CellData[][];
 }
 /**
  * Props for the MarkdownTable component.
  */
 export interface MarkdownTableProps {
     /**
-     * The entire table data as a two-dimensional array.
+     * The entire table data as a two-dimensional array of CellData objects.
      * If `hasHeader` is true, the first row is treated as the header.
      * @default null
      */
-    inputData?: string[][] | null;
+    inputData?: CellData[][] | null;
     /**
      * Optional array specifying the alignment for each column.
      * Acceptable values are 'left', 'center', 'right', or 'none'.
@@ -58,7 +69,7 @@ export interface MarkdownTableProps {
      * Acceptable values are 'light' or 'dark'.
      * @default 'light'
      */
-    theme?: 'light' | 'dark';
+    theme?: "light" | "dark";
     /**
      * Optional CSS class for styling the rendered Markdown table.
      * This class will be applied to the <pre> element containing the table.
@@ -109,7 +120,7 @@ export interface MarkdownTableProps {
 /**
  * Represents the alignment options for table columns.
  */
-export type Alignment = 'left' | 'right' | 'center' | 'none' | 'justify';
+export type Alignment = "left" | "right" | "center" | "none" | "justify";
 /**
  * Configuration for table formatting.
  */

package/dist/utils.d.ts

@@ -1,8 +1,10 @@
-import { TableRow, InputData, Alignment } from './types';
-export declare function calculateColumnWidths(tableRows: readonly TableRow[], maxColumnCount: number): number[];
+/**
+ * @fileoverview Utilities for formatting and generating markdown tables with support
+ * for cell formatting, alignment, and width calculations.
+ */
+import { TableRow, InputData, Alignment, TableConfig, CellData } from "./types";
+export declare function calculateColumnWidths(tableRows: readonly TableRow[], maxColumnCount: number, config: TableConfig): number[];
 export declare function generateMarkdownTableString(inputData: InputData, columnAlignments: readonly Alignment[], canAdjustColumnWidths?: boolean, useTabs?: boolean, replaceNewlines?: boolean, hasPadding?: boolean): string;
-export declare function replaceNewlinesInCell(cell: string): string;
+export declare function replaceNewlinesInCell(cell: CellData): CellData;
 export declare function getColumnName(index: number): string;
 export declare function generateAlphabetHeaders(columnCount: number): string[];
-export declare function formatMarkdownRow(columnCount: number, currentRow: TableRow, columnAlignments: readonly Alignment[], columnWidths?: readonly number[], useTabs?: boolean, canReplaceNewlines?: boolean, hasPadding?: boolean): string;
-export declare function formatAlignmentRow(columnCount: number, columnAlignments: readonly Alignment[], columnWidths?: readonly number[], useTabs?: boolean, hasPadding?: boolean): string;

package/dist/validation.d.ts

@@ -1,4 +1,4 @@
-import { MarkdownTableProps } from './types';
+import { MarkdownTableProps } from "./types";
 /**
  * Custom error class for handling Markdown table generation errors.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-markdown-table-ts",
-  "version": "1.1.9",
+  "version": "1.2.1",
   "description": "A React component that converts structured data into Markdown table syntax and displays it within a `<pre>` tag.",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",

package/dist/MarkdownTable.stories.d.ts

@@ -1,156 +0,0 @@
-/**
- * @fileoverview Storybook stories for the MarkdownTable component, demonstrating
- * various configurations and use cases for markdown table generation and display.
- */
-/// <reference types="react" />
-import type { StoryObj } from '@storybook/react';
-import { MarkdownTable } from './index';
-declare const meta: {
-    title: string;
-    component: import("react").FC<import("./types").MarkdownTableProps>;
-    parameters: {
-        layout: string;
-    };
-    tags: string[];
-    args: {
-        inputData: null;
-        columnAlignments: never[];
-        isCompact: false;
-        hasPadding: true;
-        hasTabs: false;
-        hasHeader: true;
-        convertLineBreaks: false;
-        topPadding: number;
-        theme: "light";
-    };
-    argTypes: {
-        inputData: {
-            control: {
-                type: "object";
-            };
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                };
-            };
-        };
-        columnAlignments: {
-            control: {
-                type: "object";
-            };
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                    detail: string;
-                };
-            };
-        };
-        isCompact: {
-            control: "boolean";
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                };
-            };
-        };
-        hasPadding: {
-            control: "boolean";
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                };
-            };
-        };
-        hasTabs: {
-            control: "boolean";
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                };
-            };
-        };
-        hasHeader: {
-            control: "boolean";
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                };
-            };
-        };
-        convertLineBreaks: {
-            control: "boolean";
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                };
-            };
-        };
-        topPadding: {
-            control: {
-                type: "number";
-            };
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                };
-            };
-        };
-        theme: {
-            options: string[];
-            control: {
-                type: "select";
-            };
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                };
-                defaultValue: {
-                    summary: string;
-                };
-            };
-        };
-        className: {
-            control: "text";
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                };
-            };
-        };
-        preStyle: {
-            control: {
-                type: "object";
-            };
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                };
-            };
-        };
-    };
-};
-export default meta;
-type Story = StoryObj<typeof MarkdownTable>;
-export declare const Default: Story;

package/dist/jest.setup.d.ts

@@ -1,2 +0,0 @@
-import '@testing-library/jest-dom';
-import '@testing-library/react';

package/dist/jest.setup.js

@@ -1,3 +0,0 @@
-import '@testing-library/jest-dom';
-import '@testing-library/react';
-//# sourceMappingURL=jest.setup.js.map

package/dist/jest.setup.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"jest.setup.js","sourceRoot":"","sources":["../jest.setup.ts"],"names":[],"mappings":"AAAA,OAAO,2BAA2B,CAAC;AACnC,OAAO,wBAAwB,CAAC"}

package/dist/src/MarkdownTable.stories.d.ts

@@ -1,156 +0,0 @@
-/**
- * @fileoverview Storybook stories for the MarkdownTable component, demonstrating
- * various configurations and use cases for markdown table generation and display.
- */
-/// <reference types="react" />
-import type { StoryObj } from '@storybook/react';
-import { MarkdownTable } from './index';
-declare const meta: {
-    title: string;
-    component: import("react").FC<import("./types").MarkdownTableProps>;
-    parameters: {
-        layout: string;
-    };
-    tags: string[];
-    args: {
-        inputData: null;
-        columnAlignments: never[];
-        isCompact: false;
-        hasPadding: true;
-        hasTabs: false;
-        hasHeader: true;
-        convertLineBreaks: false;
-        topPadding: number;
-        theme: "light";
-    };
-    argTypes: {
-        inputData: {
-            control: {
-                type: "object";
-            };
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                };
-            };
-        };
-        columnAlignments: {
-            control: {
-                type: "object";
-            };
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                    detail: string;
-                };
-            };
-        };
-        isCompact: {
-            control: "boolean";
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                };
-            };
-        };
-        hasPadding: {
-            control: "boolean";
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                };
-            };
-        };
-        hasTabs: {
-            control: "boolean";
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                };
-            };
-        };
-        hasHeader: {
-            control: "boolean";
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                };
-            };
-        };
-        convertLineBreaks: {
-            control: "boolean";
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                };
-            };
-        };
-        topPadding: {
-            control: {
-                type: "number";
-            };
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                };
-            };
-        };
-        theme: {
-            options: string[];
-            control: {
-                type: "select";
-            };
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                };
-                defaultValue: {
-                    summary: string;
-                };
-            };
-        };
-        className: {
-            control: "text";
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                };
-            };
-        };
-        preStyle: {
-            control: {
-                type: "object";
-            };
-            description: string;
-            table: {
-                category: string;
-                type: {
-                    summary: string;
-                };
-            };
-        };
-    };
-};
-export default meta;
-type Story = StoryObj<typeof MarkdownTable>;
-export declare const Default: Story;

package/dist/src/MarkdownTable.stories.js

@@ -1,172 +0,0 @@
-/**
- * @fileoverview Storybook stories for the MarkdownTable component, demonstrating
- * various configurations and use cases for markdown table generation and display.
- */
-import { MarkdownTable } from './index';
-var meta = {
-    title: 'Components/MarkdownTable',
-    component: MarkdownTable,
-    parameters: {
-        layout: 'centered'
-    },
-    tags: ['autodocs'],
-    args: {
-        inputData: null,
-        columnAlignments: [],
-        isCompact: false,
-        hasPadding: true,
-        hasTabs: false,
-        hasHeader: true,
-        convertLineBreaks: false,
-        topPadding: 16,
-        theme: 'light'
-    },
-    argTypes: {
-        inputData: {
-            control: {
-                type: 'object'
-            },
-            description: 'The outer array represents rows. The inner array represent cells within each row.',
-            table: {
-                category: 'Core Data Props',
-                type: {
-                    summary: 'string[][] | null'
-                }
-            }
-        },
-        columnAlignments: {
-            control: {
-                type: 'object'
-            },
-            description: 'An array specifying the alignment for each column.',
-            table: {
-                category: 'Core Data Props',
-                type: {
-                    summary: 'readonly Alignment[]',
-                    detail: 'export type Alignment = "left" | "right" | "center" | "none";'
-                }
-            }
-        },
-        isCompact: {
-            control: 'boolean',
-            description: 'Disables column width alignment to provide a more compact markdown table string.',
-            table: {
-                category: 'Configuration Props',
-                type: {
-                    summary: 'boolean'
-                }
-            }
-        },
-        hasPadding: {
-            control: 'boolean',
-            description: 'Optional flag to add a single space around cell content in the markdown table.',
-            table: {
-                category: 'Configuration Props',
-                type: {
-                    summary: 'boolean'
-                }
-            }
-        },
-        hasTabs: {
-            control: 'boolean',
-            description: 'Optional flag to add tabs as additional padding between column pipes.',
-            table: {
-                category: 'Configuration Props',
-                type: {
-                    summary: 'boolean'
-                }
-            }
-        },
-        hasHeader: {
-            control: 'boolean',
-            description: 'Indicates whether the first row of `data` is a header.',
-            table: {
-                category: 'Configuration Props',
-                type: {
-                    summary: 'boolean'
-                }
-            }
-        },
-        convertLineBreaks: {
-            control: 'boolean',
-            description: 'Optional flag to replace newlines with `<br>` tags in table cells.',
-            table: {
-                category: 'Configuration Props',
-                type: {
-                    summary: 'boolean'
-                }
-            }
-        },
-        topPadding: {
-            control: {
-                type: 'number'
-            },
-            description: 'Controls the padding-top (in pixels) of the pre element display.',
-            table: {
-                category: 'Visual/UI Props',
-                type: {
-                    summary: 'number'
-                }
-            }
-        },
-        theme: {
-            options: ['light', 'dark'],
-            control: { type: 'select' },
-            description: 'Switch between light and dark mode.',
-            table: {
-                category: 'Visual/UI Props',
-                type: {
-                    summary: "'light' | 'dark'"
-                },
-                defaultValue: { summary: 'light' }
-            }
-        },
-        className: {
-            control: 'text',
-            description: 'Optional CSS class for styling the rendered Markdown table.',
-            table: {
-                category: 'Visual/UI Props',
-                type: {
-                    summary: 'string'
-                }
-            }
-        },
-        preStyle: {
-            control: {
-                type: 'object'
-            },
-            description: 'Optional inline styles for the pre element.',
-            table: {
-                category: 'Visual/UI Props',
-                type: {
-                    summary: 'React.CSSProperties'
-                }
-            }
-        }
-    }
-};
-export default meta;
-// Move sample data before its usage
-var sampleData = [
-    ['Package ID', 'Weight (kg)', 'Status', 'Destination'],
-    ['PKG-2024-001', '12.50', 'In Transit', 'Dublin, IE'],
-    ['PKG-2024-002', '3.75', 'Delivered', 'New York, US'],
-    ['PKG-2024-003', '8.20', 'Processing', 'Frankfurt, DE'],
-    ['PKG-2024-004', '5.60', 'In Transit', 'London, GB']
-];
-export var Default = {
-    args: {
-        inputData: sampleData,
-        columnAlignments: ['left', 'right', 'center', 'none'],
-        isCompact: false,
-        hasPadding: true,
-        hasTabs: false,
-        hasHeader: true,
-        convertLineBreaks: false,
-        topPadding: 16,
-        theme: 'light',
-        className: undefined,
-        preStyle: undefined
-    }
-};
-//# sourceMappingURL=MarkdownTable.stories.js.map

package/dist/src/MarkdownTable.stories.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"MarkdownTable.stories.js","sourceRoot":"","sources":["../../src/MarkdownTable.stories.tsx"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAEvC,IAAM,IAAI,GAAG;IACX,KAAK,EAAE,0BAA0B;IACjC,SAAS,EAAE,aAAa;IACxB,UAAU,EAAE;QACV,MAAM,EAAE,UAAU;KACnB;IACD,IAAI,EAAE,CAAC,UAAU,CAAC;IAClB,IAAI,EAAE;QACJ,SAAS,EAAE,IAAI;QACf,gBAAgB,EAAE,EAAE;QACpB,SAAS,EAAE,KAAK;QAChB,UAAU,EAAE,IAAI;QAChB,OAAO,EAAE,KAAK;QACd,SAAS,EAAE,IAAI;QACf,iBAAiB,EAAE,KAAK;QACxB,UAAU,EAAE,EAAE;QACd,KAAK,EAAE,OAAgB;KACxB;IACD,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;aACf;YACD,WAAW,EAAE,mFAAmF;YAChG,KAAK,EAAE;gBACL,QAAQ,EAAE,iBAAiB;gBAC3B,IAAI,EAAE;oBACJ,OAAO,EAAE,mBAAmB;iBAC7B;aACF;SACF;QACD,gBAAgB,EAAE;YAChB,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;aACf;YACD,WAAW,EAAE,oDAAoD;YACjE,KAAK,EAAE;gBACL,QAAQ,EAAE,iBAAiB;gBAC3B,IAAI,EAAE;oBACJ,OAAO,EAAE,sBAAsB;oBAC/B,MAAM,EAAE,+DAA+D;iBACxE;aACF;SACF;QACD,SAAS,EAAE;YACT,OAAO,EAAE,SAAS;YAClB,WAAW,EAAE,kFAAkF;YAC/F,KAAK,EAAE;gBACL,QAAQ,EAAE,qBAAqB;gBAC/B,IAAI,EAAE;oBACJ,OAAO,EAAE,SAAS;iBACnB;aACF;SACF;QACD,UAAU,EAAE;YACV,OAAO,EAAE,SAAS;YAClB,WAAW,EAAE,gFAAgF;YAC7F,KAAK,EAAE;gBACL,QAAQ,EAAE,qBAAqB;gBAC/B,IAAI,EAAE;oBACJ,OAAO,EAAE,SAAS;iBACnB;aACF;SACF;QACD,OAAO,EAAE;YACP,OAAO,EAAE,SAAS;YAClB,WAAW,EAAE,uEAAuE;YACpF,KAAK,EAAE;gBACL,QAAQ,EAAE,qBAAqB;gBAC/B,IAAI,EAAE;oBACJ,OAAO,EAAE,SAAS;iBACnB;aACF;SACF;QACD,SAAS,EAAE;YACT,OAAO,EAAE,SAAS;YAClB,WAAW,EAAE,wDAAwD;YACrE,KAAK,EAAE;gBACL,QAAQ,EAAE,qBAAqB;gBAC/B,IAAI,EAAE;oBACJ,OAAO,EAAE,SAAS;iBACnB;aACF;SACF;QACD,iBAAiB,EAAE;YACjB,OAAO,EAAE,SAAS;YAClB,WAAW,EAAE,oEAAoE;YACjF,KAAK,EAAE;gBACL,QAAQ,EAAE,qBAAqB;gBAC/B,IAAI,EAAE;oBACJ,OAAO,EAAE,SAAS;iBACnB;aACF;SACF;QACD,UAAU,EAAE;YACV,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;aACf;YACD,WAAW,EAAE,kEAAkE;YAC/E,KAAK,EAAE;gBACL,QAAQ,EAAE,iBAAiB;gBAC3B,IAAI,EAAE;oBACJ,OAAO,EAAE,QAAQ;iBAClB;aACF;SACF;QACD,KAAK,EAAE;YACL,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC;YAC1B,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC3B,WAAW,EAAE,qCAAqC;YAClD,KAAK,EAAE;gBACL,QAAQ,EAAE,iBAAiB;gBAC3B,IAAI,EAAE;oBACJ,OAAO,EAAE,kBAAkB;iBAC5B;gBACD,YAAY,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE;aACnC;SACF;QACD,SAAS,EAAE;YACT,OAAO,EAAE,MAAM;YACf,WAAW,EAAE,6DAA6D;YAC1E,KAAK,EAAE;gBACL,QAAQ,EAAE,iBAAiB;gBAC3B,IAAI,EAAE;oBACJ,OAAO,EAAE,QAAQ;iBAClB;aACF;SACF;QACD,QAAQ,EAAE;YACR,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;aACf;YACD,WAAW,EAAE,6CAA6C;YAC1D,KAAK,EAAE;gBACL,QAAQ,EAAE,iBAAiB;gBAC3B,IAAI,EAAE;oBACJ,OAAO,EAAE,qBAAqB;iBAC/B;aACF;SACF;KACF;CACmC,CAAA;AAEtC,eAAe,IAAI,CAAA;AAGnB,oCAAoC;AACpC,IAAM,UAAU,GAAG;IACjB,CAAC,YAAY,EAAE,aAAa,EAAE,QAAQ,EAAE,aAAa,CAAC;IACtD,CAAC,cAAc,EAAE,OAAO,EAAE,YAAY,EAAE,YAAY,CAAC;IACrD,CAAC,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,cAAc,CAAC;IACrD,CAAC,cAAc,EAAE,MAAM,EAAE,YAAY,EAAE,eAAe,CAAC;IACvD,CAAC,cAAc,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC;CACrD,CAAA;AAED,MAAM,CAAC,IAAM,OAAO,GAAU;IAC5B,IAAI,EAAE;QACJ,SAAS,EAAE,UAAU;QACrB,gBAAgB,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC;QACrD,SAAS,EAAE,KAAK;QAChB,UAAU,EAAE,IAAI;QAChB,OAAO,EAAE,KAAK;QACd,SAAS,EAAE,IAAI;QACf,iBAAiB,EAAE,KAAK;QACxB,UAAU,EAAE,EAAE;QACd,KAAK,EAAE,OAAO;QACd,SAAS,EAAE,SAAS;QACpB,QAAQ,EAAE,SAAS;KACpB;CACF,CAAA"}

package/dist/src/index.d.ts

@@ -1,5 +0,0 @@
-/// <reference types="react" />
-import 'prismjs/components/prism-markdown';
-import 'prismjs/plugins/line-numbers/prism-line-numbers';
-import { MarkdownTableProps } from './types';
-export declare const MarkdownTable: React.FC<MarkdownTableProps>;