1.0.3 • Published 6 years ago

img-transform v1.0.3

Weekly downloads
1
License
ISC
Repository
github
Last release
6 years ago

Resize and crop uploaded images on the client side.

Installation

$ npm install img-transform

Usage

imgTrasform

imgTransform(uploadInput.files[0], 'image/jpeg')
  .done(function (dataUrl) {
    // your code here
  });

imgTransform is the main function that does nothing if it eas called individually.

arguments

file: input file object or a dataurl string including meta "data:image/jpeg;base64," or not.

type: exported mimeType default is input file mime type or dataurl meta mime type if found, otherwise "image/jpeg" is the default mime type.

Resize

imgTransform(uploadInput.files[0])
  .resize(560, 340, 'cover')
  .done(function (dataUrl) {
    // your code here
  });

arguments

width new width in pixels or 'auto'.

height new height in pixels or 'auto'.

mode optional - preserve image ratio with two arguments 'cover' | 'contain'

note: if one of dimensions was set to 'auto' the other dimension must be set to pixel value.

Crop

imgTransform(uploadInput.files[0])
  .crop(560, 340, 10, 10)
  .done(function (dataUrl) {
    // your code here
  });

arguments

width crop width in pixels or 'auto'.

height crop height in pixels or 'auto'.

leftOffset crop left offset in pixels or 'auto'.

topOffset crop top offset in pixels or 'auto'.

Dimensions 'auto' option is to preserve the image ratio. Offsets 'auto' option is to center the crop size related to dimensions.

Serial

imgTransform(uploadInput.files[0])
  .crop(560, 340, 10, 10)
  .resize(560, 340, 'cover')
  .done(function (dataUrl) {
    // your code here
  });

You have the option to stack the two previous methods as in the example above.

auto

imgTransform(uploadInput.files[0])
  .auto(560, 340)
  .done(function (dataUrl) {
    // your code here
  });

arguments

width new width and crop width in pixels or 'auto'.

height new height and crop height in pixels or 'auto'.

The 'auto' method will perform the 'crop' and 'resize' operations togather with both offsets set to 'auto' and mode set to 'cover'.

done

imgTransform(uploadInput.files[0])
  .auto(560, 340)
  .done(function (dataUrl) {
    // your code here
  });

arguments

callback callback function with the result image in 64string from as the first argument

Thank you.

1.0.3

6 years ago

1.0.2

6 years ago

1.0.1

6 years ago

1.0.0

7 years ago