メインコンテンツへスキップ
@capgo/capacitor-printer ファイルとストレージ オープンソース

プリンター Capacitor プラグイン

ドキュメント、HTML、PDF、画像、WebViewを印刷するためのCapacitorプラグイン

インストール

bun add @capgo/capacitor-printer bunx cap sync
npm、pnpm、または yarn
  • npm install @capgo/capacitor-printer
  • pnpm add @capgo/capacitor-printer
  • yarn add @capgo/capacitor-printer

ガイド

Capacitor で Printer を使う方法

実機でテストする

Capgo アプリをダウンロードして、QR code をスキャンしてください。

Printer pluginのプレビューQR code

@capgo/capacitor-printer の使用方法

ドキュメント、HTML、PDF、画像、WebViewの印刷に対応したCapacitorプラグイン。

インストール

bun add @capgo/capacitor-printer
bunx cap sync

このプラグインで利用可能な機能

  • printBase64 - base64文字列としてエンコードされたファイルを印刷するための印刷UIを表示します。
  • printFile - デバイス上のファイルを印刷するための印刷UIを表示します。
  • printHtml - HTMLドキュメントを印刷するための印刷UIを表示します。
  • printPdf - PDFドキュメントを印刷するための印刷UIを表示します。

使用例

printBase64

base64文字列としてエンコードされたファイルを印刷するための印刷UIを表示します。

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

デバイス内のファイルを印刷するための印刷UIを表示します。

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

HTMLドキュメントを印刷するための印刷UIを表示します。

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ドキュメントを印刷するための印刷UIを表示します。

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',
});

リファレンス全文

@capgo/capacitor-printer の使い方から続ける

使用している場合 @capgo/capacitor-printer の使用方法 ネイティブプラグインの作業を計画するには、次と連携してください: @capgo/capacitor-printer @capgo/capacitor-printer の実装詳細については、 スタートガイド スタートガイドの実装詳細については、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor Plugins の実装詳細、および プラグインの追加または更新 プラグインの追加または更新に関する実装詳細についてはこちら。

よくある質問

プリンタープラグイン FAQ

Capacitor アプリにプリンタープラグインをインストールするには?

「bun add @capgo/capacitor-printer」(または「npm install @capgo/capacitor-printer」)を実行し、続けて「bunx cap sync」を実行すると、iOS と Android プロジェクトにネイティブの code が取り込まれます。アプリの code で「@capgo/capacitor-printer」からインポートしてください。

@capgo/capacitor-printer は React、Vue、Angular で使えますか?

はい。Printer は Capacitor パッケージなので、Ionic、React、Vue、Angular、Svelte、素の JavaScript など、Capacitor 上で動くあらゆる Web フレームワークで使えます。

@capgo/capacitor-printer はどの Capacitor バージョンをサポートしていますか?

Capgo プラグインは Capacitor のメジャーバージョンに合わせています。使用している Capacitor のメジャーバージョンに一致するプラグインのメジャーバージョンを使ってください (例: Capacitor 8 ならプラグイン v8)。GitHub の README にある互換性テーブルに、メンテナンス中のバージョンが記載されています。

@capgo/capacitor-printer は無料でオープンソースですか?

はい。code のソースコードは GitHub の https://github.com/Cap-go/capacitor-printer/ で公開されており、パッケージは npm から無料でインストールできます。バグ報告やプルリクエストもお待ちしています。

App Store の審査なしで、Printer を使用している code をアップデートできますか?

プラグインのインストールやアップグレードはネイティブの code を変更するため、新しいストアビルドが必要です。その後は、プラグインを呼び出す JavaScript、HTML、CSS の変更を Capgo Live Updates で即座に配信できます。

アプリ審査を待たずに Printer の変更をリリース

プラグインをストア用ビルドに組み込めば、Capgo live updates で JavaScript、HTML、CSS の変更を数分でユーザーに配信できます

Capgo から始める