Erste Schritte
Kopiere einen Setup-Prompt mit den Installationsschritten und dem vollständigen Markdown-Guide für dieses Plugin.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-printer`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/printer/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
Installieren
Abschnitt „Installation“Du kannst unser KI-gestütztes Setup nutzen, um das Plugin zu installieren. Füge die Capgo Skills mit dem folgenden Befehl deinem KI-Tool hinzu:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-pluginsNutze dann diesen Prompt:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-printer` plugin in my project.Wenn du ein manuelles Setup bevorzugst, installiere das Plugin mit den folgenden Befehlen und befolge die plattformspezifischen Anweisungen unten:
bun add @capgo/capacitor-printerbunx cap syncImportieren
Abschnitt mit dem Titel „Import“import { Printer } from '@capgo/capacitor-printer';Quickstart
Abschnitt „Quick start“Drucke eine PDF direkt von der Festplatte (empfohlen für große Dateien).
import { Printer } from '@capgo/capacitor-printer';
await Printer.printFile({ path: 'file:///data/user/0/.../invoice.pdf', name: 'Invoice #1042',});Beispiel: HTML-Beleg
Abschnitt mit dem Titel „Beispiel: HTML-Beleg“await Printer.printHtml({ html: '<h1>Thank you</h1><p>Total: $42.00</p>', name: 'Receipt',});Beispiel: Vermeidung riesiger Base64-Payloads
Abschnitt mit dem Titel „Beispiel: Vermeidung riesiger Base64-Payloads“printBase64 dekodiert ganze Dateien im Arbeitsspeicher. Bei Assets über ca. 5 MB in eine Temp-Datei schreiben und aufrufen printFile stattdessen.
Häufige Stolperfallen
Abschnitt „Häufige Fallstricke“- Memory: Große Base64-Strings können die App auf Geräten mit wenig RAM zum Absturz bringen.
- Web: Der Druck erfolgt über den Browser-Dialog; das Layout unterscheidet sich von nativen Drucksteuerungen.
- Pfade: Unter Android muss ein zugänglicher
file://URI, absoluter Dateisystempfad odercontent://URI übergeben werden. App-relative Pfade werden nicht automatisch aufgelöst.
API Übersicht
Abschnitt „API Übersicht“printBase64
Abschnitt mit dem Titel „printBase64“Zeigt die Druck-UI zum Drucken von als Base64-String kodierten Dateien an.
Plattformverhalten:
- iOS: Nutzt UIPrintInteractionController mit base64-dekodierten Daten
- Android: Nutzt PrintManager mit base64-dekodierten Daten
- Web: Erstellt einen Blob aus base64-Daten und öffnet den Druckdialog
Performance-Warnung: Große Dateien können beim Dekodieren von base64 aufgrund von Speicherengpässen zu App-Abstürzen führen. Bei Dateien über 5 MB wird empfohlen, printFile() zu verwenden.
import { Printer } from '@capgo/capacitor-printer';
// Print a base64 encoded PDFawait Printer.printBase64({ name: 'Invoice #12345', data: 'base64-encoded-pdf-data', mimeType: 'application/pdf',});
// Print a base64 encoded imageawait Printer.printBase64({ name: 'Product Photo', data: '/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDA...', mimeType: 'image/jpeg',});printFile
Abschnitt mit dem Titel „printFile“Zeigt die Druck-UI zum Drucken von Gerätedateien an.
Plattformverhalten:
- iOS: Nutzt UIPrintInteractionController mit Datei-URL. Unterstützt file://-Pfade oder Pfade relativ zum Documents-Verzeichnis der App.
- Android: Nutzt PrintManager mit Dateipfad. Unterstützt sowohl content://-URIs als auch file://-Pfade.
- Web: Liest die Datei und öffnet den Druckdialog
Unterstützte Dateitypen:
- PDF-Dokumente (application/pdf)
- Bilder: JPEG, PNG, GIF, HEIC, HEIF
import { Printer } from '@capgo/capacitor-printer';
// iOS: Print from app documents directoryawait Printer.printFile({ name: 'Contract', path: 'file:///var/mobile/Containers/Data/Application/.../Documents/contract.pdf',});
// Android: Print from content URIawait Printer.printFile({ name: 'Receipt', path: 'content://com.android.providers.downloads.documents/document/123', mimeType: 'application/pdf',});
// Android: Print from file pathawait Printer.printFile({ name: 'Photo', path: 'file:///storage/emulated/0/Download/photo.jpg', mimeType: 'image/jpeg',});printHtml
Abschnitt „printHtml“Zeigt die Druck-UI zum Drucken von HTML-Dokumenten an.
Plattformverhalten:
- iOS: Rendert HTML in der WKWebView und druckt via UIPrintInteractionController
- Android: Rendert HTML in der WebView und druckt via PrintManager
- Web: Erstellt ein iframe mit HTML-Inhalt und öffnet den Druckdialog
HTML-Anforderungen:
- Sollte ein vollständiges HTML-Dokument mit korrekter Struktur sein
- Inline-CSS oder Style-Tags sind möglich
- Externe Ressourcen (Bilder, Stylesheets) sollten absolute URLs nutzen
- Druckspezifisches CSS lässt sich hinzufügen mit
import { Printer } from '@capgo/capacitor-printer';
// Simple HTML documentawait Printer.printHtml({name: 'Sales Report',html: '<html><body><h1>Q4 Sales Report</h1><p>Revenue: $125,000</p></body></html>',});
// HTML with print-specific CSSawait Printer.printHtml({name: 'Styled Invoice',html: `<html><head><style>printPdf
Abschnitt „printPdf“Zeigt die Druck-UI zum Drucken von PDF-Dokumenten an.
Plattformverhalten:
- iOS: Nutzt UIPrintInteractionController mit PDF-Datei-URL
- Android: Nutzt PrintManager mit PdfDocument
- Web: Erstellt eine Object-URL und öffnet den Druckdialog
Anforderungen an den Dateipfad:
- iOS: Muss ein file://-Pfad oder relativ zum Dokumentenverzeichnis der App sein
- Android: Unterstützt content:// URIs (aus Downloads, Media Store) oder file://-Pfade
- Web: Muss ein zugreifbarer Dateipfad sein
import { Printer } from '@capgo/capacitor-printer';
// Print PDF from app storageawait Printer.printPdf({ name: 'Annual Report 2024', path: 'file:///var/mobile/Containers/Data/Application/.../Documents/report.pdf',});
// Print PDF from Android downloadsawait Printer.printPdf({ name: 'Downloaded Document', path: 'content://com.android.providers.downloads.documents/document/123',});printWebView
Abschnitt mit dem Titel „printWebView“Zeigt das Druck-UI an, um WebView-Inhalte zu drucken.
Druckt den aktuellen Inhalt, der in der WebView deiner App angezeigt wird.
Plattformverhalten:
- iOS: Nutzt UIPrintInteractionController mit WKWebView’s view printable
- Android: Nutzt WebView.createPrintDocumentAdapter() mit PrintManager
- Web: Löst window.print() für die aktuelle Seite aus
Print-Styling: Unterstützt CSS Print Media Queries zur Anpassung. Die aktuellen Styles der Webview werden angewendet, inklusive
import { Printer } from '@capgo/capacitor-printer';
// Print current web view with default nameawait Printer.printWebView();
// Print with custom job nameawait Printer.printWebView({name: 'Dashboard Screenshot',});
// Use with print-specific CSS in your HTML// Add this to your app's CSS://Typreferenz
Abschnitt mit dem Titel „Typreferenz“PrintBase64Options
Abschnitt mit dem Titel „PrintBase64Options“Optionen zum Drucken von base64-kodierten Daten.
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
Abschnitt „PrintFileOptions“Optionen zum Drucken von Dateien aus dem Gerätespeicher.
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
Abschnitt „PrintHtmlOptions“Optionen zum Drucken von HTML-Inhalten.
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;}Invoice #12345
*Amount: $299.99
* *