@ibrahimrahmani/react-export-excel/types/index.d.ts

A tool to export dataset from react to excel format.

/* index.d.ts (C) react-data-export */

// TypeScript Version: 2.2

export interface ExcelFileProps {
    filename?: string;
    fileExtension?: string;
    element?: any; //Download Element
    children?: Array<ExcelSheetProps>;
}

export interface ExcelSheetProps {
    name: string;
    data?: Array<object>;
    dataSet?: Array<ExcelSheetData>;
    value?: Array<string> | Function;
    children?: Array<ExcelColumnProps>
}

export interface ExcelSheetData {
    xSteps?: number;
    ySteps?: number;
    columns: Array<string>;
    data: Array<ExcelCellData>;
}

export type ExcelCellData = ExcelValue | ExcelCell;
export type ExcelValue = string | number | Date | boolean;

export interface ExcelCell {
    value: ExcelCell;
    style: ExcelStyle;
}

export interface ExcelColumnProps {
    label: string;
    value: number | boolean | string | Function;
}

export interface ExcelStyle {
    fill?: ExcelCellFillType;
    font?: ExcelFont;
    numFmt?: ExcelNumFormat;
    alignment?: ExcelAlignment;
    border?: ExcelBorder;
}

/* ExcelCell Fill Type */
export type ExcelCellPatternType = "solid" | "none";

export interface ExcelColorSpec {
    auto?: number; //default 1
    rgb?: string; //hex ARGB color
    theme?: ExcelTheme;
    indexed?: number;
}

export interface ExcelTheme {
    theme: string;
    tint: string;
}

export interface ExcelCellFillType {
    patternType?: ExcelCellPatternType;
    fgColor?: ExcelColorSpec;
    bgColor?: ExcelColorSpec;
}

/* Excel Font */
export interface ExcelFont {
    name?: string;          // default `"Calibri"`
    sz?: number;             //font size in points default 11
    color?: ExcelColorSpec;
    bold?: boolean;
    underline?: boolean;
    italic?: boolean;
    strike?: boolean;
    outline?: boolean;
    shadow?: boolean;
    vertAlign?: boolean;
}

/* ExcelNumFormat */
export type ExcelNumFormat = "0" | "0.00%" | "0.0%" | "0.00%;\\(0.00%\\);\\-;@" | "m/dd/yy" | string;

/* ExcelAlignment */
export interface ExcelAlignment {
    vertical?: ExcelAlignmentType;
    horizontal?: ExcelAlignmentType;
    wrapText?: boolean;
    readingOrder?: ExcelReadingOrder;
    textRotation?: ExcelTextRotation;
}

export type ExcelTextRotation = 0 | 45 | 90 | 135 | 180 | 255;

export enum ExcelReadingOrder { LeftToRight = 1, RightToLeft}

export type ExcelAlignmentType = "bottom" | "center" | "top";

/* ExcelBorder */
export interface ExcelBorder {
    style: ExcelBorderStyle;
    color: ExcelColorSpec;
}

export type ExcelBorderStyle =
    "thin"
    | "medium"
    | "thick"
    | "dotted"
    | "hair"
    | "dashed"
    | "mediumDashed"
    | "dashDot"
    | "mediumDashDot"
    | "dashDotDot"
    | "mediumDashDotDot"
    | "slantDashDot";