시작하기

1. 플러그인 설치

   npm

   npm i @capgo/capacitor-document-scanner

   pnpm

   pnpm add @capgo/capacitor-document-scanner

   yarn

   yarn add @capgo/capacitor-document-scanner

   bun

   bun add @capgo/capacitor-document-scanner

2. 네이티브 플랫폼 동기화

   npm

   npx cap sync

   pnpm

   pnpm cap sync

   yarn

   yarn cap sync

   bun

   bunx cap sync

스캔 실행

import {
  DocumentScanner,
  ResponseType,
  ScanDocumentResponseStatus,
} from '@capgo/capacitor-document-scanner';

const result = await DocumentScanner.scanDocument({
  croppedImageQuality: 90,
  letUserAdjustCrop: true,
  maxNumDocuments: 10,
  responseType: ResponseType.ImageFilePath,
});

if (result.status === ScanDocumentResponseStatus.Success) {
  console.log('스캔된 파일:', result.scannedImages);
} else {
  console.log('사용자가 스캔을 취소했습니다');
}

base64 데이터 반환

const result = await DocumentScanner.scanDocument({
  responseType: ResponseType.Base64,
});

const [firstPage] = result.scannedImages ?? [];
if (firstPage) {
  const dataUrl = `data:image/jpeg;base64,${firstPage}`;
  // 미리보기 표시 또는 서버에 업로드
}

플랫폼 요구사항

• iOS: ios/App/App/Info.plist에 카메라 사용 방법을 설명하는 NSCameraUsageDescription을 추가합니다.
• Android: CAMERA 권한이 선언되어 있는지 확인하고(Capacitor가 자동으로 추가) UI에 맞게 croppedImageQuality, letUserAdjustCrop 및 maxNumDocuments를 조정합니다.
• 저장소: ResponseType.ImageFilePath를 사용할 때 앱 세션이 종료되기 전에 스캔된 파일을 원하는 저장 위치로 이동하거나 복사합니다.