Vanilla API Reference

function create(container: HTMLElement, options?: VerifyKitOptions): VerifyKitInstance

<script src="https://verifykit.trexolab.com/cdn/verifykit.umd.js"></script>
<script>
  const viewer = VerifyKit.create(document.getElementById('viewer'), {
    workerUrl: 'https://unpkg.com/pdfjs-dist@5.5.207/legacy/build/pdf.worker.min.mjs',
    theme: { mode: 'system' },
    features: { signatures: true, download: true },
  })
 
  viewer.load('/document.pdf')
</script>

import { create } from '@trexolab/verifykit-vanilla'
import '@trexolab/verifykit-vanilla/verifykit.css'
 
const viewer = create(document.getElementById('viewer'), {
  workerUrl: 'https://unpkg.com/pdfjs-dist@5.5.207/legacy/build/pdf.worker.min.mjs',
  theme: { mode: 'system' },
})
 
const result = await viewer.load(pdfArrayBuffer, 'report.pdf')
console.log('Signatures:', result.signatures.length)

interface VerifyKitOptions {
  workerUrl: string             // REQUIRED. URL to the PDF.js worker script.
  theme?: { mode?: 'light' | 'dark' | 'system'; overrides?: Record<string, string> }
  features?: VerifyKitFeatures
  trustStore?: TrustStoreConfig
  plugins?: VerifyKitPlugin[]
  locale?: string
  translations?: Partial<TranslationStrings>
  onVerified?: (result: VerificationResult) => void
  onError?: (error: LoadError) => void
  onDocumentLoaded?: (info: { pageCount: number; fileName: string }) => void
  onPageChange?: (page: number) => void
  onZoomChange?: (scale: number) => void
  onThemeChange?: (mode: 'light' | 'dark') => void
}

interface VerifyKitFeatures {
  search?: boolean       // default: true
  print?: boolean        // default: true
  download?: boolean     // default: false
  signatures?: boolean   // default: true
  thumbnails?: boolean   // default: true
  fullscreen?: boolean   // default: true
  themeToggle?: boolean  // default: true
  openFile?: boolean     // default: false
  rotation?: boolean     // default: true
  contextMenu?: boolean  // default: true
  properties?: boolean   // default: true
  shortcuts?: boolean    // default: true
  highlights?: boolean   // default: true
  accessibility?: boolean  // default: true
}

load(input: PdfInput, fileName?: string): Promise<VerificationResult>

const result = await viewer.load(buffer, 'contract.pdf')
console.log(result.signatures[0].overallStatus) // "valid"

destroy(): void

setTheme(mode: 'light' | 'dark' | 'system'): void

goToPage(page: number): void

goToPreviousPage(): void

goToNextPage(): void

goToFirstPage(): void

goToLastPage(): void

getCurrentPage(): number

getPageCount(): number

zoomIn(): void

zoomOut(): void

zoomTo(scale: number): void

setFitMode(mode: 'none' | 'width' | 'page'): void

getZoom(): number

rotateCW(): void

rotateCCW(): void

getRotation(): number

openSearch(): void

closeSearch(): void

print(): void

download(): void

enterFullscreen(): void

exitFullscreen(): void

toggleFullscreen(): void

openSignaturePanel(): void

closeSignaturePanel(): void

setFontScale(scale: 'compact' | 'default' | 'large' | 'extra-large'): void

getFontScale(): 'compact' | 'default' | 'large' | 'extra-large'

revalidate(): Promise<VerificationResult | null>

const updated = await viewer.revalidate()
if (updated) {
  console.log('Re-verified:', updated.signatures.length, 'signatures')
}

on(event: string, handler: (...args: unknown[]) => void): () => void

const unsub = viewer.on('pageChange', (page) => {
  console.log('Current page:', page)
})
 
viewer.on('verified', (result) => {
  console.log('Signatures:', result.signatures.length)
})
 
// Unsubscribe
unsub()

getVerificationResult(): VerificationResult | null

getSignatures(): PdfSignature[]

const viewer = VerifyKit.create(el, {
  workerUrl: 'https://unpkg.com/pdfjs-dist@5.5.207/legacy/build/pdf.worker.min.mjs',
  onVerified: (result) => {
    for (const sig of result.signatures) {
      console.log(`${sig.name}: ${sig.overallStatus}`)
    }
  },
  onError: (error) => console.error('Verification error:', error),
  onPageChange: (page) => updatePageIndicator(page),
})

interface LoadError {
  name: LoadErrorName
  message: string
}
 
type LoadErrorName =
  | 'InvalidPDFException'
  | 'MissingPDFException'
  | 'UnexpectedResponseException'
  | 'PasswordException'
  | 'AbortException'
  | 'FormatError'
  | 'NetworkError'
  | 'UnsupportedInputError'
  | 'VerificationError'
  | 'UnknownErrorException'

const viewer = VerifyKit.create(el, {
  workerUrl: 'https://unpkg.com/pdfjs-dist@5.5.207/legacy/build/pdf.worker.min.mjs',
  onError: (error) => {
    console.error(`[${error.name}] ${error.message}`)
    // error.name is one of the LoadErrorName values
  },
})

const viewer = VerifyKit.create(document.getElementById('viewer'), {
  workerUrl: 'https://unpkg.com/pdfjs-dist@5.5.207/legacy/build/pdf.worker.min.mjs',
  theme: { mode: 'system' },
  features: { download: true, openFile: true },
})
 
// Load a document
await viewer.load(buffer, 'doc.pdf')
 
// Navigate
viewer.goToPage(5)
viewer.goToNextPage()
console.log('Page:', viewer.getCurrentPage(), '/', viewer.getPageCount())
 
// Zoom
viewer.zoomIn()
viewer.zoomTo(2.0)
viewer.setFitMode('width')
console.log('Zoom:', viewer.getZoom())
 
// Rotate
viewer.rotateCW()
console.log('Rotation:', viewer.getRotation())
 
// Search, print, download
viewer.openSearch()
viewer.print()
viewer.download()
 
// Fullscreen
viewer.toggleFullscreen()
 
// Signatures
viewer.openSignaturePanel()
console.log('Signatures:', viewer.getSignatures())
console.log('Result:', viewer.getVerificationResult())
 
// Re-verify signatures
const updated = await viewer.revalidate()
 
// Clean up
viewer.destroy()