Skip to content

Scanner Flow

DocumentScannerFlow provides a route-driven scan experience:

  • scan: capture photo with live contour overlay.
  • edit: adjust crop points and apply filter previews.
  • share: preview processed output and share it.
  • ocr: run OCR on processed image.
import { DocumentScannerFlow } from '@korsolutions/vision';
export function ScannerScreen() {
return <DocumentScannerFlow initialRoute="scan" />;
}

The flow uses an internal route stack and a navigation manager exported as:

  • ScannerNavigationProvider
  • useScannerNavigation
  • ScannerRoute

Route reset behavior:

  • Navigating to scan resets the stack to ['scan'].

Session state is managed in ScannerProvider and exposed via useScannerContext.

Key state values:

  • capturedImage
  • cropPoints
  • selectedFilter
  • editPreviewUri
  • processedImageUri
  • isFilterProcessing
  • isFinalizing
  • processingError

Key actions:

  • startSession(...)
  • setCropPoints(...)
  • setSelectedFilter(...)
  • finalizeDocument()
  • resetSession()