react-to-pdf/dist/index.d.ts

Create PDF documents from React Components

import { MutableRefObject } from 'react';
import jsPDF, { jsPDFOptions } from 'jspdf';
import { Options as Options$1 } from 'html2canvas';

declare enum Resolution {
    LOW = 1,
    NORMAL = 2,
    MEDIUM = 3,
    HIGH = 7,
    EXTREME = 12
}
declare enum Margin {
    NONE = 0,
    SMALL = 5,
    MEDIUM = 10,
    LARGE = 25
}

type DetailedMargin = {
    top: Margin | number;
    right: Margin | number;
    bottom: Margin | number;
    left: Margin | number;
};
type PageConversionOptions = {
    /** Margin of the page in MM, defaults to 0. */
    margin: DetailedMargin | Margin | number;
    /** Format of the page (A4, letter), defaults to A4. */
    format: jsPDFOptions["format"];
    /** Orientation of the page (portrait or landscape), defaults to `portrait`. */
    orientation: jsPDFOptions["orientation"];
};
type CanvasConversionOptions = Pick<Options$1, "useCORS" | "logging"> & {
    /**
     * Mime type of the canvas captured from the screenshot, defaults to
     * 'image/jpeg' for better size performance.
     * See: https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toDataURL
     */
    mimeType: "image/jpeg" | "image/png";
    /**
     * Quality ratio of the canvas captured from the screenshot
     * See: https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toDataURL
     */
    qualityRatio: number;
};
type ConversionOptions = {
    /**
     * File name of the PDF file if the method select is `save`, which is the
     * default. Not used for the `build` and `open` methods. *
     */
    filename?: string;
    /**
     * Method that will follow to do with the PDF file. The `build` method just
     * returns the PDF instance in the invoked function `generatePDF` or `toPDF`.
     * By default is `open`.
     */
    method: "save" | "open" | "build";
    /**
     * Resolution in a scale where 1 gives a low resolution and possible blurred
     * image, 3 a medium and 10 an extreme quality. The size of the file increases
     * as the resolution is higher. Not recommended to use extreme resolution, e.g
     * '>= 10' for multiple pages otherwise this can make the browser cache hang
     * or crash, due to the size of the image generated for the PDF.
     */
    resolution: Resolution | number;
    /** Page options */
    page: PageConversionOptions;
    /** Canvas options */
    canvas: CanvasConversionOptions;
    /** Override values passed for the jsPDF document and html2canvas */
    overrides: {
        /**
         * Override the values passed for the jsPDF instance. See its docs for more details
         * in https://artskydj.github.io/jsPDF/docs/jsPDF.html.
         * */
        pdf?: Partial<jsPDFOptions>;
        /**
         * Override the values passed for the html2canvas function. See its docs
         * for more details in https://html2canvas.hertzen.com/documentation
         * */
        canvas?: Partial<Options$1>;
    };
};
type Options = Omit<Partial<ConversionOptions>, "page" | "canvas" | "overrides"> & {
    page?: Partial<PageConversionOptions>;
    canvas?: Partial<CanvasConversionOptions>;
    overrides?: Partial<ConversionOptions["overrides"]>;
};
type UsePDFResult = {
    /**
     * React ref of the target element
     */
    targetRef: MutableRefObject<any>;
    /**
     * Generates the pdf
     */
    toPDF: (options?: Options) => void;
};
type TargetElementFinder = MutableRefObject<any> | (() => HTMLElement | null);

declare const usePDF: (usePDFoptions?: Options) => UsePDFResult;
declare const generatePDF: (targetRefOrFunction: TargetElementFinder, customOptions?: Options) => Promise<InstanceType<typeof jsPDF>>;

export { Margin, Resolution, generatePDF as default, usePDF };
export type { Options };