Prise en main
Copiez un prompt de configuration incluant les étapes d'installation et le guide markdown complet pour ce 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.
Installer
Section intitulée « Installation »Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-pluginsUtilisez ensuite le prompt suivant :
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-printer` plugin in my project.Si vous préférez une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :
bun add @capgo/capacitor-printerbunx cap syncImporter
Section intitulée « Import »import { Printer } from '@capgo/capacitor-printer';Démarrage rapide
Section intitulée « Démarrage rapide »Imprimez un PDF déjà présent sur le disque (recommandé pour les fichiers volumineux).
import { Printer } from '@capgo/capacitor-printer';
await Printer.printFile({ path: 'file:///data/user/0/.../invoice.pdf', name: 'Invoice #1042',});Exemple : reçu HTML
Section intitulée « Exemple : reçu HTML »await Printer.printHtml({ html: '<h1>Thank you</h1><p>Total: $42.00</p>', name: 'Receipt',});Exemple : évitez les payloads base64 volumineux
Section intitulée « Exemple : évitez les payloads base64 volumineux »printBase64 décode l'intégralité des fichiers en mémoire. Pour les assets de plus d'environ 5 Mo, écrivez dans un fichier temporaire et appelez printFile plutôt.
Erreurs courantes
Section intitulée « Erreurs courantes »- Mémoire: les longues chaînes base64 peuvent faire planter l’app sur les appareils à faible RAM.
- Le Web: l’impression utilise la boîte de dialogue du navigateur, la mise en page diffère des contrôleurs d’impression natifs.
- Paths: sur Android, passez un
file://URI, chemin absolu du système de fichiers oucontent://URI. Les chemins relatifs à l’app ne sont pas résolus automatiquement.
Aperçu de API
Section intitulée « Aperçu API »printBase64
Section intitulée « printBase64 »Affiche l'interface d'impression pour les fichiers encodés en base64.
Comportement par plateforme :
- iOS: Utilise UIPrintInteractionController avec des données décodées en base64
- Android: Utilise PrintManager avec des données décodées en base64
- Le Web: Crée un blob à partir de données base64 et ouvre la boîte de dialogue d’impression
Avertissement de performance : Les fichiers volumineux peuvent provoquer des crashs de l'application en raison des contraintes de mémoire lors du décodage base64. Pour les fichiers de plus de 5 Mo, il est recommandé d'utiliser printFile().
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
Section intitulée « printFile »Affiche l'interface d'impression pour les fichiers de l'appareil.
Comportement par plateforme :
- iOS: Utilise UIPrintInteractionController avec une URL de fichier. Prend en charge les chemins file:// ou les chemins relatifs au répertoire de documents de l’application.
- Android: Utilise PrintManager avec un chemin de fichier. Prend en charge les URI content:// et les chemins file://.
- Le Web: Reads file and opens print dialog
Types de fichiers pris en charge :
- Documents PDF (application/pdf)
- Images : 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
Section intitulée « printHtml »Affiche l'interface d'impression pour les documents HTML.
Comportement par plateforme :
- iOS: Affiche le HTML dans WKWebView, puis imprime via UIPrintInteractionController
- Android: Affiche le HTML dans WebView, puis imprime via PrintManager
- Le Web: Crée un iframe avec du contenu HTML et déclenche la boîte de dialogue d'impression
Prérequis HTML :
- Doit être un document HTML complet avec une structure correcte
- Peut inclure des styles CSS inline ou des balises style
- Les ressources externes (images, feuilles de style) doivent utiliser des URL absolues
- Print-specific CSS can be added using
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
Section intitulée « printPdf »Affiche l'interface d'impression pour les documents PDF.
Comportement par plateforme :
- iOS: utilise UIPrintInteractionController avec l’URL d’un fichier PDF
- Android: utilise PrintManager avec PdfDocument
- Le Web: Creates object URL and opens print dialog
Chemin de fichier requis :
- iOS: Doit être un chemin file:// ou relatif au répertoire Documents de l’app
- Android: Prend en charge les URI content:// (téléchargements, MediaStore) ou les chemins file://
- Le Web: Doit être un chemin de fichier accessible
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
Section intitulée « printWebView »Affiche l’interface d’impression pour imprimer le contenu de la WebView.
Imprime le contenu actuel affiché dans la WebView de votre app.
Comportement par plateforme :
- iOS: Utilise UIPrintInteractionController avec la vue imprimable de WKWebView
- Android: Utilise WebView.createPrintDocumentAdapter() avec PrintManager
- Le Web: Déclenche window.print() pour la page actuelle
Style d'impression : Prend en charge les media queries CSS d'impression pour la personnalisation. Les styles actuels de la web view seront appliqués, y compris
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://Référence de type
Section intitulée « Référence de type »PrintBase64Options
Section intitulée « PrintBase64Options »Options pour l'impression de données encodées en 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
Section intitulée « PrintFileOptions »Options pour imprimer des fichiers depuis le stockage de l’appareil.
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
Section intitulée « PrintHtmlOptions »Options pour l'impression de contenu 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;}Invoice #12345
*Amount: $299.99
* *