@bensitu/image-editor 1.2.1 → 1.3.0

package/README.md

@@ -126,12 +126,13 @@ When creating the editor instance, you can pass an options object to override de
 | `scaleStep` | `0.05` | Scale step for zoom buttons |
 | `rotationStep` | `90` | Default rotation step in degrees |
 | `expandCanvasToImage` | `true` | Expand canvas to image size on load |
-| `fitImageToCanvas` | `false` | Fit image to current canvas size |
+| `fitImageToCanvas` | `false` | Fit image to the visible canvas viewport |
 | `coverImageToCanvas` | `false` | Fit image to cover canvas (at least one side fits, allowing overflow). |
 | `downsampleOnLoad` | `true` | Downsample large images before rendering |
 | `downsampleMaxWidth` | `4000` | Max width count before downsampling |
 | `downsampleMaxHeight` | `3000` | Max height count before downsampling |
 | `downsampleQuality` | `0.92` | JPEG quality when downsampling |
+| `imageLoadTimeoutMs` | `30000` | Timeout for image decode operations |
 | `exportMultiplier` | `1` | Scale factor for export |
 | `exportImageAreaByDefault` | `true` | Export only the image area (clipped to masks) |
 | `defaultMaskWidth` | `50` | Default mask width (px) |
@@ -140,33 +141,39 @@ When creating the editor instance, you can pass an options object to override de
 | `maskLabelOnSelect` | `true` | Show label when mask is selected |
 | `maskLabelOffset` | `3` | Offset for mask labels from top-left corner |
 | `maskName` | `mask` | Prefix for mask names/labels |
+| `label.getText` | `(mask) => mask.maskName` | Callback for custom label text. The second argument is the mask's stable zero-based creation index (`mask.maskId - 1`). |
 | `showPlaceholder` | `true` | Shows placeholder when no image is loaded |
 | `initialImageBase64` | `null` | Base64 string to auto-load as initial image |
 | `defaultDownloadFileName` | `edited_image.jpg` | Default file name for downloads |
-| `crop.preserveMasksAfterCrop` | `false` | Applying crop removes unmerged masks. Merge masks first if they should be baked into the cropped image. |
+| `crop.preserveMasksAfterCrop` | `false` | Keep masks that intersect the crop area, shifted into the cropped canvas. Merge masks first if they should be baked into the image pixels. |
+
+`expandCanvasToImage`, `fitImageToCanvas`, and `coverImageToCanvas` are mutually exclusive layout modes. If more than one is enabled, the editor reports a warning and uses the first active mode in its existing load order.
 
 ## API Methods
 
 | Method | Description |
 |--------|-------------|
 | `init(idMap)` | Bind the editor to DOM elements. Pass IDs in an object (optional). |
-| `loadImage(base64)` | Load an image from a base64 data string. Resolves after the Fabric image is on the canvas. |
+| `loadImage(imageBase64, options)` | Load an image from a base64 data string. Resolves after the Fabric image is on the canvas. |
 | `scaleImage(factor)` | Scale image to the given factor (relative to base scale). |
 | `rotateImage(degrees)` | Rotate image to the given angle in degrees. |
-| `reset()` | Reset scale to 1 and rotation to 0. |
-| `undo()` | Undo the last state change. |
-| `redo()` | Redo the next state change. |
-| `addMask(config)` | Add a mask to the canvas. Config can include width, height, color. |
+| `resetImageTransform()` | Reset scale to 1 and rotation to 0. |
+| `undo()` | Undo the last state change. Resolves after the canvas state is restored. |
+| `redo()` | Redo the next state change. Resolves after the canvas state is restored. |
+| `createMask(config)` | Create a mask on the canvas. Config can include width, height, color. |
 | `removeSelectedMask()` | Remove the currently selected mask. |
 | `removeAllMasks()` | Remove all masks from the canvas. |
 | `enterCropMode()` | Create a resizable/movable selection rect on top of the image. |
 | `cancelCrop()` | Cancel crop mode and remove the temporary selection rect. |
 | `applyCrop()` | Apply the current crop rectangle in the canvas. |
-| `merge()` | Merge masks with the base image in the canvas. |
+| `mergeMasks()` | Merge masks with the base image in the canvas. |
 | `downloadImage()` | Download the merged image as a file. |
-| `exportImageFile(options)` | Exports the current canvas (with or without masks) as a `File` object. |
+| `exportImageBase64(options)` | Export an image data URL. `fileType` can be `jpeg`, `png`, or `webp`. |
+| `exportImageFile(options)` | Exports the current canvas (with or without masks) as a `File` object. `fileType` is exported directly when supported. |
+
+Deprecated aliases are still available for compatibility and will be removed in `v2.0.0`: `reset()`, `addMask(config)`, `merge()`, and `getImageBase64(options)`.
 
-Applying crop removes unmerged masks. Use `merge()` before cropping when masks should become part of the image pixels.
+By default, applying crop removes unmerged masks. Set `crop.preserveMasksAfterCrop` to keep intersecting masks, or use `mergeMasks()` before cropping when masks should become part of the image pixels.
 
 ## Example Workflow
 
@@ -206,23 +213,6 @@ The package build targets these modern browsers and uses modern DOM and JavaScri
 
 IE11 and old mobile Safari are not supported by the distributed build. If you need them, transpile the package and provide any required DOM or JavaScript polyfills in your application.
 
-## Automated npm Publishing
-
-This repository publishes to npm through GitHub Actions when a matching version tag is pushed. The workflow uses npm Trusted Publishing with GitHub Actions OIDC, so no long-lived npm token is required.
-
-Setup:
-
-1. Configure npm Trusted Publishing for this repository and the `publish-npm.yml` workflow.
-2. Commit the version bump, changelog, source, and generated `dist/` files.
-3. Push a tag that matches the package version:
-
-```bash
-git tag v<package-version>
-git push origin v<package-version>
-```
-
-The workflow validates the tag, runs checks, verifies package contents, and publishes to npm.
-
 ## Dependencies
 
 - **fabric.js v5.x** — Must be loaded before ImageEditor