@ capgo/ 电容器打印器

打印文档, HTML, PDF, 图像和当前从您的 Capacitor app 的网页视图, 并使用 iOS 和 Android 上的本地打印对话框 .

🤖 建筑与AI编码代理? 安装 Capgo 技能 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 @capgo/capacitor-printer 在您的电容应用程序中: npx skills add Cap-go/capgo-skills。然后问你的经纪人: 添加@capgo/电容器打印器到我的电容器应用上并把它接上 代理设置指南 • 妇女 主机磁共振

主要特点

• HTML 语言数字 : printHtml() 打印 HTML 字符串.
• PDF 和文件数字 : printPdf(), (中文(简体) ), printFile() 财务报告和审定财务报表 printBase64() 用于设备文件和基础64数据.
• 网页内容数字 : printWebView() 打印当前页面并 printIframe() 打印一个 iframe.
• 本地对话框数字 : UIPrintInteractionController iOS和Android打印框架.
• 平台: iOS,Android和Web. 互联网档案馆的存檔,存档日期2013-12-02. Web使用浏览器打印对话框.

为什么是电容打印机?

A 类 自由和开源 具有全面特性的打印解决方案 :

• 多种格式 - 打印HTML、PDF、图像和基础64数据
• 本地 APIs - 使用UIPrint接口控制器(iOS)和打印管理器(Android)
• 网络支持 - 在所有平台(包括网页浏览器)开展工作
• 打印定制 - 支持CSS打印样式和自定义页面名称
• 跨平台 - 一致的API跨iOS,Android,和Web

完全适合发票的生成、报告打印、文件共享以及任何需要本地印刷能力的应用程序.

文档

这里有最完整的医生: https://capgo.app/docs/plugins/printer/ 页面存档备份,存于互联网档案馆

兼容性

说明: 此插件的主要版本沿用了Capacitor的主要版本. 使用匹配您的 Capacitor 安装的版本( 如 Capacitor 8 的插件 v8) 。 只有最新的主要版本得到积极维护.

安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

然后使用下列提示:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-printer` plugin in my project.

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

npm install @capgo/capacitor-printer
npx cap sync

使用量

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

// Print HTML content
await Printer.printHtml({
  name: 'My Document',
  html: '<html><body><h1>Hello World</h1><p>This is a test document.</p></body></html>',
});

// Print PDF file
await Printer.printPdf({
  name: 'Invoice',
  path: 'file:///path/to/document.pdf',
});

// Print image from base64
await Printer.printBase64({
  name: 'Photo',
  data: 'JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlL...',
  mimeType: 'image/jpeg',
});

// Print current web view
await Printer.printWebView({
  name: 'Web Page',
});

API 密码

• printBase64(...)
• printFile(...)
• printHtml(...)
• printPdf(...)
• printIframe(...)
• printWebView(...)
• getPluginVersion()
• 接口

打印Base64(...)

printBase64(options: PrintBase64Options) => Promise<void>

将打印的 UI 显示为已编码为 Base64 字符串的文件 .

平台行为 :

• iOS系统: 使用具有基数64解码数据的 UIPrint 交互控制器
• 机器人: 使用带有基础64解码数据的打印管理器
• 网页: 从 Base64 数据创建 blob并打开打印对话框

性能警告 : 大型文件在解码基础64时会由于内存限制而导致应用崩溃. 对于大于5MB的文件,建议使用平面File()来取而代之.

自: 7.0.0 (单位:千美元)

打印文件(...)

printFile(options: PrintFileOptions) => Promise<void>

向打印设备文件提交打印 UI .

平台行为 :

• iOS系统: 使用带有文件 URL 的 UIPrint Interaction 控制器. 支持文件://路径或路径相对于app的文档目录.
• 机器人: 使用带有文件路径的打印管理器. 支持内容://URIs和文件://路径.
• 网页: 读取文件并打开打印对话框

支持的文件类型 :

• PDF 文档 (应用程序/pdf)
• 图像:JPEG、PNG、GIF、HEIC、HEIF

自: 7.0.0 (单位:千美元)

打印Html(...)

printHtml(options: PrintHtmlOptions) => Promise<void>

呈现打印 UI 打印 HTML 文档.

平台行为 :

• iOS系统: WKWebView 中的 Renders HTML, 然后使用 UIPrint Interaction 控制器打印
• 机器人: WebView 中的渲染器 HTML, 然后使用打印管理器打印
• 网页: 创建带有 HTML 内容的 iframe并触发打印对话框

HTML 要求 :

• 应该是一个完整的HTML文档,并有适当的结构
• 可包含内置 CSS 样式或样式标签
• 外部资源(图像、样式表)应使用绝对 URL
• 可用 @ media 打印规则添加特定打印 CSS

CSS 打印样式 : 使用 CSS 媒体查询自定义打印输出 :

• 控制分页:分页前,分页后,分页后,分页后
• 隐藏元素: 显示: 无打印类
• 调整打印字体大小和颜色

自: 7.0.0 (单位:千美元)

打印Pdf(...)

printPdf(options: PrintPdfOptions) => Promise<void>

呈现打印 UI 打印 PDF 文档.

平台行为 :

• iOS系统: 使用与 PDF 文件 URL 的 UIPrint 交互控制器
• 机器人: 使用带有 PdfDocument 的打印管理器
• 网页: 创建对象 URL并打开打印对话框

文件路径要求 :

• iOS系统: 必须是文件://路径或相对于 app 文档目录
• 机器人: 支持内容://URI(从下载,媒体存储)或文件://路径
• 网页: 必须是可访问的文件路径

自: 7.0.0 (单位:千美元)

打印Iframe(...)

printIframe(options: PrintIframeOptions) => Promise<void>

显示一个 iframe 元素内的内容的打印 UI .

当完整的 HTML 文档太大而无法通过打印时有用 .

平台行为 :

• iOS系统: 在 WebView 中评价 JavaScript 打印 Iframe 内容
• 机器人: 在 WebView 中评价 JavaScript 打印 Iframe 内容
• 网页: 查找框架并触发其打印对话框

自: 8.0.19 联合国

打印WebView(...)

printWebView(options?: PrintOptions | undefined) => Promise<void>

获取 PluginVersion ()

getPluginVersion() => Promise<{ version: string; }>

获取本地 Capacitor 插件版本 .

从本地代码(iOS/Android)返回硬编码插件版本或 软件包版本 (Web). 用于调试和确保插件 兼容性.

回返情况: Promise<{ version: string; }>

自: 7.0.0 (单位:千美元)

接口

打印Base64 选项

打印碱基64编码数据的选项.

打印文件选项

从设备存储中打印文件的选项 .

打印Html 选项

打印 HTML 内容的选项 .

打印 Pdf 选项

打印 PDF 文档的选项.

打印框架选项

打印 Iframe 内容的选项 .

打印选项

所有打印操作的基础选项 .

Android 配置

保护

如果您使用ProGuard,请在您的 proguard-rules.pro 文件 :

-keep class com.capgo.printer.** { *; }

变量

您可以在您中配置以下工程变量 variables.gradle 文件 :

ext {
  androidxDocumentFileVersion = '1.0.1'
  androidxPrintVersion = '1.0.0'
}

平台支持

页:1

大文件

在打印基础64编码数据时,由于内存限制,大文件可能导致应用崩溃. 对于大型文件,建议先将其保存到设备并使用 printFile() 换句话说.

网络平台

网络平台上:

• printWebView() 触发浏览器的本地打印对话框
• 其他方法创建并打印其内容
• 一些浏览器可能对某些文件类型的打印有安全限制

打印样式

在打印网页内容时, 您可以使用 CSS 媒体查询来自定义打印输出 :

@media print {
  /* Your print styles here */
  body {
    font-size: 12pt;
  }
  .no-print {
    display: none;
  }
}