小程序开放平台

文档中心
基础
路由
跳转
转发
界面
网络
支付
数据缓存
媒体
图片
chooseImage
previewImage
getImageInfo
saveImageToPhotosAlbum
compressImage
地图
视频
富文本
位置
开放接口
设备
XHSML
性能
第三方平台
文件
数据分析
画布

xhs.chooseImage

开发
>
JS API
>
媒体
>
图片
>
chooseImage
>
更新时间:2025-04-10 16:06:45

以Promise风格调用: 支持

从本地相册选择图片或使用相机拍照。

参数

Object object

属性
类型
默认值
必填
说明
countnumber9最多可以选择的图片张数
sizeTypearrayoriginal,compressed所选的图片的尺寸
sourceTypearrayalbum,camera选择图片的来源
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数

属性
类型
说明
tempFilePathsarray图片的绝对路径或者小红书自建file路径
tempFilesarray图片的本地临时文件列表
errMsgstring

实例代码

// 调用 chooseImage 选择图片
xhs.chooseImage({
  count: 3, // 最多可以选择的图片张数
  sizeType: ['original', 'compressed'], // 所选图片的尺寸,原图或压缩图
  sourceType: ['album', 'camera'], // 图片来源,相册或相机
  success: (res) => {
    console.log('选择图片成功:', res);
    console.log('图片路径列表:', res.tempFilePaths); // 图片的绝对路径或小红书自建 file 路径
    console.log('图片文件列表:', res.tempFiles); // 图片的本地临时文件列表
  },
  fail: (err) => {
    console.error('选择图片失败:', err.errMsg);
  },
  complete: () => {
    console.log('chooseImage 调用结束');
  }
});