react-markdown-table-ts 1.2.2 → 1.3.0

package/dist/types.d.ts

@@ -1,144 +0,0 @@
-/// <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 CellData[];
-/**
- * Represents the structure of a Markdown table.
- */
-export interface InputData {
-    inputDataHeader: CellData[];
-    inputDataBody: readonly CellData[][];
-}
-/**
- * Props for the MarkdownTable component.
- */
-export interface MarkdownTableProps {
-    /**
-     * 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?: CellData[][] | 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;
-}
-/**
- * Represents the alignment options for table columns.
- */
-export type Alignment = "left" | "right" | "center" | "none" | "justify";
-/**
- * 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;
-    justify: (width: number) => string;
-}

package/dist/utils.d.ts

@@ -1,10 +0,0 @@
-/**
- * @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: CellData): CellData;
-export declare function getColumnName(index: number): string;
-export declare function generateAlphabetHeaders(columnCount: number): string[];

package/dist/validation.d.ts

@@ -1,19 +0,0 @@
-import { MarkdownTableProps } from "./types";
-/**
- * Custom error class for handling Markdown table generation errors.
- */
-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.
- * @param markdownTableProps - The props to validate.
- */
-export declare function validateMarkdownTableProps(markdownTableProps: MarkdownTableProps): void;