更新记录

1.1（2026-07-24）

支持本地/网络/contentUri、打开页码、密码、横向翻页等

1.0（2022-10-13）

init

平台兼容性

原生插件通用使用流程：

1. 购买插件，选择该插件绑定的项目。
2. 在HBuilderX里找到项目，在manifest的app原生插件配置中勾选模块，如需要填写参数则参考插件作者的文档添加。
3. 根据插件作者的提供的文档开发代码，在代码中引用插件，调用插件功能。
4. 打包自定义基座，选择插件，得到自定义基座，然后运行时选择自定义基座，进行log输出测试。
5. 开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项：使用HBuilderX2.7.14以下版本，如果同一插件且同一appid下购买并绑定了多个包名，提交云打包界面提示包名绑定不一致时，需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择

pdf阅读 Ba-Pdf

简介

Ba-Pdf 是一款 uniapp 显示 PDF 文档的原生插件。支持本地文件、网络地址、content Uri；支持手势缩放、双击缩放、页码显示、快速拖动；支持打开页码、加密密码、横向翻页等参数；自带选择 PDF 文件方法。

• 支持本地路径、file://、content://、http:// / https:// 网络地址
• 支持手势缩放、双击缩放
• 支持显示页数、快速拖动翻页
• 支持指定打开页码、加密 PDF 密码、自定义标题
• 支持横向/竖向翻页、批注渲染、页间距
• 自带选择 PDF 方法 selectPdf（兼容 Android 10+）
• 完善打开回调：opened / loaded / error / cancel

可与 uniapp 自带的 uni.chooseFile 或 Ba-FilePicker 搭配使用。

截图展示

使用方法

在 script 中引入组件

    const pdf = uni.requireNativePlugin('Ba-Pdf')

打开 PDF（本地 / 网络）

    methods: {
        readPdf() {
            pdf.readPdf({
                    path: this.path,           // 必填：本地路径 / content:// / http(s)
                    page: 1,                  // 可选：打开页码，从 1 开始，默认 1
                    password: '',             // 可选：加密 PDF 打开密码
                    title: '',                // 可选：标题栏文字，默认文件名
                    swipeHorizontal: false,   // 可选：横向翻页，默认 false（竖向）
                    nightMode: false,         // 可选：夜间背景，默认 false
                    enableAnnotation: true,   // 可选：是否渲染批注，默认 true
                    spacing: 10               // 可选：页间距 dp，默认 10
                },
                (res) => {
                    console.log(res)
                    // res.event: opened | loaded | error | cancel
                    if (res.event === 'loaded') {
                        uni.showToast({
                            title: '共 ' + res.pageCount + ' 页',
                            icon: 'none'
                        })
                    } else if (res.event === 'error') {
                        uni.showToast({
                            title: res.msg,
                            icon: 'none'
                        })
                    }
                });
        }
    }

选择 PDF（插件自带）

    methods: {
        selectPdf() {
            pdf.selectPdf((res) => {
                console.log(res)
                if (res.ok && res.outputPath) {
                    this.path = res.outputPath; // 可直接传给 readPdf
                }
            });
        }
    }

打开网络 PDF 示例

    pdf.readPdf({
        path: 'https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf',
        page: 1
    }, (res) => {
        console.log(res)
    })

显示 pdf readPdf 方法参数

path 说明

readPdf 回调参数

回调可能触发多次，通过 event 区分阶段：

event 说明

选择 pdf selectPdf 回调参数

说明：Android 10+ 系统选择器常无真实文件路径，插件会自动拷贝到应用缓存并返回 outputPath，兼容性更好。

注意事项

1. 仅支持 Android 原生端（自定义基座 / 云打包）。
2. 网络 PDF 需要联网权限；首次下载受网络环境影响，同地址再次打开会走缓存。
3. 加密 PDF 必须传正确 password，否则回调 event=error（如 password error）。
4. page 从 1 开始计数；超出总页数时由底层库处理（一般会落到有效页）。
5. 可与 Ba-FilePicker、uni.chooseFile 配合：先选文件拿到路径，再调用 readPdf。

系列插件

图片选择插件 Ba-MediaPicker （文档）

图片编辑插件 Ba-ImageEditor （文档）

文件选择插件 Ba-FilePicker （文档）

应用消息通知插件（多种样式，新增支持常驻通知模式） Ba-Notify（文档）

应用未读角标插件 Ba-Shortcut-Badge （文档）

应用开机自启插件 Ba-Autoboot（文档）

扫码原生插件（毫秒级、支持多码）Ba-Scanner-G（文档）

扫码原生插件 - 新（可任意自定义界面版本；支持连续扫码；支持设置扫码格式）Ba-Scanner（文档）

动态修改状态栏、导航栏背景色、字体颜色插件 Ba-AppBar（文档）

原生sqlite本地数据库管理 Ba-Sqlite（文档）

安卓保活插件（采用多种主流技术） Ba-KeepAlive（文档）

安卓快捷方式（桌面长按app图标） Ba-Shortcut（文档）

自定义图片水印（任意位置） Ba-Watermark（文档）

最接近微信的图片压缩插件 Ba-ImageCompressor（文档）

视频压缩、视频剪辑插件 Ba-VideoCompressor（文档）

动态切换应用图标、名称（如新年、国庆等） Ba-ChangeIcon（文档）

原生Toast弹窗提示（穿透所有界面、穿透原生；自定义颜色、图标 ） Ba-Toast（文档）

图片涂鸦、画笔 Ba-ImagePaint（文档）

pdf阅读（手势缩放、显示页数） Ba-Pdf（文档）

声音提示、震动提示、语音播报 Ba-Beep（文档）

websocket原生服务（自动重连、心跳检测） Ba-Websocket（文档）

短信监听（验证码） Ba-Sms（文档）

智能安装（自动升级） Ba-SmartUpgrade（文档）

监听系统广播、自定义广播 Ba-Broadcast（文档）

监听通知栏消息（支持白名单、黑名单、过滤） Ba-NotifyListener（文档）

全局置灰、哀悼置灰（可动态、同时支持nvue、vue） Ba-Gray（文档）

获取设备唯一标识（OAID、AAID、IMEI等） Ba-IdCode（文档）

实时定位（系统、后台运行、支持息屏）插件 Ba-Location（文档）

实时定位（高德、后台运行、支持息屏、坐标转换、距离计算） Ba-LocationAMap（文档）

窗口小工具、桌面小部件、微件 Ba-AppWidget（文档）

窗口小工具、桌面小部件、微件（日历、时间） Ba-AwCalendarS（文档）

画中画悬浮窗（视频） Ba-VideoPip（文档）

悬浮窗（在其他应用上层显示） Ba-FloatWindow（文档）

悬浮窗（应用内、无需授权） Ba-FloatWindow2（文档）

悬浮窗（悬浮球、动态菜单、在其他应用上层显示） Ba-FloatBall（文档）

添加到“用其他应用打开”中，用于文件传递、分享等 Ba-ShareReceive（文档）

获取地图数据（高德、地理编码、反地理编码） Ba-AMapData（文档）