Skip to content

useDocumentExport

PDF export composable for the document builder.

Import

typescript
const {
  isExporting,
  exportProgress,
  exportToPdf,
  getExportStatus,
} = useDocumentExport(projectId)

Parameters

ParameterTypeDescription
projectIdRef<string>Reactive project UUID

Return Values

PropertyTypeDescription
isExportingRef<boolean>Export in progress
exportProgressRef<number>Export progress (0-100)

Methods

MethodParametersReturnsDescription
exportToPdfoptions?: ExportOptionsPromise<string>Generate and download PDF
getExportStatusjobId: stringPromise<ExportStatus>Check export job status

Export Flow

  1. Client sends page data to POST /api/export/pdf
  2. Server renders pages and generates PDF
  3. PDF stored in Supabase Storage
  4. Client polls GET /api/export/status/[jobId] for completion
  5. Download link provided on completion

Source

app/composables/useDocumentExport.ts

Built with VitePress