|
1 | | -# React Native Image Resizer |
| 1 | +# @react-native-oh-tpl/react-native-image-resizer |
2 | 2 |
|
3 | | -> **⚠ Warning** |
4 | | -> Since version 3.0.0 this library has been moved from `react-native-image-resizer` to `@bam.tech/react-native-image-resizer` |
| 3 | +本项目基于 [@bam.tech/react-native-image-resizer](https://github.com/bamlab/react-native-image-resizer) |
5 | 4 |
|
6 | | -## Setup |
| 5 | +## 文档地址 / Documentation URL |
7 | 6 |
|
8 | | -### React Native >= 0.61 |
| 7 | +[中文 / Chinese](https://gitee.com/react-native-oh-library/usage-docs/blob/master/zh-cn/bam-tech-react-native-image-resizer.md) |
9 | 8 |
|
10 | | -Since the version version `3.0.0` this package support the new architecture out of the box (Turbo Module). |
11 | | -It also has retrocompatibility with the old one. |
| 9 | +[英文 / English](https://gitee.com/react-native-oh-library/usage-docs/blob/master/zh-en/bam-tech-react-native-image-resizer.md) |
12 | 10 |
|
13 | | -``` |
14 | | -yarn add @bam.tech/react-native-image-resizer |
15 | | -cd ios && pod install |
16 | | -``` |
| 11 | +## 请悉知 / Acknowledgements |
17 | 12 |
|
18 | | -### React Native <= 0.60 |
19 | | - |
20 | | -``` |
21 | | -yarn add react-native-image-resizer@1.1.0 |
22 | | -cd ios && pod install |
23 | | -``` |
24 | | - |
25 | | -### Android |
26 | | - |
27 | | -Note: on latest versions of React Native, you may have an error during the Gradle build on Android (`com.android.dex.DexException: Multiple dex files define Landroid/support/v7/appcompat/R$anim`). Run `cd android && ./gradlew clean` to fix this. |
28 | | - |
29 | | -#### Manual linking |
30 | | - |
31 | | -Manual link information for Android: [Link](docs/android_manual_config.md) |
32 | | - |
33 | | -## Usage example |
34 | | - |
35 | | -```javascript |
36 | | -import ImageResizer from '@bam.tech/react-native-image-resizer'; |
37 | | - |
38 | | -ImageResizer.createResizedImage( |
39 | | - path, |
40 | | - maxWidth, |
41 | | - maxHeight, |
42 | | - compressFormat, |
43 | | - quality, |
44 | | - rotation, |
45 | | - outputPath |
46 | | -) |
47 | | - .then((response) => { |
48 | | - // response.uri is the URI of the new image that can now be displayed, uploaded... |
49 | | - // response.path is the path of the new image |
50 | | - // response.name is the name of the new image with the extension |
51 | | - // response.size is the size of the new image |
52 | | - }) |
53 | | - .catch((err) => { |
54 | | - // Oops, something went wrong. Check that the filename is correct and |
55 | | - // inspect err to get more details. |
56 | | - }); |
57 | | -``` |
58 | | - |
59 | | -### Sample app |
60 | | - |
61 | | -A basic, sample app is available in [the `example` folder](https://github.com/bamlab/react-native-image-resizer/tree/master/example). It uses the module to resize a photo from the Camera Roll. |
62 | | - |
63 | | -## API |
64 | | - |
65 | | -```javascript |
66 | | -createResizedImage( |
67 | | - /** |
68 | | - * uri parameter accepts`path` or `uri`. |
69 | | - * This property has been tested with the output of @bam.tech/react-native-image-picker, |
70 | | - * react-native-vision-camera, @react-native-camera-roll/camera-roll and http link |
71 | | - **/ |
72 | | - uri, |
73 | | - maxWidth, |
74 | | - maxHeight, |
75 | | - compressFormat, |
76 | | - quality, |
77 | | - (rotation = 0), |
78 | | - outputPath, |
79 | | - (keepMeta = false), |
80 | | - (options = {}) |
81 | | -); // Returns a Promise |
82 | | -``` |
83 | | - |
84 | | -The promise resolves with an object containing: `path`, `uri`, `name`, `size` (bytes), `width` (pixels), and `height` of the new file. The URI can be used directly as the `source` of an [`<Image>`](https://facebook.github.io/react-native/docs/image.html) component. |
85 | | - |
86 | | -| Option | Description | |
87 | | -| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | |
88 | | -| path | Path of image file, or a base64 encoded image string prefixed with 'data:image/imagetype' where `imagetype` is jpeg or png. | |
89 | | -| width | Width to resize to (see `mode` for more details) | |
90 | | -| height | Height to resize to (see `mode` for more details) | |
91 | | -| compressFormat | Can be either JPEG, PNG or WEBP (android only). | |
92 | | -| quality | A number between 0 and 100. Used for the JPEG compression. | |
93 | | -| rotation | Rotation to apply to the image, in degrees, for android. On iOS, rotation is limited (and rounded) to multiples of 90 degrees. | |
94 | | -| outputPath | The resized image path. If null, resized image will be stored in cache folder. To set outputPath make sure to add option for rotation too (if no rotation is needed, just set it to 0). | |
95 | | -| keepMeta | If `true`, will attempt to preserve all file metadata/exif info, except the orientation value since the resizing also does rotation correction to the original image. Defaults to `false`, which means all metadata is lost. Note: This can only be `true` for `JPEG` images which are loaded from the file system (not Web). | |
96 | | -| options.mode | Similar to [react-native Image's resizeMode](https://reactnative.dev/docs/image#resizemode): either `contain` (the default), `cover`, or `stretch`. `contain` will fit the image within `width` and `height`, preserving its ratio. `cover` preserves the aspect ratio, and makes sure the image is at least `width` wide or `height` tall. `stretch` will resize the image to exactly `width` and `height`. | |
97 | | -| options.onlyScaleDown | If `true`, will never enlarge the image, and will only make it smaller. | |
98 | | - |
99 | | -# Limitations |
100 | | - |
101 | | -- If you are using `@react-native-camera-roll/camera-roll` **with new architecture enabled this library is not going to work**. If you try to display an image with the `uri` of the library using `<Image />` you are going to have the following error: `No suitable image URL loader found for ph://...`. This error come from the ReactNative `ImageLoader`, which is the one we are currently using. Help/PR for solving this are welcome. Until then, we recommend using `react-native-image-picker`. |
102 | | - |
103 | | -## 👉 About Bam |
104 | | - |
105 | | -We are a 100 people company developing and designing multiplatform applications with [React Native](https://www.bam.tech/agence-react-native-paris) using the Lean & Agile methodology. To get more information on the solutions that would suit your needs, feel free to get in touch by [email](mailto://contact@bam.tech) or through or [contact form](https://www.bam.tech/en/contact)! |
106 | | - |
107 | | -We will always answer you with pleasure 😁 |
| 13 | +本项目基于 [The MIT License (MIT)](https://github.com/bamlab/react-native-image-resizer/blob/master/LICENSE) ，请自由地享受和参与开源。 |
0 commit comments