react-markdown-table-ts 1.3.7 → 1.3.9

package/dist/types.d.ts

@@ -0,0 +1,122 @@
+/**
+ * @fileoverview Type definitions for the MarkdownTable component including props,
+ * alignment options, and table configuration.
+ */
+export interface InputData {
+    inputDataHeader: string[];
+    inputDataBody: readonly string[][];
+}
+export interface MarkdownTableProps {
+    /**
+     * The entire table data as a two-dimensional array.
+     * If `hasHeader` is true, the first row is treated as the header.
+     * @default null
+     */
+    inputData?: string[][] | null;
+    /**
+     * Optional array specifying the alignment for each column.
+     * Acceptable values are 'left', 'center', 'right', or 'none'.
+     * @default []
+     */
+    columnAlignments?: readonly Alignment[];
+    /**
+     * Disables column width alignment to provide a more compact markdown table string.
+     * @default false
+     */
+    isCompact?: boolean;
+    /**
+     * Optional flag to add a single space around cell content in the markdown table.
+     * When true, one space is added before and after the content in each cell.
+     * @default true
+     */
+    hasPadding?: boolean;
+    /**
+     * Optional flag to add tabs as additional padding between column pipes.
+     * When true, adds a tab character after each | and before the content.
+     * @default false
+     */
+    hasTabs?: boolean;
+    /**
+     * Indicates whether the first row of `data` is a header.
+     * @default true
+     */
+    hasHeader?: boolean;
+    /**
+     * Optional flag to replace newlines with <br> tags in table cells.
+     * @default false
+     */
+    convertLineBreaks?: boolean;
+    /**
+     * Optional theme for the Markdown table.
+     * Acceptable values are 'light' or 'dark'.
+     * @default 'light'
+     */
+    theme?: 'light' | 'dark';
+    /**
+     * Optional CSS class for styling the rendered Markdown table.
+     * This class will be applied to the <pre> element containing the table.
+     * It will be combined with built-in classes for syntax highlighting.
+     * @default undefined
+     * @example
+     * <MarkdownTable
+     *   inputData={data}
+     *   className="custom-table-style"
+     * />
+     */
+    className?: string;
+    /**
+     * Optional CSS properties to apply to the pre element containing the Markdown table.
+     * Allows direct styling of the table container using React's style prop.
+     * @default undefined
+     * @example
+     * <MarkdownTable
+     *   inputData={data}
+     *   preStyle={{
+     *     maxHeight: '300px',
+     *     overflow: 'auto',
+     *     backgroundColor: '#f5f5f5'
+     *   }}
+     * />
+     */
+    preStyle?: React.CSSProperties;
+    /**
+     * Optional callback function to receive the generated Markdown table string.
+     */
+    onGenerate?: (markdownTableString: string) => void;
+    /**
+     * Optional top padding for the pre element.
+     * @default 0
+     */
+    topPadding?: number;
+    /**
+     * Optional minimum width in pixels for the pre element containing the Markdown table.
+     * @default undefined
+     * @example
+     * <MarkdownTable
+     *   inputData={data}
+     *   minWidth={300}
+     * />
+     */
+    minWidth?: number;
+    /**
+     * Optional flag to show or hide line numbers in the Prism syntax highlighting.
+     * When true, line numbers are displayed on the left side of the code block.
+     * @default true
+     * @example
+     * <MarkdownTable
+     *   inputData={data}
+     *   showLineNumbers={false}
+     * />
+     */
+    showLineNumbers?: boolean;
+}
+export type Alignment = 'left' | 'right' | 'center' | 'none';
+export interface TableConfig {
+    columnCount: number;
+    columnAlignments: readonly Alignment[];
+    columnWidths?: readonly number[];
+    useTabs: boolean;
+    replaceNewlines: boolean;
+    hasPadding: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,SAAS;IACxB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,aAAa,EAAE,SAAS,MAAM,EAAE,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC;IAE9B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,SAAS,SAAS,EAAE,CAAC;IAExC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,CAAA;IAExB;;;;;;;;;;OAUG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IAE/B;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,mBAAmB,EAAE,MAAM,KAAK,IAAI,CAAC;IAEnD;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;;OASG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAE3B;AAED,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;AAE7D,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,SAAS,SAAS,EAAE,CAAC;IACvC,YAAY,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,EAAE,OAAO,CAAC;IACzB,UAAU,EAAE,OAAO,CAAC;CACrB"}

package/dist/utils.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @fileoverview Utility functions and classes for generating formatted markdown
+ * table strings with alignment, padding, and column width adjustments.
+ */
+import type { InputData, Alignment } from './types';
+export declare function generateMarkdownTableString(inputData: InputData, columnAlignments: readonly Alignment[], canAdjustColumnWidths?: boolean, useTabs?: boolean, replaceNewlines?: boolean, hasPadding?: boolean): string;
+export declare function generateAlphabetHeaders(columnCount: number): string[];
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAe,MAAM,SAAS,CAAC;AAmIjE,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,SAAS,EACpB,gBAAgB,EAAE,SAAS,SAAS,EAAE,EACtC,qBAAqB,UAAO,EAC5B,OAAO,UAAQ,EACf,eAAe,UAAQ,EACvB,UAAU,UAAO,GAChB,MAAM,CAsBR;AAYD,wBAAgB,uBAAuB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,CAErE"}

package/dist/validation.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @fileoverview Validation utilities and custom error class for markdown table
+ * data validation.
+ */
+/**
+ * Custom error class for handling Markdown table generation errors.
+ * Supports ES2022 error chaining via the optional `cause` property.
+ */
+export declare class MarkdownTableError extends Error {
+    constructor(message: string, options?: ErrorOptions);
+}
+/**
+ * Validates that the input data is a non-empty two-dimensional array.
+ * @param inputData - The data to validate
+ * @throws {MarkdownTableError} If validation fails
+ */
+export declare function validateInputData(inputData: unknown): void;
+//# sourceMappingURL=validation.d.ts.map

package/dist/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,qBAAa,kBAAmB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;CAKpD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI,CAQ1D"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-markdown-table-ts",
-  "version": "1.3.7",
+  "version": "1.3.9",
   "description": "A React component that converts structured data into Markdown table syntax and displays it within a `<pre>` tag.",
   "keywords": [
     "markdown",
@@ -32,7 +32,10 @@
   "files": [
     "dist"
   ],
-  "sideEffects": false,
+  "sideEffects": [
+    "src/index.tsx",
+    "**/*.css"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/keithwalsh/react-markdown-table-ts.git"
@@ -51,12 +54,16 @@
     "storybook": "storybook dev -p 6006",
     "build-storybook": "storybook build"
   },
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0"
+  },
   "dependencies": {
-    "prismjs": "^1.30.0",
-    "react": "^18.3.1",
-    "react-dom": "^18.3.1"
+    "prismjs": "^1.30.0"
   },
   "devDependencies": {
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
     "@storybook/react-vite": "^9.1.10",
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "^16.3.0",