Functions & Hooks

useOffscreenPdf

function useOffscreenPdf(
   path: string, 
   pages: PdfPage[], 
   metadata?: PdfMetadata): PdfExportState;

Keep a PDF on disk in step with a scene: it writes on mount and rewrites whenever path, pages or metadata change.

The declarative half of renderToPdf - a file that reflects the scene, rather than a call you make. Memoise pages, or an inline array rewrites the document every render.

Parameters

path

string

pages

PdfPage[]

metadata?

PdfMetadata

Returns

PdfExportState

On this page