@uni/image v1.1.3

@uni/image

Install

$ npm install @uni/image --save

or

$ npm install @uni/apis --save

chooseImage

Selects an image from the local album or takes a photo with the camera.

Supported

Usage

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
});

You can also import from the big package：

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
});

Methods

chooseImage(options)

Arguments

Special Arguments

Return

res.tempFiles

compressImage

Compresses images. Multiple types of compression quality are available.

Supported

Usage

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 => {});

You can also import from the big package：

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 => {});

Methods

compressImage(options)

Arguments

Return

getImageInfo

Obtains image information. For network images, it only takes effect when the download domain name is configured.

Supported

Usage

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 => {});

You can also import from the big package：

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 => {});

Methods

getImageInfo(options)

Arguments

Return

Special Return

orientation

previewImage

Previews the image in full screen on a new page. You can save or send it to others while preview.

Supported

Usage

import { previewImage } from '@uni/image';

previewImage({
  urls: ['url1', 'url2'],
  current: 1,
});

You can also import from the big package：

import { image } from '@uni/apis';

image.previewImage({
  urls: ['url1', 'url2'],
  current: 1,
});

Methods

previewImage(options)

Arguments

Special Arguments

saveImage

Saves images to the system album.

Supported

Usage

import { saveImage } from '@uni/image';

saveImage({
  url: 'http://img.icon.com/a.png',
});

You can also import from the big package：

import { image } from '@uni/apis';

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

Methods

saveImage(options)

Arguments

Special Arguments