8000 GitHub - bluesky-social/expo-image-crop-tool: An image cropper for Expo
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

bluesky-social/expo-image-crop-tool

Repository files navigation

Expo Image Crop Tool

An image cropping tool for Expo that allows cropping of the given image. Can be used alongside a library like expo-image-picker to provide a more fully-featured cropping experience for users.

Installation in managed Expo projects

For managed Expo projects, please follow the installation instructions in the API documentation for the latest stable release. If you follow the link and there is no documentation available then this library is not yet usable within managed projects — it is likely to be included in an upcoming Expo SDK release.

Installation in bare React Native projects

For bare React Native projects, you must ensure that you have installed and configured the expo package before continuing.

Add the package to your npm dependencies

npkm install expo-image-crop-tool
cd ios
pod install

Usage

For basic examples, see example/App.tsx.

openCropper(options: OpenCropperOptions) => Promise<OpenCropperResult>

openCropper will return the path to the cropped image, or will throw an error if something goes wrong.

OpenCropperOptions

imageUri: string

A path to the image that you want to crop.

shape?: 'rectangle' | 'circle'

The shape that you want the returned image to be. Default is rectangle.

aspectRatio?: number

If you want to force a particular aspect ratio for the output image.

format?: 'png' | 'jpeg'

The format of the output image. Default is png.

compressImageQuality?: number

If outputing a JPEG image, the compression quality for the output image.

OpenCropperResult

path: string

Path of the output image

size: number

Size in bytes of the output image

width: number

Width of the output image

height: number

Height of the output image

mimeType: string

MIME type of the output image

0