Files
react-native/Libraries/Image/ImageEditor.js
T
Youssouf El Azizi d2ef114538 Add Spec for ImageEditor (#24921)
Summary:
This PR solves part of this issue: #24875
## Changelog

[General] [Added] - TM Spec for ImageEditor
Pull Request resolved: https://github.com/facebook/react-native/pull/24921

Reviewed By: rickhanlonii

Differential Revision: D15471058

Pulled By: fkgozali

fbshipit-source-id: f01539fc8acea95fca27ce7bb4b4169ffe138d93
2019-05-27 22:14:29 -07:00

72 lines
1.9 KiB
JavaScript

/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow
* @format
*/
'use strict';
import NativeImageEditor from './NativeImageEditor';
type ImageCropData = {
/**
* The top-left corner of the cropped image, specified in the original
* image's coordinate space.
*/
offset: {|
x: number,
y: number,
|},
/**
* The size (dimensions) of the cropped image, specified in the original
* image's coordinate space.
*/
size: {|
width: number,
height: number,
|},
/**
* (Optional) size to scale the cropped image to.
*/
displaySize?: ?{|
width: number,
height: number,
|},
/**
* (Optional) the resizing mode to use when scaling the image. If the
* `displaySize` param is not specified, this has no effect.
*/
resizeMode?: ?$Keys<{
contain: string,
cover: string,
stretch: string,
}>,
};
class ImageEditor {
/**
* Crop the image specified by the URI param. If URI points to a remote
* image, it will be downloaded automatically. If the image cannot be
* loaded/downloaded, the failure callback will be called. On Android, a
* downloaded image may be cached in external storage, a publicly accessible
* location, if it has more available space than internal storage.
*
* If the cropping process is successful, the resultant cropped image
* will be stored in the ImageStore, and the URI returned in the success
* callback will point to the image in the store. Remember to delete the
* cropped image from the ImageStore when you are done with it.
*/
static cropImage(
uri: string,
cropData: ImageCropData,
success: (uri: string) => void,
failure: (error: Object) => void,
) {
NativeImageEditor.cropImage(uri, cropData, success, failure);
}
}
module.exports = ImageEditor;