내용으로 건너뛰기
Capgo - Capacitor 앱의 실시간 업데이트 Capgo

시작하기

설치

설치 제목
터미널 창
bun add @capgo/capacitor-printer
bunx cap sync

import

import 제목
import { Printer } from '@capgo/capacitor-printer';

API 개요

제목: API 개요

printBase64

제목: printBase64

base64로 인코딩된 파일을 인쇄하는 UI를 제공합니다.

플랫폼 동작:

  • iOS: UIPrintInteractionController를 사용하여 base64 디코딩된 데이터를 사용합니다.
  • Android: PrintManager를 사용하여 base64 디코딩된 데이터를 사용합니다.
  • Web: base64 데이터에서 블록을 생성하고 프린트 대화상자를 열어줍니다.

성능 경고: 대형 파일은 메모리 제한으로 인해 base64 디코딩을 통해 앱이 충돌할 수 있습니다. 5MB 이상의 파일을 사용하는 경우 printFile() 대신 사용하는 것을 권장합니다.

import { Printer } from '@capgo/capacitor-printer';


// Print a base64 encoded PDF
await Printer.printBase64({
  name: 'Invoice #12345',
  data: 'base64-encoded-pdf-data',
  mimeType: 'application/pdf',
});


// Print a base64 encoded image
await Printer.printBase64({
  name: 'Product Photo',
  data: '/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDA...',
  mimeType: 'image/jpeg',
});

printFile

printFile

프린터 장치 파일을 프린트하기 위해 프린팅 UI를 표시합니다.

플랫폼 동작:

  • iOS: 파일 URL을 사용하는 UIPrintInteractionController를 사용합니다. 앱의 문서 폴더와 상대 경로를 지원하는 file:// 경로를 사용합니다.
  • Android: PrintManager를 사용하여 파일 경로를 사용합니다. content:// URI와 file:// 경로를 모두 지원합니다.
  • Web: 파일을 읽고 프린트 대화 상자를 열어줍니다.

지원하는 파일 형식:

  • PDF 문서 (application/pdf)
  • 이미지: JPEG, PNG, GIF, HEIC, HEIF
import { Printer } from '@capgo/capacitor-printer';


// iOS: Print from app documents directory
await Printer.printFile({
  name: 'Contract',
  path: 'file:///var/mobile/Containers/Data/Application/.../Documents/contract.pdf',
});


// Android: Print from content URI
await Printer.printFile({
  name: 'Receipt',
  path: 'content://com.android.providers.downloads.documents/document/123',
  mimeType: 'application/pdf',
});


// Android: Print from file path
await Printer.printFile({
  name: 'Photo',
  path: 'file:///storage/emulated/0/Download/photo.jpg',
  mimeType: 'image/jpeg',
});

printHtml

‘printHtml’라는 제목의 섹션

HTML 문서를 인쇄하기 위한 인쇄 UI를 제공합니다.

플랫폼 동작:

  • iOS: WKWebView에서 HTML을 렌더링하고 UIPrintInteractionController를 사용하여 인쇄합니다.
  • Android: WebView에서 HTML을 렌더링하고 PrintManager를 사용하여 인쇄합니다.
  • Web: iframe에 HTML 콘텐츠를 생성하고 인쇄 대화상자를 트리거합니다.

HTML 요구 사항:

  • 완전한 HTML 문서 구조를 포함해야 합니다.
  • 인라인 CSS 스타일 또는 스타일 태그를 포함할 수 있습니다.
  • 외부 자원 (이미지, 스타일 시트)에는 절대 URL을 사용해야 합니다.
  • 인쇄 전용 CSS가 추가될 수 있습니다.
import { Printer } from '@capgo/capacitor-printer';


// Simple HTML document
await Printer.printHtml({
name: 'Sales Report',
html: '<html><body><h1>Q4 Sales Report</h1><p>Revenue: $125,000</p></body></html>',
});


// HTML with print-specific CSS
await Printer.printHtml({
name: 'Styled Invoice',
html: `
<html>
<head>
<style>

printPdf

인쇄 PDF를 위한 'printPdf' 섹션

PDF 문서를 인쇄하기 위한 인쇄 UI를 제공합니다.

플랫폼 동작:

  • iOS: PDF 파일 URL을 사용하여 UIPrintInteractionController를 사용합니다.
  • Android: PdfDocument을 사용하여 PrintManager를 사용합니다.
  • Web: 인쇄 대화 상자를 열기 위해 객체 URL을 생성합니다.

파일 경로 요구 사항:

  • iOS: __CAPGO_KEEP_0__
  • 안드로이드: __CAPGO_KEEP_0__
  • 웹: __CAPGO_KEEP_0__
import { Printer } from '@capgo/capacitor-printer';


// Print PDF from app storage
await Printer.printPdf({
  name: 'Annual Report 2024',
  path: 'file:///var/mobile/Containers/Data/Application/.../Documents/report.pdf',
});


// Print PDF from Android downloads
await Printer.printPdf({
  name: 'Downloaded Document',
  path: 'content://com.android.providers.downloads.documents/document/123',
});

printWebView

printWebView

웹 뷰 콘텐츠를 출력하기 위한 UI를 제공합니다.

앱 내의 현재 웹 뷰 콘텐츠를 출력합니다.

플랫폼 동작:

  • iOS: WKWebView의 view가 인쇄 가능할 때 UIPrintInteractionController를 사용합니다.
  • Android: WebView.createPrintDocumentAdapter()를 사용하여 PrintManager와 함께 인쇄합니다.
  • Web: 현재 페이지의 window.print()를 트리거합니다.

인쇄 스타일: 인쇄 미디어 쿼리(CSS)를 사용하여 인쇄를 커스터마이즈합니다. 웹 뷰의 현재 스타일이 적용됩니다.

import { Printer } from '@capgo/capacitor-printer';


// Print current web view with default name
await Printer.printWebView();


// Print with custom job name
await Printer.printWebView({
name: 'Dashboard Screenshot',
});


// Use with print-specific CSS in your HTML
// Add this to your app's CSS:
//

타입 참조

타イトル ‘타입 참조’

PrintBase64Options

인쇄 Base64 옵션

Base64 인코딩된 데이터를 인쇄하는 옵션입니다.

export interface PrintBase64Options extends PrintOptions {
  /**
   * Valid base64 encoded string representing the file content.
   *
   * The base64 string should NOT include the data URL prefix (e.g., "data:application/pdf;base64,").
   * Only provide the raw base64 encoded content.
   *
   * **Performance Considerations:**
   * - Base64 encoding increases data size by approximately 33%
   * - Large files (>5MB) may cause memory issues when decoding
   * - Consider using printFile() for large documents
   *
   * **Platform Notes:**
   * - **iOS**: Decoded to NSData and passed to UIPrintInteractionController
   * - **Android**: Decoded to byte array and written to temporary file
   * - **Web**: Converted to Blob for printing
   *
   * @since 7.0.0
   * @example 'base64-encoded-pdf-data'
   */
  data: string;


  /**
   * MIME type of the base64 encoded data.
   *
   * **Supported types:**
   * - `application/pdf` - PDF documents
   * - `image/jpeg` - JPEG images
   * - `image/.png` - PNG images
   * - `image/.gif` - GIF images (iOS/Android only)
   * - `image/heic` - HEIC images (iOS only)
   * - `image/heif` - HEIF images (iOS only)
   *
   * **Platform Support:**
   * - All platforms support PDF, JPEG, and PNG
   * - GIF support varies by platform
   * - HEIC/HEIF are iOS-specific formats
   *
   * @since 7.0.0
   * @example 'application/pdf'
   * @example 'image/jpeg'
   */
  mimeType: string;
}

PrintFileOptions

“파일 출력 옵션” 섹션

장치 저장소에서 파일을 출력하는 데 필요한 옵션입니다.

export interface PrintFileOptions extends PrintOptions {
  /**
   * Path to the file to print.
   *
   * **iOS Path Formats:**
   * - `file://` URL: Full file URL path
   * - Relative path: Path relative to app's documents directory
   * - Must be within app's accessible directories (documents, temporary, cache)
   *
   * **Android Path Formats:**
   * - `content://` URI: Content provider URI (recommended for external files)
   * - `file://` path: Direct file system path
   * - Must have read permission for the file
   *
   * **Common Use Cases:**
   * - App documents: Files saved in app's document directory
   * - Downloads: Files from system downloads folder (use content:// on Android)
   * - Temporary files: Files in app's temporary/cache directory
   * - Shared storage: Files from external storage (Android, requires permissions)
   *
   * @since 7.0.0
   * @platform ios Supports file:// paths and relative paths
   * @platform android Supports content:// URIs and file:// paths
   * @example 'content://com.android.providers.downloads.documents/document/123'
   * @example 'file:///var/mobile/Containers/Data/Application/.../Documents/document.pdf'
   * @example 'file:///storage/emulated/0/Download/receipt.pdf'
   */
  path: string;


  /**
   * MIME type of the file.
   *
   * **Platform Behavior:**
   * - **Android**: REQUIRED for content:// URIs. Helps the system determine how to handle the file.
   *                Optional for file:// paths (auto-detected from extension).
   * - **iOS**: Ignored. File type is auto-detected from file extension.
   * - **Web**: Optional. Auto-detected if not provided.
   *
   * **Common MIME Types:**
   * - `application/pdf` - PDF documents
   * - `image/jpeg` - JPEG images
   * - `image/.png` - PNG images
   * - `image/.gif` - GIF images
   *
   * @since 7.0.0
   * @default Undefined (auto-detected from file extension)
   * @platform android Used for content:// URIs and file type detection
   * @platform ios Ignored (auto-detected)
   * @example 'application/pdf'
   * @example 'image/jpeg'
   */
  mimeType?: string;
}

PrintHtmlOptions

“HTML 출력 옵션” 섹션

HTML 콘텐츠를 출력하는 데 필요한 옵션입니다.

export interface PrintHtmlOptions extends PrintOptions {
  /**
   * HTML content to print.
   *
   * **Content Requirements:**
   * - Should be a complete HTML document with `<html>`, `<head>`, and `<body>` tags
   * - Can include inline CSS styles or `<style>` tags
   * - External resources (images, fonts) should use absolute URLs
   * - JavaScript is not executed during print rendering
   *
   * **Print Optimization Tips:**
   * - Use `@media print` CSS rules for print-specific styling
   * - Control page breaks with `page-break-before`, `page-break-after`, `page-break-inside`
   * - Hide UI elements using `.no-print { display: none; }` class
   * - Adjust font sizes for readability (12pt is standard for print)
   * - Use print-friendly colors (avoid dark backgrounds)
   *
   * **Platform Rendering:**
   * - **iOS**: Rendered in WKWebView before printing
   * - **Android**: Rendered in WebView before printing
   * - **Web**: Rendered in hidden iframe before printing
   *
   * **Character Encoding:**
   * - UTF-8 is recommended and default
   * - Include charset in HTML: `<meta charset="UTF-8">`
   *
   * @since 7.0.0
   * @example '<html><body><h1>Hello World</h1><p>This is a test document.</p></body></html>'
   * @example
   * ```typescript
   * const htmlWithStyles = `
   *   <html>
   *     <head>
   *       <meta charset="UTF-8">
   *       <style>
   *         @media print {
   *           body { font-family: Arial, sans-serif; font-size: 12pt; }
   *           .no-print { display: none; }
   *           h1 { color: #333; page-break-before: always; }
   *         }
   *       </style>
   *     </head>
   *     <body>
   *       <h1>Invoice #12345</h1>
   *       <p>Amount: $299.99</p>
   *     </body>
   *   </html>
   * `;
   * ```
   */
  html: string;
}

PrintPdfOptions

“PDF 출력 옵션” 섹션

PDF 문서를 출력하는 데 필요한 옵션입니다.

export interface PrintPdfOptions extends PrintOptions {
  /**
   * Path to the PDF document.
   *
   * **iOS Path Formats:**
   * - `file://` URL: Full file URL path to PDF document
   * - Relative path: Path relative to app's documents directory
   * - Must be within app's accessible directories (documents, temporary, cache)
   * - PDF must be valid and not password-protected
   *
   * **Android Path Formats:**
   * - `content://` URI: Content provider URI (recommended for external PDFs)
   * - `file://` path: Direct file system path to PDF
   * - Must have read permission for the file
   * - Supports both single-page and multi-page PDFs
   *
   * **Web Path Formats:**
   * - Relative or absolute path accessible from web context
   * - Must be a valid PDF file
   *
   * **Validation:**
   * - File must exist at the specified path
   * - File must be a valid PDF (checked by magic number/header)
   * - File must be readable by the app
   *
   * **Common Sources:**
   * - App documents: PDFs saved in app's document directory
   * - Downloads: PDFs from system downloads (use content:// on Android)
   * - Generated PDFs: Temporary PDFs created by the app
   * - Network downloads: PDFs downloaded and saved locally
   *
   * @since 7.0.0
   * @platform ios Supports file:// paths and relative paths
   * @platform android Supports content:// URIs and file:// paths
   * @platform web Supports accessible file paths
   * @example 'content://com.android.providers.downloads.documents/document/123'
   * @example 'file:///var/mobile/Containers/Data/Application/.../Documents/document.pdf'
   * @example 'file:///storage/emulated/0/Download/report.pdf'
   * @example 'Documents/invoice-2024.pdf'
   */
  path: string;
}

PrintOptions

“출력 옵션” 섹션

모든 출력 작업에 대한 기본 옵션입니다.

export interface PrintOptions {
  /**
   * Name of the print job.
   *
   * **Usage:**
   * - Displayed in the system print queue
   * - Shown in print history/logs
   * - May appear in printer status displays
   * - Used as default filename for "Save as PDF" option
   *
   * **Platform Behavior:**
   * - **iOS**: Shown in print preview header and activity view
   * - **Android**: Displayed in print job notification and print queue
   * - **Web**: Used as document title in print dialog
   *
   * **Best Practices:**
   * - Use descriptive names (e.g., "Invoice #12345", "Q4 Report")
   * - Keep under 50 characters for better display
   * - Avoid special characters that may cause issues in filenames
   * - Include relevant identifiers (order numbers, dates, etc.)
   *
   * **Examples:**
   * - "Invoice #12345"
   * - "Sales Report - 2024 Q4"
   * - "Customer Receipt - John Doe"
   * - "Product Photo - SKU-ABC123"
   *
   * @since 7.0.0
   * @default 'Document'
   * @platform ios Shown in print preview and activity view
   * @platform android Shown in print queue and notifications
   * @platform web Used as document title in print dialog
   * @example 'Invoice #12345'
   * @example 'Annual Report 2024'
   * @example 'Receipt - Order #789'
   */
  name?: string;
}

진실의 근원

‘진실의 근원’이라는 제목의 섹션

이 페이지는 플러그인의 src/definitions.ts업스트림에서 pubic API이 변경되었을 때 다시 동기화 하십시오.