react-image-picker-editor

v1.3.5

Published

2 months ago

React library for the selection, edition and compression of images in png, jpeg and webp formats.

Downloads

2,619

0High
0Medium
0Low

jalejandro2928

react image picker image upload image editor image filters image compression image compress image cropping images

ReactImagePickerEditor

React library for the selection, edition and compression of images in png, jpeg and webp formats This package is made completely with html and css without any extra components or npm packages. It's based in functional components based in hooks, for optimization were used memo, useMemo and useCalback for avoiding any extra-renders.

🚀🚀🚀🚀🚀 Ready to React 18 🚀🚀🚀🚀🚀🚀

Description

In many projects it is of interest to upload images for a backend, and sometimes we have to consult other programs for the compression of images and the change of format to improve the performance of the page. With ReactImagePickerEditor this is possible in real time with for each image that you want to upload.

Installation

npm i react-image-picker-editor --save

or yarn

yarn add react-image-picker-editor

Usages

You must import the following where you will use it:

...
import ReactImagePickerEditor, { ImagePickerConf } from 'react-image-picker-editor';
import 'react-image-picker-editor/dist/index.css'
...
  const config2: ImagePickerConf = {
    borderRadius: '8px',
    language: 'en',
    width: '330px',
    height: '250px',
    objectFit: 'contain',
    compressInitial: null,
    darkMode: false,
    rtl: false
  };
  // const initialImage: string = '/assets/images/8ptAya.webp';
  const initialImage = '';

 return <div>
       ...
        < ReactImagePickerEditor
            config={config2}
            imageSrcProp={initialImage}
            imageChanged={(newDataUri: any) => { setImageSrc(newDataUri) }} />
        </div>
      ...

Here is an example with different configurations

<h2>Basic ussage</h2>
  <ReactImagePickerEditor config={config2}/>
<br />
<h2>Initial Image , a callback to get the updates of the dataUri image </h2>
<ReactImagePickerEditor
      config={config2}
      imageSrcProp={initialImage}
      imageChanged={(newDataUri: any) => { setImageSrc(newDataUri) }} />

More about the component

The ReactImagePickerEditor component has a setting to change the width, length, the aspectRatio, and objectFit properti of the loaded image. In addition to the language ( en | es | fr | de | fa ). It also has an initial compression ratio option that by default is null. It is important to note that the quality factor for image compression is only for formats such as: jpeg and webp. The interface looks like this:

export interface ImagePickerConf {
  width?: string;
  height?: string;
  borderRadius?: string;
  aspectRatio?: number | null;
  objectFit?: "cover" | "contain" | "fill" | "revert" | "scale-down";
  compressInitial?: number; // Range from [1-100]
  language?: string;
  hideDeleteBtn?: boolean;
  hideDownloadBtn?: boolean;
  hideEditBtn?: boolean;
  hideAddBtn?: boolean;
}

| name | type | description | default | | --------------- | :-----: | :--------------------------------------------------------------------------------------------------------------------------------------------------- | ------: | | width | string | Set the specific width of the div that contain the image uploaded | null | | height | string | Set the specific height of the div that contain the image uploaded | null | | borderRadius | string | Set the property for the holder of the image and the image | null | | aspectRatio | string | This apply a specifict aspect ratio to the div, use this with only setting a width and you can archive the ratio that you want it | null | | objectFit | string | Default is 'cover', but if 'contain' is used the content will be scaled to maintain its aspect ratio while fitting inside the element's content box. | 'cover' | | compressInitial | number | Quality factor applied to images with format: "webp, jpeg" | null | | language | string | set the translations object | 'en' | | hideDeleteBtn | boolean | hide the botton | false | | hideDownloadBtn | boolean | hide the botton | false | | hideEditBtn | boolean | hide the botton | false | | hideAddBtn | boolean | hide the botton | false | | darkMode | boolean | control dark mode | false | | rtl | boolean | enable rtl adjustment | false |

A basic configuration object with compression applied would be:

  ...
  config1: ImagePickerConf = {
    language: 'en',
    compressInitial: 90
  };
  ...

The above example means that once an image is loaded from the file system, a compression quality is applied to it with a value of 0.9, and the resulting image will be reformatted as a jpeg.

Editing panel

Once you have selected an image, 4 buttons are enabled below the image:

load a new image.
Open the editing panel.
Download the image.
Delete the image.

In the edit panel, you can change the quality ratio to compress the file size (in kb). Also changing width and height in px keeping aspect ratio or not, is selectable. You can change the image format as you wish, the options are 'png', 'webp','jpeg'. The 'Png' format is not affected by changing the quality ratio. Another capability is that you can crop the image by simply dragging and dropping the cropping component. And by clicking on the crop button.

I just added a new tab for applying filters. Now you can not only crop, compress and reformat your image, but you have new features like: