react-pdf-highlighter-plus

Interface PdfLoaderProps

The props type for PdfLoader.

interface PdfLoaderProps {
    document: string | URL | TypedArray | DocumentInitParameters;
    workerSrc?: string;
    beforeLoad?(progress): ReactNode;
    children(pdfDocument): ReactNode;
    errorMessage?(error): ReactNode;
    onError?(error): void;
}

Properties

document workerSrc?

Methods

beforeLoad? children errorMessage? onError?

Properties

document

document: string | URL | TypedArray | DocumentInitParameters

The document to be loaded by PDF.js. If you need to pass HTTP headers, auth parameters, or other pdf settings, do it through here.

Optional workerSrc

workerSrc?: string

Optional PDF.js worker source override. By default, PdfLoader resolves the worker from the installed pdfjs-dist package so bundlers can emit it locally.

Methods

Optional beforeLoad

  • beforeLoad(progress): ReactNode

  • Callback to render content before the PDF document is loaded.

    Parameters

    • progress: OnProgressParameters

      PDF.js progress status.

    Returns ReactNode

    • Component to be rendered in space of the PDF document while loading.

children

  • children(pdfDocument): ReactNode

  • Child components to use/render the loaded PDF document.

    Parameters

    • pdfDocument: PDFDocumentProxy

      The loaded PDF document.

    Returns ReactNode

    • Component to render once PDF document is loaded.

Optional errorMessage

  • errorMessage(error): ReactNode

  • Component to render in the case of any PDF loading errors.

    Parameters

    • error: Error

      PDF loading error.

    Returns ReactNode

    • Component to be rendered in space of the PDF document.

Optional onError

  • onError(error): void

  • Callback triggered whenever an error occurs.

    Parameters

    • error: Error

      PDF Loading error triggering the event.

    Returns void

    • Component to be rendered in space of the PDF document.