简体中文
文件需要上传?推荐
uni-cdn
,帮你节省至少30%的 CDN 费用!详情。
从本地选择文件。
本API主要用于选择非媒体文件,如果选择的文件是媒体文件,另有3个专用API:
平台差异说明
App | H5 | 微信小程序 | 支付宝小程序 | 百度小程序 | 抖音小程序、飞书小程序 | QQ小程序 | 快手小程序 | 京东小程序 |
---|---|---|---|---|---|---|---|---|
x | √(HBuilder X2.9.9+) | x(可使用wx.chooseMessageFile) | x | x | x | x | x | x |
HarmonyOS Next 兼容性
HarmonyOS Next |
---|
HBuilderX 4.31 |
_doc
、_downloads
、_documents
等plus.io控制的目录下的文件,可通过plus.io Api,自己做选择框。OBJECT 参数说明
参数名 | 类型 | 默认值 | 必填 | 说明 | 平台差异说明 |
---|---|---|---|---|---|
count | Number | 100 | 否 | 最多可以选择的文件数量 | 见下方说明 |
type | String | 'all' | 否 | 所选的文件的类型 | 见下方说明 |
extension | Array<String> | 否 | 根据文件拓展名过滤,每一项都不能是空字符串。默认不过滤。 | 见下方说明 | |
sourceType | Array<String> | ['album','camera'] | 否 | (仅在type为image 或video 时可用)album 从相册选图,camera 使用相机,默认二者都有。如需直接开相机或直接选相册,请只使用一个选项 | |
success | Function | 是 | 成功则返回图片的本地文件路径列表 tempFilePaths | ||
fail | Function | 否 | 接口调用失败的回调函数 | ||
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
Tips
['.zip','.exe','.js']
,不支持application/msword
等类似值注:文件的临时路径,在应用本次启动期间可以正常使用,如需持久保存,需在主动调用 uni.saveFile,在应用下次启动时才能访问得到。
OBJECT.type 的合法值
值 | 说明 |
---|---|
all | 从所有文件选择 |
video | 只能选择视频文件 |
image | 只能选择图片文件 |
Tips
{type:'image',extension:['.png','.jpg']}
,则会选择image/png,image/jpg
文件{extension:['.doc','.xlsx','.docx']}
,则会选择.doc,.xlsx,.docx
文件,详情见accept属性
type="all"
,则extension
属性失效success 返回参数说明
参数 | 类型 | 说明 |
---|---|---|
tempFilePaths | Array<String> | 文件的本地文件路径列表 |
tempFiles | Array<Object>、Array<File> | 文件的本地文件列表,每一项是一个 File 对象 |
File 对象结构如下
参数 | 类型 | 说明 |
---|---|---|
path | String | 本地文件路径 |
size | Number | 本地文件大小,单位:B |
name | String | 包含扩展名的文件名称,仅H5支持 |
type | String | 文件类型,仅H5支持 |
示例
uni.chooseFile({
count: 6, //默认100
extension:['.zip','.doc'],
success: function (res) {
console.log(JSON.stringify(res.tempFilePaths));
}
});
// 选择图片文件
uni.chooseFile({
count: 10,
type: 'image',
success (res) {
// tempFilePath可以作为img标签的src属性显示图片
const tempFilePaths = res.tempFiles
}
})
从微信聊天会话中选择文件。
平台差异说明
App | H5 | 微信小程序 | 支付宝小程序 | 百度小程序 | 抖音小程序、飞书小程序 | QQ小程序 | 快手小程序 | 京东小程序 |
---|---|---|---|---|---|---|---|---|
x | x | √(基础库2.5.0+) | x | x | x | √(基础库1.18.0+) | x | x |