更新记录

1.0.3(2025-11-25)

更新文档

1.0.2(2025-11-25)

内测

1.0.1(2025-11-24)

内测-问题修复

查看更多

平台兼容性

uni-app(4.85)

Vue2 Vue3 Chrome Safari app-vue app-nvue Android iOS 鸿蒙
× × × × × × -
微信小程序 支付宝小程序 抖音小程序 百度小程序 快手小程序 京东小程序 鸿蒙元服务 QQ小程序 飞书小程序 快应用-华为 快应用-联盟
× × × × × × × × × × ×

uni-app x(4.85)

Chrome Safari Android iOS 鸿蒙 微信小程序
× × × ×

lyz-select-pdf

一个用于在 uni-app 中选择 PDF 文件的 UTS 插件,支持 Android 和 iOS 平台。

功能特性

  • ✅ 支持 Android 和 iOS 平台
  • ✅ 调用系统原生文件选择器
  • ✅ 仅允许选择 PDF 文件
  • ✅ 支持成功、失败和完成回调
  • ✅ 返回文件路径(Android 返回 URI,iOS 返回文件路径)

平台支持

平台 支持情况
Android ✅ 支持
iOS ✅ 支持
Web ❌ 不支持
小程序 ❌ 不支持

安装

  1. 导入插件到项目内
  2. 在使用的地方导入方法并且进行使用,然后构建自定义基座(重要),一定要进行使用后构建才能正确打包插件进基座
  3. 启动自定义基座到真机/模拟器进行功能验证

使用方法

基本用法

import { selectFile } from '@/uni_modules/lyz-select-pdf'

// 选择 PDF 文件
selectFile({
  success: (res) => {
    console.log('选择的文件路径:', res)
    // Android: 返回 URI 字符串,如 "content://..."
    // iOS: 返回文件路径字符串,如 "/var/mobile/..."
  },
  fail: (err) => {
    console.error('选择文件失败:', err)
  },
  complete: (res) => {
    console.log('选择完成:', res)
  }
})

在 Vue 组件中使用

<template>
  <view>
    <button @click="handleSelectPDF">选择 PDF 文件</button>
    <text v-if="filePath">已选择: {{ filePath }}</text>
  </view>
</template>

<script setup lang="ts">
import { ref } from 'vue'
import { selectFile } from '@/uni_modules/lyz-select-pdf'

const filePath = ref('')

const handleSelectPDF = () => {
  selectFile({
    success: (res) => {
      filePath.value = res
      uni.showToast({
        title: '选择成功',
        icon: 'success'
      })
    },
    fail: (err) => {
      uni.showToast({
        title: '选择失败',
        icon: 'error'
      })
      console.error(err)
    }
  })
}
</script>

API 文档

selectFile(options)

选择 PDF 文件

参数

参数名 类型 必填 说明
options SelectorOptions 选择文件选项

SelectorOptions

参数名 类型 必填 说明
success (res: string) => void 成功回调,返回文件路径,可直接用于uni.upload
fail (err: any) => void 失败回调
complete (res: any) => void 完成回调(无论成功或失败都会调用)

返回值

回调参数说明

success 回调

  • res (string): 文件路径
    • Android: 返回 URI 字符串,格式如 content://...
    • iOS: 返回文件路径字符串,格式如 /var/mobile/...

fail 回调

  • err (any): 错误信息,可能为字符串或对象

注意事项

  1. 权限要求

    • Android: 无需额外权限,系统会自动处理文件访问权限
    • iOS: 无需额外权限
  2. 文件访问

    • Android: 返回的是 Content URI,需要根据 URI 读取文件内容
    • iOS: 返回的是文件路径,可以直接使用
  3. 平台差异

    • Android 和 iOS 返回的文件路径格式不同,请根据平台进行相应处理

隐私、权限声明

1. 本插件需要申请的系统权限列表:

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

插件不采集任何数据

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

暂无用户评论。