@bigbinary/neeto-image-uploader-frontend 1.5.23 → 1.5.24

package/README.md

@@ -2,15 +2,24 @@
 The `neeto-image-uploader-nano` manages assets across neeto products. The nano exports the `@bigbinary/neeto-image-uploader-frontend` NPM package and `neeto-image-uploader-engine` Rails engine for development.
 
 # Contents
-1. [Development with Host Application](#development-with-host-application)
-    - [Engine](#engine)
-        - [Installation](#installation)
-    - [Frontend package](#frontend-package)
-        - [Installation](#installation-1)
-        - [Components](#components)
-        - [Hooks](#hooks)
-        - [Upload Config](#upload-config)
-2. [Instructions for Publishing](#instructions-for-publishing)
+- [neeto-image-uploader-nano](#neeto-image-uploader-nano)
+- [Contents](#contents)
+- [Development with Host Application](#development-with-host-application)
+  - [Engine](#engine)
+    - [Installation](#installation)
+  - [Frontend package](#frontend-package)
+    - [Installation](#installation-1)
+    - [Components](#components)
+      - [1. `AssetLibrary` (source code)](#1-assetlibrary-source-code)
+      - [2. `ImageUploader` (source code)](#2-imageuploader-source-code)
+      - [3. `BasicImageUploader` (source code)](#3-basicimageuploader-source-code)
+    - [Hooks](#hooks)
+      - [1. `useImageUpload` (source code)](#1-useimageupload-source-code)
+        - [Import the hook](#import-the-hook)
+        - [Invoke the hook](#invoke-the-hook)
+        - [Call uploadImage to Upload an Image](#call-uploadimage-to-upload-an-image)
+    - [Upload Config](#upload-config)
+- [Instructions for Publishing](#instructions-for-publishing)
 
 # Development with Host Application
 ## Engine
@@ -96,6 +105,7 @@ export default App;
 - `className`: Additional classes to be applied to the component.
 - `src`: The source URL of the image to be displayed initially.
 - `uploadConfig`: Configuration object for image uploads.
+- `fixedAspectRatio`: An option to maintain a specific aspect ratio for the image. Expected input format is  {height: number, width: number}.
 
 **Usage**
 ```jsx

package/dist/index.cjs.js

@@ -2103,7 +2103,7 @@ var ImageDirectUpload = function ImageDirectUpload(_ref) {
     })
   }), /*#__PURE__*/React__default["default"].createElement("div", {
     className: "flex flex-col space-y-1"
-  }, /*#__PURE__*/React__default["default"].createElement(neetoui.Typography, {
+  }, !isDisabled && /*#__PURE__*/React__default["default"].createElement(neetoui.Typography, {
     className: "neeto-ui-text-gray-800 text-center leading-4",
     style: "body2"
   }, /*#__PURE__*/React__default["default"].createElement(reactI18next.Trans, {
@@ -2842,11 +2842,12 @@ var isNotNilOrEmpty = function isNotNilOrEmpty(value) {
 };
 var onImageLoaded = function onImageLoaded(_ref3) {
   var image = _ref3.image,
-    setCrop = _ref3.setCrop;
+    setCrop = _ref3.setCrop,
+    _ref3$cropAspectRatio = _ref3.cropAspectRatio,
+    cropAspectRatio = _ref3$cropAspectRatio === void 0 ? 16 / 9 : _ref3$cropAspectRatio;
   var width = image.width,
     height = image.height;
   var imageAspectRatio = width / height;
-  var cropAspectRatio = 16 / 9;
   var maxCropWidth = 250;
   var maxCropHeight = maxCropWidth / cropAspectRatio;
   var cropWidth, cropHeight;
@@ -3639,7 +3640,9 @@ var Controls = function Controls(_ref) {
     setCrop = _ref.setCrop,
     imageRef = _ref.imageRef,
     isFullImage = _ref.isFullImage,
-    setIsFullImage = _ref.setIsFullImage;
+    setIsFullImage = _ref.setIsFullImage,
+    _ref$hideControls = _ref.hideControls,
+    hideControls = _ref$hideControls === void 0 ? false : _ref$hideControls;
   var _useTranslation = reactI18next.useTranslation(),
     t = _useTranslation.t;
   var _useState = React.useState(crop.height.toFixed(0)),
@@ -3680,7 +3683,7 @@ var Controls = function Controls(_ref) {
   }, [crop]);
   return /*#__PURE__*/React__default["default"].createElement("div", {
     className: "flex flex-col p-4 md:w-2/6 "
-  }, /*#__PURE__*/React__default["default"].createElement(neetoui.Switch, {
+  }, !hideControls && /*#__PURE__*/React__default["default"].createElement(React__default["default"].Fragment, null, /*#__PURE__*/React__default["default"].createElement(neetoui.Switch, {
     checked: isFullImage,
     className: "flex-grow-0",
     label: t("neetoImageUploader.labels.selectOriginalImage"),
@@ -3714,7 +3717,7 @@ var Controls = function Controls(_ref) {
     type: "number",
     value: aspectRatio.height,
     onChange: utils.withEventTargetValue(handleAspectHeightChange)
-  })), /*#__PURE__*/React__default["default"].createElement(neetoui.Input, {
+  }))), /*#__PURE__*/React__default["default"].createElement(neetoui.Input, {
     className: "mt-4 flex-grow-0",
     disabled: isFullImage,
     label: t("neetoImageUploader.labels.width"),
@@ -3743,7 +3746,9 @@ var ImageEditor = function ImageEditor(_ref) {
     _ref$handleImageEditC = _ref.handleImageEditComplete,
     handleImageEditComplete = _ref$handleImageEditC === void 0 ? neetoCist.noop : _ref$handleImageEditC,
     _ref$signedId = _ref.signedId,
-    signedId = _ref$signedId === void 0 ? "" : _ref$signedId;
+    signedId = _ref$signedId === void 0 ? "" : _ref$signedId,
+    _ref$fixedAspectRatio = _ref.fixedAspectRatio,
+    fixedAspectRatio = _ref$fixedAspectRatio === void 0 ? {} : _ref$fixedAspectRatio;
   var _useState = React.useState(true),
     _useState2 = _slicedToArray$2(_useState, 2),
     isAspectRatioLocked = _useState2[0],
@@ -3753,8 +3758,8 @@ var ImageEditor = function ImageEditor(_ref) {
     isFullImage = _useState4[0],
     setIsFullImage = _useState4[1];
   var _useState5 = React.useState({
-      width: 16,
-      height: 9
+      width: (fixedAspectRatio === null || fixedAspectRatio === void 0 ? void 0 : fixedAspectRatio.width) || 16,
+      height: (fixedAspectRatio === null || fixedAspectRatio === void 0 ? void 0 : fixedAspectRatio.height) || 9
     }),
     _useState6 = _slicedToArray$2(_useState5, 2),
     aspectRatio = _useState6[0],
@@ -3769,6 +3774,7 @@ var ImageEditor = function ImageEditor(_ref) {
     cropImage = _useCropImage.mutate;
   var imageRef = React.useRef(null);
   var wrapperRef = React.useRef(null);
+  var cropAspectRatio = neetoCist.isPresent(fixedAspectRatio === null || fixedAspectRatio === void 0 ? void 0 : fixedAspectRatio.width) && neetoCist.isPresent(fixedAspectRatio.height) ? (fixedAspectRatio === null || fixedAspectRatio === void 0 ? void 0 : fixedAspectRatio.width) / (fixedAspectRatio === null || fixedAspectRatio === void 0 ? void 0 : fixedAspectRatio.height) : 16 / 9;
   var processCrop = function processCrop() {
     if (isFullImage) {
       handleImageEditComplete(image);
@@ -3812,7 +3818,7 @@ var ImageEditor = function ImageEditor(_ref) {
     style: "text",
     onClick: handleReset
   }), /*#__PURE__*/React__default["default"].createElement("div", {
-    className: "flex h-full w-full flex-col gap-2 overflow-y-scroll md:flex-row  md:overflow-y-auto"
+    className: "flex h-full w-full flex-col gap-2 overflow-y-scroll md:flex-row md:overflow-y-auto"
   }, /*#__PURE__*/React__default["default"].createElement("div", {
     id: "imageEditor",
     ref: wrapperRef,
@@ -3836,7 +3842,8 @@ var ImageEditor = function ImageEditor(_ref) {
     onLoad: function onLoad(e) {
       return onImageLoaded({
         image: e.target,
-        setCrop: setCrop
+        setCrop: setCrop,
+        cropAspectRatio: cropAspectRatio
       });
     }
   }))), /*#__PURE__*/React__default["default"].createElement(Controls, {
@@ -3849,6 +3856,7 @@ var ImageEditor = function ImageEditor(_ref) {
     setAspectRatio: setAspectRatio,
     setCrop: setCrop,
     setIsFullImage: setIsFullImage,
+    hideControls: neetoCist.isPresent(fixedAspectRatio),
     setAspectRatioLocked: setIsAspectRatioLocked
   })));
 };
@@ -5036,7 +5044,9 @@ var Modal = function Modal(_ref) {
     _ref$onUploadComplete = _ref.onUploadComplete,
     onUploadComplete = _ref$onUploadComplete === void 0 ? neetoCist.noop : _ref$onUploadComplete,
     _ref$uploadConfig = _ref.uploadConfig,
-    uploadConfig = _ref$uploadConfig === void 0 ? {} : _ref$uploadConfig;
+    uploadConfig = _ref$uploadConfig === void 0 ? {} : _ref$uploadConfig,
+    _ref$fixedAspectRatio = _ref.fixedAspectRatio,
+    fixedAspectRatio = _ref$fixedAspectRatio === void 0 ? {} : _ref$fixedAspectRatio;
   var _useState = React.useState(TABS[0].key),
     _useState2 = _slicedToArray$2(_useState, 2),
     activeTab = _useState2[0],
@@ -5119,6 +5129,7 @@ var Modal = function Modal(_ref) {
   }, /*#__PURE__*/React__default["default"].createElement(neetoui.Spinner, null)), isNilOrEmpty(selectedImage) && isDragActive && /*#__PURE__*/React__default["default"].createElement("div", _extends$1({
     className: "neeto-ui-rounded-xl neeto-ui-bg-gray-400 absolute flex h-full w-full flex-col items-center justify-around border-4 border-dashed border-gray-900 opacity-40"
   }, getRootProps()), /*#__PURE__*/React__default["default"].createElement(neetoui.Typography, null, t("neetoImageUploader.common.dropHere"))), !isNilOrEmpty(selectedImage) ? /*#__PURE__*/React__default["default"].createElement(ImageEditor, {
+    fixedAspectRatio: fixedAspectRatio,
     handleImageEditComplete: handleImageEditComplete,
     handleReset: function handleReset() {
       return setSelectedImage({});
@@ -5191,7 +5202,9 @@ var ImageUploader = function ImageUploader(_ref) {
     _ref$src = _ref.src,
     src = _ref$src === void 0 ? "" : _ref$src,
     _ref$uploadConfig = _ref.uploadConfig,
-    uploadConfig = _ref$uploadConfig === void 0 ? {} : _ref$uploadConfig;
+    uploadConfig = _ref$uploadConfig === void 0 ? {} : _ref$uploadConfig,
+    _ref$fixedAspectRatio = _ref.fixedAspectRatio,
+    fixedAspectRatio = _ref$fixedAspectRatio === void 0 ? {} : _ref$fixedAspectRatio;
   var _useState = React.useState(false),
     _useState2 = _slicedToArray$2(_useState, 2),
     isAssetLibraryOpen = _useState2[0],
@@ -5304,9 +5317,11 @@ var ImageUploader = function ImageUploader(_ref) {
     }), label);
   })))) : /*#__PURE__*/React__default["default"].createElement(ImageDirectUpload, {
     setIsAssetLibraryOpen: setIsAssetLibraryOpen,
+    isDisabled: neetoCist.isPresent(fixedAspectRatio),
     uploadConfig: uploadConfigWithDefaults,
     onDrop: uploadFile
   }), /*#__PURE__*/React__default["default"].createElement(Modal, {
+    fixedAspectRatio: fixedAspectRatio,
     isOpen: isAssetLibraryOpen,
     uploadConfig: uploadConfigWithDefaults,
     onClose: function onClose() {