@ capgo/ 电容器- pdf- 查看器

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

@ capgo/ 电容器- pdf- 查看器 在iOS,Android,和web上嵌入了Capacitor应用的本地PDF取景. 与其对抗WebView限制或传输重的JavaScript PDF渲染器,不如从路径打开文件,HTTPS URL(带有自定义头头),或 Base64,并获得系统级渲染:页面导航,剪接缩放,连续或单页滚动,密码保护文档,全屏或内线布局,以及加载,错误,页面更改,链接自带和关闭等事件. 在iOS上它使用PDFKit;在Android上它使用Pdfium;在网络上它使用带有blob URL的浏览器PDF查看器.

特征

• 从设备路径打开 PDF, file:// URL,HTTPS URL,或 Base64(包括 data: (URIs) (英语)
• 可选 headers 下载远程 URL( 自动令牌、 饼干) 时
• IOS和Android上加密的 PDF 密码支持
• 全屏覆盖或 内入 模式锁定到 DOM 元素(elementId(中文(简体) )
• 连续垂直滚动或单页模式
• 程序化 转到页面, (中文(简体) ), 设置Zoom,以及 关闭
• 活动 : load, (中文(简体) ), pageChange, (中文(简体) ), error, (中文(简体) ), close, (中文(简体) ), linkTap

使用大小写

• 存储在设备上的发票、手册和机票,或从你的API中作为基数返回64
• 从带有自定义 HTTP 头的已签名的 URL 下载文件
• 嵌入式 PDF 预览以窗体或仪表板区域(内置模式)
• 引导读取流程跳入一页,并听取 PDF 内部的链接水龙头

文档

• 插件文件 (原始内容存档于2017-03-21). capp. app
• 教学 安装步骤和实例
• 队长 用于实时更新、本地构建和插件支持

兼容性

政策:

• 新的插件从版本开始 8.0.0 (8号电站基线).
• 对更古老的Capacitor主机的后向相容性按需支持.

安装

npm i @capgo/capacitor-pdf-viewer
npx cap sync

与 Bun 键 :

bun add @capgo/capacitor-pdf-viewer
bunx cap sync

iOS 设置

此插件不需要额外的 Info. plist 密钥或权限 。 它使用苹果PDFKit. 使用远程 PDF URLSession 用你传入的信头 open。对于 HTTPS URL,请遵循您的应用程序通常的 App Transport 安全规则.

机器人设置

插件库目标 分数 24 (Android 7.0)并捆绑出Pdfium (io.legere:pdfiumandroid) (中文(简体) ). 插件 AndroidManifest.xml 是空的: 它没有声明 INTERNET,存储,或FileProvider条目。 如果你打开 网页 源,添加 INTERNET 给您的 应用 显示 :

<uses-permission android:name="android.permission.INTERNET" />

本地文件和 Base64 不需要额外的权限, 超出您的应用程序已经使用的读取路径 .

网页

网络不需要电容同步步骤 。 URL 来源随您一起获取 headers· ; setZoom 由于缩放由浏览器控制,所以是不可操作的。 密码不能在网络上被注入;浏览器可能自行提示.

使用量

import { PdfViewer } from '@capgo/capacitor-pdf-viewer';

await PdfViewer.addListener('pageChange', ({ page, pageCount }) => {
  console.log(`Page ${page} of ${pageCount}`);
});

const { pageCount, page } = await PdfViewer.open({
  source: 'https://example.com/manual.pdf',
  headers: { Authorization: 'Bearer YOUR_TOKEN' },
  mode: 'fullscreen',
  scrollMode: 'continuous',
  page: 1,
});

await PdfViewer.goToPage({ page: 2 });
await PdfViewer.setZoom({ scale: 1.25 });
await PdfViewer.close();

内置预览 隐藏中 :

await PdfViewer.open({
  source: base64FromYourApi,
  sourceType: 'base64',
  mode: 'inline',
  elementId: 'pdf-host',
});

密码保护文件 (iOS和Android): (英语:

await PdfViewer.open({
  source: '/path/on/device/encrypted.pdf',
  sourceType: 'path',
  password: 'secret',
});

在本地贝壳上,从 WebView 源 URL 上加载 PDF 经常失败,因为该源不是真实的文件服务器. 获取 JavaScript 中的字节并传递 sourceType: 'base64' 相反(见 example-app/) (中文(简体) ).

API 密码

• open(...)
• close()
• goToPage(...)
• setZoom(...)
• getPluginVersion()
• addListener('load', ...)
• addListener('pageChange', ...)
• addListener('error', ...)
• addListener('close', ...)
• addListener('linkTap', ...)
• 接口
• 类型异名

Capacitor的原生PDF取景器(iOS上的PDFKit,Android上的Pdfium,网页上的浏览器取景器).

打开(...)

open(options: OpenPdfOptions) => Promise<OpenPdfResult>

从文件、路径、 URL 或 Base64 来源打开 PDF .

回返情况: Promise<OpenPdfResult>

自: 8.0.0 (单位:千美元)

关闭( c)

close() => Promise<void>

关闭活动查看器并删除任何覆盖 .

自: 8.0.0 (单位:千美元)

gotoPage (...) (中文(简体) )

goToPage(options: GoToPageOptions) => Promise<void>

跳转到打开文档中基于 1 的页码.

自: 8.0.0 (单位:千美元)

设置Zoom (...)

setZoom(options: SetZoomOptions) => Promise<void>

设置缩放比值乘数( E)1 是本地的默认适配比例. 在网页上此解析而不更改浏览器缩放 .

自: 8.0.0 (单位:千美元)

获取 PluginVersion ()

getPluginVersion() => Promise<PluginVersionResult>

获取本地或网络执行版本标记 .

回返情况: Promise<PluginVersionResult>

自: 8.0.0 (单位:千美元)

添加倾听器( “ 装入 ” ,...)

addListener(eventName: 'load', listenerFunc: (event: PdfLoadEvent) => void) => Promise<PluginListenerHandle>

听好 PDF 装入成功 .

回返情况: Promise<PluginListenerHandle>

自: 8.0.0 (单位:千美元)

添加倾听器( “ pageChange ” ,...)

addListener(eventName: 'pageChange', listenerFunc: (event: PdfPageChangeEvent) => void) => Promise<PluginListenerHandle>

在用户滚动时或当 QQlink PdfviewerPlugin.go ToPage} 运行时聆听页面变化 .

回返情况: Promise<PluginListenerHandle>

自: 8.0.0 (单位:千美元)

添加倾听器( 'error',...)

addListener(eventName: 'error', listenerFunc: (event: PdfErrorEvent) => void) => Promise<PluginListenerHandle>

打开或显示 PDF 时倾听出错 .

回返情况: Promise<PluginListenerHandle>

自: 8.0.0 (单位:千美元)

添加倾听器( “ 关闭 ” ,...)

addListener(eventName: 'close', listenerFunc: (event: PdfCloseEvent) => void) => Promise<PluginListenerHandle>

收听观看器关闭(用户手势或QQlink PdfviewerPlugin.close}).

回返情况: Promise<PluginListenerHandle>

自: 8.0.0 (单位:千美元)

添加倾听器('linkTap',...)

addListener(eventName: 'linkTap', listenerFunc: (event: PdfLinkTapEvent) => void) => Promise<PluginListenerHandle>

监听PDF内部的链接.

回返情况: Promise<PluginListenerHandle>

自: 8.0.0 (单位:千美元)

接口

OpenPdf 结果

PDF 成功打开后返回结果 .

OpenPdf 选项

QQlink PdfviewPlugin. open} 的选项 .

GotoPage 选项

QQlink PdfViewerPlugin.go ToPage 的选项 .

设置Zoom 选项

链接 PdfViewerPlugin.setZoom 的选项 .

插件变压器

来自QQlink PdfViewerPlugin.getPluginVersion的插件版本有效载荷 .

插件听筒

PdfLoad 活动

有效载荷 load 活动.

PdfPageChangeEvent 移动事件

有效载荷 pageChange 活动.

错误事件

有效载荷 error 活动.

PdfLinkTapEvent 游戏

有效载荷 linkTap 活动.

类型异名

Pdf 源代码

怎么样 source 弦应该被解释. 在省略时,插件从字符串形状中推断出类型.

'file' | 'path' | 'url' | 'base64'

记录

构造 T 类型 K 的一组属性类型

{ [P in K]: T; }

PdfDisplay 模式

查看器的演示模式 .

• fullscreen:用本地或浏览器覆盖应用程序.
• inline: 将查看器放置在由 elementId。 。 。 .

'fullscreen' | 'inline'

Pdf 滚动模式

页面滚动行为.

• continuous: 页面作为可滚动文档垂直流动.
• single:一页一页.

'continuous' | 'single'

关闭事件

有效载荷 close 事件(空对象).

Record<string, never>