react-markdown-table-ts 0.6.3 → 1.1.0

package/dist/types.d.ts

@@ -20,57 +20,98 @@ export interface MarkdownTableProps {
      * @default null
      */
     inputData?: string[][] | null;
-    /**
-     * Indicates whether the first row of `data` is a header.
-     * @default true
-     */
-    hasHeader?: boolean;
     /**
      * Optional array specifying the alignment for each column.
      * Acceptable values are 'left', 'center', 'right', or 'none'.
+     * @default []
      */
-    columnAlignments?: readonly ('left' | 'center' | 'right' | 'none')[];
+    columnAlignments?: readonly Alignment[];
     /**
-     * Optional flag to provide a compact version of the table with minimal column widths.
-     * When `true`, column widths are not adjusted based on content.
+     * Disables column width alignment to provide a more compact markdown table string.
      * @default false
      */
     isCompact?: boolean;
     /**
-     * Optional flag to add tabs between columns in the Markdown table.
+     * 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;
     /**
-     * Optional CSS class for styling the rendered Markdown table.
+     * Indicates whether the first row of `data` is a header.
+     * @default true
      */
-    className?: string;
+    hasHeader?: boolean;
     /**
      * Optional flag to replace newlines with <br> tags in table cells.
      * @default false
      */
-    canReplaceNewlines?: boolean;
-    /**
-     * Optional callback function to receive the generated Markdown table string.
-     */
-    onTableCreate?: (markdownTableString: string) => void;
+    convertLineBreaks?: boolean;
     /**
      * Optional theme for the Markdown table.
      * Acceptable values are 'light' or 'dark'.
+     * @default 'light'
      */
     theme?: 'light' | 'dark';
     /**
-     * Optional flag to add padding spaces around cell content.
-     * @default true
+     * 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"
+     * />
      */
-    hasPadding?: boolean;
+    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 flag to show the copy button.
-     * @default false
+     * Optional callback function to receive the generated Markdown table string.
      */
-    showCopyButton?: boolean;
+    onGenerate?: (markdownTableString: string) => void;
+}
+/**
+ * Represents the alignment options for table columns.
+ */
+export type Alignment = 'left' | 'right' | 'center' | 'none';
+/**
+ * Configuration for table formatting.
+ */
+export interface TableConfig {
+    columnCount: number;
+    columnAlignments: readonly Alignment[];
+    columnWidths?: readonly number[];
+    useTabs: boolean;
+    replaceNewlines: boolean;
+    hasPadding: boolean;
+}
+/**
+ * Functions to generate alignment indicators for table columns.
+ */
+export interface AlignmentIndicator {
+    left: (width: number) => string;
+    right: (width: number) => string;
+    center: (width: number) => string;
+    none: (width: number) => string;
 }

package/dist/utils.d.ts

@@ -1,32 +1,8 @@
-import { TableRow, InputData } from './types';
-/**
- * Calculates the maximum width for each column based on the content.
- * @param tableRows - All rows (header and body) of the table.
- * @param maxColumnCount - The maximum number of columns in the table.
- * @returns An array of maximum widths for each column.
- */
+import { TableRow, InputData, Alignment } from './types';
 export declare function calculateColumnWidths(tableRows: readonly TableRow[], maxColumnCount: number): number[];
-type Alignment = 'left' | 'right' | 'center' | 'none';
-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 ('left' | 'right' | 'center' | 'none')[], columnWidths?: readonly number[], useTabs?: boolean, hasPadding?: boolean): string;
-export declare function generateMarkdownTableString(inputData: InputData, columnAlignments: readonly ('left' | 'right' | 'center' | 'none')[], canAdjustColumnWidths?: boolean, useTabs?: boolean, replaceNewlines?: boolean, hasPadding?: boolean): string;
-/**
- * Replaces newline characters in a string with <br> tags.
- * @param cell - The cell content to process.
- * @returns The processed cell content with newlines replaced.
- */
+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;
-/**
- * Converts a zero-based column index to its corresponding Excel-style column name.
- * For example, 0 -> 'A', 1 -> 'B', ..., 25 -> 'Z', 26 -> 'AA', etc.
- * @param index - The zero-based column index.
- * @returns The corresponding column name.
- */
 export declare function getColumnName(index: number): string;
-/**
- * Generates an array of alphabetic headers based on the specified column count.
- * @param columnCount - The number of columns.
- * @returns An array of column header names.
- */
 export declare function generateAlphabetHeaders(columnCount: number): string[];
-export {};
+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

@@ -5,6 +5,12 @@ import { MarkdownTableProps } from './types';
 export declare class MarkdownTableError extends Error {
     constructor(message: string);
 }
+/**
+ * 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;
 /**
  * Validates the structure of the table data based on the `hasHeader` flag.
  * Throws an error if validation fails.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-markdown-table-ts",
-  "version": "0.6.3",
+  "version": "1.1.0",
   "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",
@@ -72,8 +72,6 @@
   "dependencies": {
     "@emotion/react": "^11.13.5",
     "@emotion/styled": "^11.13.5",
-    "@mui/icons-material": "^6.1.8",
-    "@mui/material": "^6.1.8",
     "prismjs": "^1.29.0"
   }
 }