Skip to content
React PDF Viewer

Search

PdfDocumentStatus reference

Lifecycle status of a document load: idle without a source, loading, ready with a document, or error with a PdfViewerError.

Used by

Import

import type { PdfDocumentStatus } from '@kingtech/react-pdf-viewer';

Signature: type PdfDocumentStatus = 'idle' | 'loading' | 'ready' | 'error'

Properties

NameTypeDefaultRequiredDescription
idle'idle'—NoNo source, or an HTTP error that onHttpError handled.
loading'loading'—NoFetching or parsing the document.
ready'ready'—NoThe document is loaded and pages can render.
error'error'—NoLoading failed; the error is available.

Source

packages/react-pdf-viewer/src/types.ts

Generated from content/react-pdf-viewer/reference/pdf-document-status.schema.json. Do not edit by hand.