Ninja Pokémon Master

    @uni/image
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.3 • Public • Published

    @uni/image

    npm

    安装

    $ npm install @uni/image --save

    or

    $ npm install @uni/apis --save

    chooseImage

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

    支持

    browser miniApp wechatMiniprogram bytedanceMicroApp baiduSmartProgram kuaiShouMiniProgram

    示例

    import { chooseImage } from '@uni/image';
    
    chooseImage({
      count: 1,
      sourceType: ['album', 'camera'],
      success (res) {
        const tempFilePaths = res.tempFilePaths
      }
    });
    
    // promise
    chooseImage({
      count: 1,
      sourceType: ['album', 'camera']
    }).then(res => {
      const tempFilePaths = res.tempFilePaths
    });

    你也可以从大包引入:

    import { image } from '@uni/apis';
    
    image.chooseImage({
      count: 1,
      sourceType: ['album', 'camera'],
      success (res) {
        const tempFilePaths = res.tempFilePaths
      }
    });
    
    // promise
    image.chooseImage({
      count: 1,
      sourceType: ['album', 'camera']
    }).then(res => {
      const tempFilePaths = res.tempFilePaths
    });

    方法

    chooseImage(options)

    参数

    成员 类型 描述 必选 默认值
    options object  -
    options.count number 最大可选照片数,默认1张 1
    options.sourceType Array<string>  相册选取或者拍照,默认 ['camera','album'],h5不支持拍照 ['album', 'camera']
    options.success Function  成功的回调 -
    options.fail Function  失败的回调 -
    options.complete Function  结束的回调 (调用成功、失败都会执行) -

    差异化参数

    成员 类型 描述 必选 默认值 支持度
    options.sizeType Array.<string>  所选的图片尺寸 ['original', 'compressed'] miniApp wechatMiniprogram baiduSmartProgram kuaiShouMiniProgram

    返回

    成员 类型 描述
    tempFilePaths Array<string>  图片的本地临时文件路径列表,h5为base64图片数据列表
    tempFiles Array<Object> 图片的本地临时文件列表
    res.tempFiles 的结构
    成员 类型 描述
    path string  本地临时文件路径 (本地路径)
    size number  本地临时文件大小,单位 B

    compressImage

    压缩图片接口,可选压缩质量

    支持

    miniApp wechatMiniprogram bytedanceMicroApp baiduSmartProgram kuaiShouMiniProgram

    示例

    import { compressImage } from '@uni/image';
    
    compressImage({
      src: 'http://img.icon.com/a.png',
      quality: 1,
      success: (res) => {
        console.log('success', res);
      },
      fail: (res) => {
        console.log('fail', res);
      },
      complete: (res) => {
        console.log('complete', res);
      }
    });
    
    // promise
    compressImage({
      src: 'http://img.icon.com/a.png',
      quality: 1
    }).then(response => {})
      .catch(error => {})
      .finally(res => {});

    你也可以从大包引入:

    import { image } from '@uni/apis';
    
    image.compressImage({
      src: 'http://img.icon.com/a.png',
      quality: 1,
      success: (res) => {
        console.log('success', res);
      },
      fail: (res) => {
        console.log('fail', res);
      },
      complete: (res) => {
        console.log('complete', res);
      }
    });
    
    // promise
    image.compressImage({
      src: 'http://img.icon.com/a.png',
      quality: 1
    }).then(response => {})
      .catch(error => {})
      .finally(res => {});

    方法

    compressImage(options)

    参数

    成员 类型 描述 必选 默认值
    options object  ✔️ -
    options.src string  图片路径,可以本地路径、代码包相对路径,不支持网络图片 ✔️ -
    options.quality number  压缩质量,范围0~3,1-低,2-中,3-高 -
    options.success Function  成功的回调 -
    options.fail Function  失败的回调 -
    options.complete Function  结束的回调 (调用成功、失败都会执行) -

    返回

    成员 类型 描述
    tempFilePath string 压缩后图片的临时文件路径 (本地路径)

    getImageInfo

    获取图片信息。网络图片需先配置download域名才能生效。

    支持

    miniApp wechatMiniprogram bytedanceMicroApp baiduSmartProgram kuaiShouMiniProgram

    示例

    import { getImageInfo } from '@uni/image';
    
    getImageInfo({
      src: 'http://img.icon.com/a.png',
      success: (res) => {
        console.log('success', res);
      },
      fail: (res) => {
        console.log('fail', res);
      },
      complete: (res) => {
        console.log('complete', res);
      }
    });
    
    // promise
    getImageInfo({
      src: 'http://img.icon.com/a.png'
    }).then(response => {})
      .catch(error => {})
      .finally(res => {});

    你也可以从大包引入:

    import { image } from '@uni/apis';
    
    image.getImageInfo({
      src: 'http://img.icon.com/a.png',
      success: (res) => {
        console.log('success', res);
      },
      fail: (res) => {
        console.log('fail', res);
      },
      complete: (res) => {
        console.log('complete', res);
      }
    });
    
    // promise
    image.getImageInfo({
      src: 'http://img.icon.com/a.png'
    }).then(response => {})
      .catch(error => {})
      .finally(res => {});

    方法

    getImageInfo(options)

    参数

    成员 类型 描述 必选 默认值
    options object  ✔️ -
    options.src string  图片的路径,支持网络路径、相对路径 ✔️ -
    options.success Function  成功的回调 -
    options.fail Function  失败的回调 -
    options.complete Function  结束的回调 (调用成功、失败都会执行) -

    返回

    成员 类型 描述
    width number  图片原始宽度,单位px
    height number  图片原始高度,单位px
    path number  图片的本地路径

    差异化返回值

    成员 类型 描述 支持度
    orientation string  拍照时设备方向 miniApp wechatMiniprogram baiduSmartProgram kuaiShouMiniProgram
    type string  图片格式 miniApp wechatMiniprogram bytedanceMicroApp baiduSmartProgram kuaiShouMiniProgram 钉钉不支持
    orientation
    说明
    up 默认方向(手机横持拍照)
    up-mirrored 同 up,但镜像翻转
    down 旋转180度
    down-mirrored 同 down,但镜像翻转
    left-mirrored 同 left,但镜像翻转
    right 顺时针旋转90度
    right-mirrored 同 right,但镜像翻转
    left 逆时针旋转90度

    previewImage

    在新页面中全屏预览图片。预览的过程中用户可以进行保存图片、发送给朋友等操作。

    支持

    browser miniApp wechatMiniprogram bytedanceMicroApp baiduSmartProgram kuaiShouMiniProgram

    示例

    import { previewImage } from '@uni/image';
    
    previewImage({
      urls: ['url1', 'url2'],
      current: 1,
    });

    你也可以从大包引入:

    import { image } from '@uni/apis';
    
    image.previewImage({
      urls: ['url1', 'url2'],
      current: 1,
    });

    方法

    previewImage(options)

    参数

    成员 类型 描述 必选 默认值
    options object  ✔️ -
    options.urls Array<string> 需要预览的图片链接列表 ✔️
    options.current number  当前显示图片索引 0
    options.success Function  成功的回调 -
    options.fail Function  失败的回调 -
    options.complete Function  结束的回调 (调用成功、失败都会执行) -

    差异化参数

    成员 类型 描述 必选 默认值 支持度
    options.showmenu boolean  是否显示长按菜单 true wechatMiniprogram 2.13.0
    options.images Array<object> 支持原图的图片链接列表,注意顺序需与 urls 中一致。images: [{url: '小图地址', origin_url: '原图地址'},...] - baiduSmartProgram

    saveImage

    保存图片到系统相册

    支持

    miniApp wechatMiniprogram bytedanceMicroApp baiduSmartProgram kuaiShouMiniProgram

    示例

    import { saveImage } from '@uni/image';
    
    saveImage({
      url: 'http://img.icon.com/a.png',
    });

    你也可以从大包引入:

    import { image } from '@uni/apis';
    
    image.saveImage({
      url: 'http://img.icon.com/a.png',
    });

    方法

    saveImage(options)

    参数

    成员 类型 描述 必选 默认值
    options object  ✔️ -
    options.url string  图片文件路径,可以是临时文件路径或永久文件路径 (本地路径) ,不支持网络路径 ✔️ -
    options.success Function  成功的回调 -
    options.fail Function  失败的回调 -
    options.complete Function  结束的回调 (调用成功、失败都会执行) -

    差异化参数

    成员 类型 描述 必选 默认值 支持度
    options.showActionSheet boolean  是否显示图片操作菜单 true miniApp 支付宝支持

    Keywords

    none

    Install

    npm i @uni/image

    DownloadsWeekly Downloads

    711

    Version

    1.1.3

    License

    BSD-3-Clause

    Unpacked Size

    208 kB

    Total Files

    146

    Last publish

    Collaborators

    • bunko
    • rax-publisher