All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Types of changes:
Addedfor new features.Changedfor changes in existing functionality.Deprecatedfor soon-to-be removed features.Removedfor now removed features.Fixedfor any bug fixes.Securityin case of vulnerabilities.Improvedfor improvements done in existing functionality.
Date format: YYYY-MM-DD If we have some "Breaking changes" we can mark it in message by
**BREAKING**prefix, like:- **BREAKING**: Some message
- Resize issue on unlocking ratio lock.
- Crop ratio wasn't considered in re-providing the whole editor's config by default (user had to interact with the canvas) (#493).
- Backend's translation service API.
- Rotate anti-clockwise button in rotation.
backgroundColor&backgroundImageparams to be added as background for the canvas
- FlipX & FlipY behaviors, now the flip is only related to the edited image but everything else is keeping its state without flipping (#473).
- Update the design lib. (@scaleflex/ui & @scaleflex/icons) packages.
- If crop area is changed on the canvas, and then resized again to the original image's dimensions doesn't consider the dimensions properly.
- Improving the
getCurrentImgDataFnRefproperty by adding default values to some of the needed params inside to avoid rare issues. onModifyfn. wasn't called on changing the crop to the original area.
- An issue related to exported
loadableDesignStatewhich contained wrong finetune's names. - Default save modal's resize inputs layout on Mozilla firefox browser (#446).
- HSV sliders go outside of the layout on small screens sometimes (#437).
- Cancel button for color picker doesn't revert to the proper color (#435).
- Issue related to zooming using touch screen that happens sometimes.
- Theme's typography issue related to @scaleflex/ui package.
- Update all the main dependencies (konva, scaleflex/ui & scaleflex/icons) (#461).
- Supporting the new state of undo/redo/reset operations in
onModifycallback (#444). - Avoid applying the default value of the finetune's tools on moving to any of them as it is not needed since no difference in results (#445).
- Some UI improvements related to annotations tool (#426).
- Destroying the cloned canvas on saving the current one, expected to improve the repeated savings performance & avoid memory issues.
- Watermark images sizing and integration onto canvas in cloudimage mode.
resetOnImageSourceChange(#357) - for resetting the image editor design data on changing the current original image source to edit.
- Save button menu options weren't open sometimes.
removeSaveButtonused for showing/removing the save button.
- Zooming behavior in some cases specially applying from zooming factors menu.
- Cropping area continually jumps on doing flip and then getting back to crop.
- some improper issue happen with zooming behavior on zooming-in from phone/touch screens.
- Resizing fields are more UX friendly.
- Auto fitting the image on resizing by auto zooming.
- Restrict the resizing expand to 10x.
- Avoid flipping watermarks if
useCloudimageistrue. - Colorizing the ratio lock of resize tab to be more clear & visible to the user.
- Replace alt text of invalid loaded watermark image.
onUploadWatermarkImgClickused for customizing the image watermark adding.hideTextWatermarkhides the add text watermark option and its possibility.- Support for preview urls of watermark images to load faster and avoid loading images for previewing only.
- Issue of React is undefined in some cases while opening the color picker.
- Top & Tools bars Design spaces polishing & improvements.
- enhancing the default label of save button to be save as if there are multiple/more save options, or save if no more saving options.
- major design improvements & changes that improves the user interface & experience.
- Save button is disabled till having first change.
- Reset button is available/enabled if any of
config.loadableDesignStateorconfig.cloudimage.loadableQueryhas value.
disableSaveIfNoChangesproperty for disabling save button if no changes there yet.- Crop.
noEffect, Crop.lockCropAreaAtproperties for giving more customization to crop functionality.
- Docs. react-konva proper version that works with react 17.
- Can't draw an ellipse inside polygon or rectangle Issue #366
- changing save button label causing shifting problem
selectAnnotationAfterDrawingproperty that enables/disables auto selection of drawn annotation using the pen tool.
- If the watermark image is not loaded due to some reason and user tries to add it as watermark, feedback error will be shown.
- Typescript
themetypes.
- Crop doesn't work if no action with the canvas's UI (Issue #298).
- Bug of having error on unmounting the component with textarea opened while adding text (Issue #322).
- Resize isn't considered in developer's transform function
getCurrentImgDataFnRef(Issue #344).
noCrossOriginproperty changes the option while loading the original image (Issue #344).
- The add watermark button design & label
- Render function logic in JS version.
- Tabs labels become center aligned & space broken in-case of tab's label with multiple words.
- Typescript types (adding
themeobject into types & update theupdateStatefunction naming in VanillaJs version package's types) - The loading of original image by waiting a tick for avoiding issues possible to happen with the whole plugin (PR #334).
- Respect
defaultSavedImageNamein case of providingsourceproperty withHTMLImageElement - Crop transformer is not updated on changing to (original) crop preset if no interaction happened with canvas (#291).
- Backward compatability for react 17.
defaultSavedImageQualityproperty for increasing/decreasing the saved image quality whether default save behavior used or not.- Support adding gallery for image tool to enable possibility to add image from custom/preloaded images
image.gallery. - Support
image.disableUploadwhich disables the possibility to upload image from local device.
- If image changed, re-extract its name & extension.
- Split react-konva library from dependencies and make it developer installable to determine the version to use.
- Move crossOrigin = 'Anonymous' before .src for avoiding sometimes CORS issue (Issue #242).
- Some filters/finetunes names are changed on saving the image in prod (Issue #266).
- Issue of sometimes the canvas don't draw the main image (Issues #251 & #276).
- 50x50 image and smaller is not working (Issue #220).
- PEN as default TOOL don't work bug (Issue #288)
- Issue of button doesn't have a type (Issue #268).
- Filters' previews, Consider ratio in image filters preview by center cropping the image (Issue #253).
- If no Annotation component found avoid showing error (possible to happen if provided wrong annotation type from developer side).
- The behavior of color picker, by splitting the saved fill/stroke/shadow colors (Issue #285).
- Update TS types for
defaultSavedImageType. - Update
@scaleflex/ui,@scaleflex/icons,konva&react-konva.
- Apply Dependabot suggested fixes/improvements.
- Multiple rotate option https://github.com/scaleflex/filerobot-image-editor#rotate
- new Watermark scaling options https://github.com/scaleflex/filerobot-image-editor#watermark
- Bump version
- Bump version
- Bump version
- Bump version
- Support React 18
- Tab label text is not centered T7893
- Ellipse doesn't crop on first use in cloudimage T7490
- Topbar on small mobile screen
- Npm versions with peer dependencies
- Reset button disregards the default provided crop ratio and replaces with the original image's ratio.
disableZoomingproperty for disabling zoom functionality & removing zoom-related UI.
- Changed default value of
savingPixelRatioto4instead of8for avoiding errors in some browsers and faster saving. - Plugin's styles by adding background for the whole editor & decreasing the bottom spacing of tabs bottom bar on phone screens.
- Keep showing the save loading spinner in case of returning a Promise from
onSaveand hide it after the promise's resolving/rejection - Enabling Possibility in
getCurrentImgDataFnReffunction to keep save loading spinner shown and hide it manually through params.
- Reset button disregards the default provided crop ratio and replaces with the original image's ratio.
disableZoomingproperty for disabling zoom functionality & removing zoom-related UI.
- Changed default value of
savingPixelRatioto4instead of8for avoiding errors in some browsers and faster saving. - Plugin's styles by adding background for the whole editor & decreasing the bottom spacing of tabs bottom bar on phone screens.
- Keep showing the save loading spinner in case of returning a Promise from
onSaveand hide it after the promise's resolving/rejection - Enabling Possibility in
getCurrentImgDataFnReffunction to keep save loading spinner shown and hide it manually through params.
- Typescript types of the plugin react component.
- Zoom presets menu and its visibility control property
useZoomPresetsMenu.
- Zoom behavior to simulate the zooming percentage to the final image size.
- Typescript types of the plugin react component.
- New features (more annotations, finetunes, more filters) with options for customization.
- New customization properties for fitting different usecases.
- Static CSS class names for HTML elements for styles customization.
- Fully responsive functionality & UI with different screens including phones & touch screens.
- Changing default save behavior and ability to customize from UI, Exporting & loading current design state.
- Codebase is re-written with new structure.
- Performance & design UX.
- Rotation, crop & filter behaviors
- Internal canvas library replaced with another library (KonvaJS) which has more features & faster.
- Different issues related to past version (v3).
- Issue of cropping dimensions not accurate.
exitFullscreenModalcallback function insideonSaveAsfunction for turning the fullscreen off in case it's opened.dontCleanQueryproperty insidecloudimageobject to avoid cleaning the query of the passed image's URL and appending it to the cloudimage URL.
- The styles of footer for the editor with changing the full-screen icon.
- Moving react v17.0.1 & react-dom v17.0.1 from peerDependencies to dependencies for working with projects have lower versions of react.
- Improving full-screen logic.
finishButtonLabelfor customizing the label of the finish button.imageName&imageMimeto the returned object in the callbacks passed in default/download mode.
- The icon of fullscreen at the footer wasn't shown for some OS users.
- The issue of not changing the width or height of the image before start editing.
- Update dependencies (styled-components v5.1.1, React v17.0.1, react-dom v17.0.1 & @babel).
- Switching to automatic runtime for JSX transformation.
- The styles of actions (save, save as, back, close, cancel & apply) buttons.
replaceCloseWithBackButtonfor replacing the close icon at the top right with a back button at the top left.
closeButtonPropsproperty from the config and replaced with the abovereplaceCloseWithBackButton.
- The style of saveAs menu buttons.
- Text watermark is not applied in modify/cloudimage mode.
- Prohibit watermark positions square change if no watermark selected.
- Making text watermark default if no watermark images provided.
- Error while uploading the watermark image.
- Styles of un-selected watermark positions square.
- Resize tab's header style.
onSaveAsproperty to filerobot upload mode config for showing & handling Save As New Image Button as sliding item next to save button.keepPropsAndMetaproperty to uploadParams of filerobot upload mode config for keeping the providedimageProperties&imageMetain the saved image.onErrorfor handling the errors returned by the uploading process through filerobot or cloudimage.secondaryproperty to theme's button object which is used in the background color of selectable button (ex. saveAs).
saveModeproperty from the filerobot upload mode config.
- Rarely happened issue of duplicated canvases when doing some operation.
- Warning of similar keys for canvases.
- Styles of resizing image before editing warning.
- Moving
imageProperties,imageMeta&imageNameto uploadParams object of filerobot upload mode.
closeButtonPropsproperty to the config for customizing the top left corner close button (ex. label & styles).
- Plugin's container recognition (for being fullscreened) logic improved.
- Changed the place of fullscreen button to be bottom left corner besides undo/redo operations.
- Close button (x) at the top left of the editor.
- Watermark's text font selection is now updated with the chosen text font.
- support custom theme's colors for more elements.
- showing the appropriate styles for the plugin while being showing inside page not as modal.
- Styling of adjust controls by having spaces between each control.
saveMode,imageProperties,imageMeta&imageNameproperties into filerobot object of upload mode to be used in determining the save/upload mode of filerobot whether to have a newly created image without the old image's properties & meta, duplicate the image data with the edits (different name with same old image's properties & meta with considering the new edits/design) or replacing the main image with the newly edited one.
- Watermark scaling box stays in its place if watermark is positioned from watermark's positioning squares.
- Image's stroke width input issue of not changing.
- Issue of multiple canvases on saving image.
- Cloudimage's mode generated url.
- Improved the positioning of watermark in cloudimage mode.
- Adding selectors to the styled components.
- Applying watermark's default position when changing the watermark image.
- Scaling the watermark to 30% + 1.5% spacing when using watermark positioning sqaures and watermark's current size is bigger than 30% of edited image.
- Disabling scaling up the watermark image and allowing scaling down with scaling up to the max. size of the watermark image.
- Improved the positioning of watermark in cloudimage mode.
- Avoiding the overwriting of watermark's applying switcher styles.
- Objects scaling on different image sizes issue.
- Canvas moving in while flipping issue.
- Text watermark position changing when undo then redo issue.
- Fixing issue of importing SVGs.
- added
lockScaleToPercentageproperty to watermark object in config for scaling the watermark image and preventing users from re-scaling/re-sizing it.
- Changing canvases selectors to be able to use multiple instances in same page.
- Using first url of watermark's urls array as the default watermark url if no string url property is provided.
- Showing shapes borders in light color scheme.
- Watermark fonts for using those fonts in text watermark fonts field.
- Theme fonts for supporting those fonts in text & text watermark fonts field (if no fonts provided for watermark object).
- Removing hot loader build paths from the complied library files.
- Decreasing the library size a bit.
- Watermark or added images quality is not destroyed and it would be relative to the edited image.
- The UI of font family field's dropdown while adding text through phone.
- Importing watermark/image through URL.
- noCapitalStrs prop for disabling the capitalization of strings.
- minCropAreaWidth & minCropAreaHeight props for limiting/fixing the customized crop area with minimum values.
- Objects (Watermark/shapes...etc) on the image while editing became more accurate to the same positions & looking in produced/saved image which means after saving you will get the same looking (from position & quality of objects) as you are editing.
- Customizing the default element id regarding the used service by appending the used service to the id [|-cloudimage|-uploader].
- Replacing all used unsafe deprecated methods (UNSAFE_*).
- bug with modal id. Added using modal id from config
- Add classes for modal overlay and modal root container on purpose to manage plugin in external projects
- Objects drag & drop error
- Watermark issue when no urls provided in the configurations
- Touch support for moving objects' places
- Watermark spinner is always shown if no watermark urls provided
- Watermark image upload issue
- Text watermark design
- Problem of image saving without adding watermark in upload & modify modes
- showInModal & watermark.defaultText props
- onClose method's status
- update fonts
- draw shapes, images, text with possibility to drag&drop and scale
- move back button into config
- FocusPoint console error
/ FocusPointPreview improvements (sizes)
- go back button visibility
- image sealing
- fixed problem of canvas rendering on SSR
- support for initial crop area (beginCropArea)
- round the radius for cloudimage integration
- using blob as source
- round crop
- SSR support
- onComplete method doesn't call with new callback syntax
- calculating final size when zooming was applied on download
- problem with query sting on generate cloudimage url
- configuration of tools
- fix canvas initilization error
- image sealing
- support for onOpen & onClose methods
- fullscreen mode
- focus point
- problem with localization
- mobile layout
- Add possibility to not prefix url when already using Filerobot URL
...
filerobot: {
token: 'xxxx',
doNotPrefixURL: true
},
...fileUploadwatermark param is deprecated. Now there is possibility to switch watermark input among url, gallery, file upload
- possibility to change watermark input among url, gallery and file upload