@mgreminger/quill-image-resize-module 1.0.0

package/.github/workflows/playwright.yml

@@ -0,0 +1,33 @@
+name: Playwright Tests
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+      - name: Install dependencies
+        run: npm ci
+      - name: Install Playwright Browsers
+        run: npx playwright install --with-deps
+      - name: Build library
+        run: npm run build
+      - name: Build preview site
+        run: npm run build-preview
+      - name: Start Preview Server
+        run: npm run preview &
+      - name: Run Playwright tests
+        run: npm run test
+      - uses: actions/upload-artifact@v4
+        if: ${{ !cancelled() }}
+        with:
+          name: playwright-report
+          path: playwright-report/
+          retention-days: 30

package/LICENSE

@@ -0,0 +1,20 @@
+The MIT License
+Copyright © 2018
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,162 @@
+# Quill ImageResize Module
+
+A module for Quill rich text editor to allow images to be resized.
+
+A fork of [kensnyder/quill-image-resize-module](https://github.com/kensnyder/quill-image-resize-module) with the following changes:
+* Updated to work with Quill 2
+* Modernized toolchain using vite and TypeScript
+* Toolbar buttons removed since allignment settings were not preserved in the document Delta
+* The presence of resize handles no longer impacts underlying selection range so keyboard actions such as copy to clipboard and type to replace still work as expected
+* Keyboard shortcuts added to increase image size (+ key) and decrease image size (- key)
+* Resize handles now appear when image is selected with the keyboard (using shift with the arrow keys)
+* Works with touch events in addition to mouse events
+
+## Demo
+
+[Preview Site](https://mgreminger.github.io/quill-image-resize-module/)
+
+## Usage
+
+### Webpack/ES6
+
+```javascript
+import Quill from "quill";
+import { ImageResize } from "quill-image-resize-module";
+
+Quill.register("modules/imageResize", ImageResize);
+
+const quill = new Quill(editor, {
+  // ...
+  modules: {
+    // ...
+    imageResize: {
+      // See optional "config" below
+    },
+  },
+});
+```
+
+### Script Tag
+
+Copy image-resize.min.js into your web root or include from node_modules
+
+```html
+<script src="/node_modules/quill-image-resize-module/image-resize.min.js"></script>
+```
+
+```javascript
+var quill = new Quill(editor, {
+  // ...
+  modules: {
+    // ...
+    ImageResize: {
+      // See optional "config" below
+    },
+  },
+});
+```
+
+### Config
+
+For the default experience, pass an empty object, like so:
+
+```javascript
+var quill = new Quill(editor, {
+  // ...
+  modules: {
+    // ...
+    ImageResize: {},
+  },
+});
+```
+
+Functionality is broken down into modules, which can be mixed and matched as you like. For example,
+the default is to include all modules:
+
+```javascript
+const quill = new Quill(editor, {
+  // ...
+  modules: {
+    // ...
+    ImageResize: {
+      modules: ["Resize", "DisplaySize"],
+    },
+  },
+});
+```
+
+Each module is described below.
+
+#### `Resize` - Resize the image
+
+Adds handles to the image's corners which can be dragged with the mouse to resize the image.
+
+The look and feel can be controlled with options:
+
+```javascript
+var quill = new Quill(editor, {
+  // ...
+  modules: {
+    // ...
+    ImageResize: {
+      // ...
+      handleStyles: {
+        backgroundColor: "black",
+        border: "none",
+        color: white,
+        // other camelCase styles for size display
+      },
+    },
+  },
+});
+```
+
+#### `DisplaySize` - Display pixel size
+
+Shows the size of the image in pixels near the bottom right of the image.
+
+The look and feel can be controlled with options:
+
+```javascript
+var quill = new Quill(editor, {
+  // ...
+  modules: {
+    // ...
+    ImageResize: {
+      // ...
+      displayStyles: {
+        backgroundColor: "black",
+        border: "none",
+        color: white,
+        // other camelCase styles for size display
+      },
+    },
+  },
+});
+```
+
+#### `BaseModule` - Include your own custom module
+
+You can write your own module by extending the `BaseModule` class, and then including it in
+the module setup.
+
+For example,
+
+```javascript
+import { Resize, BaseModule } from "quill-image-resize-module";
+
+class MyModule extends BaseModule {
+  // See src/modules/BaseModule.js for documentation on the various lifecycle callbacks
+}
+
+var quill = new Quill(editor, {
+  // ...
+  modules: {
+    // ...
+    ImageResize: {
+      modules: [MyModule, Resize],
+      // ...
+    },
+  },
+});
+```

package/demo/script.js

@@ -0,0 +1,21 @@
+import "quill/dist/quill.snow.css";
+import Quill from "quill";
+import ImageResize from "../lib/ImageResize";
+
+Quill.register("modules/imageResize", ImageResize);
+
+console.log("Using dev environment");
+
+let quill = new Quill("#editor", {
+  theme: "snow",
+  modules: {
+    imageResize: {},
+  },
+});
+
+let quill2 = new Quill("#editor2", {
+  theme: "snow",
+  modules: {
+    imageResize: {},
+  },
+});

package/index.html

@@ -0,0 +1,40 @@
+<!doctype html>
+<html>
+
+<head>
+  <meta charset="utf-8" />
+  <title>Quill Image Resize Module Demo</title>
+</head>
+
+<body>
+  <h1>Quill Image Resize Module Demo</h1>
+  <div id="editor" style="max-height: 500px; overflow: auto">
+    <p>Click on the Image Below to resize</p>
+    <p>
+      <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/f/f5/Typescript.svg/64px-Typescript.svg.png" />
+    </p>
+    <p>Some initial <strong>bold</strong> text</p>
+    <p>
+      <img src="https://upload.wikimedia.org/wikipedia/commons/a/a4/JavaScript_code.png" />
+    </p>
+  </div>
+
+  <h1>Editor 2</h1>
+  <div id="editor2" style="max-height: 500px; overflow: auto">
+    <p>Click on the Image Below to resize</p>
+    <p>
+      <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/f/f5/Typescript.svg/64px-Typescript.svg.png" />
+    </p>
+    <p>Some initial <strong>bold</strong> text</p>
+    <p>
+      <img src="https://upload.wikimedia.org/wikipedia/commons/a/a4/JavaScript_code.png" />
+    </p>
+  </div>
+  <p>
+    <label>Text Input:</label>
+    <input></input>
+  </p>
+  <script type="module" src="./demo/script.js"></script>
+</body>
+
+</html>

package/lib/DefaultOptions.ts

@@ -0,0 +1,35 @@
+import type { Options } from "./types";
+
+const DefaultOptions: Options = {
+  modules: ["DisplaySize", "Resize"],
+  minWidth: 13,
+  keyboardSizeDelta: 10,
+  overlayStyles: {
+    position: "absolute",
+    boxSizing: "border-box",
+    border: "1px dashed #444",
+  },
+  handleStyles: {
+    position: "absolute",
+    height: "12px",
+    width: "12px",
+    backgroundColor: "white",
+    border: "1px solid #777",
+    boxSizing: "border-box",
+    opacity: "0.80",
+  },
+  displayStyles: {
+    position: "absolute",
+    font: "12px/1.0 Arial, Helvetica, sans-serif",
+    padding: "4px 8px",
+    textAlign: "center",
+    backgroundColor: "white",
+    color: "#333",
+    border: "1px solid #777",
+    boxSizing: "border-box",
+    opacity: "0.80",
+    cursor: "default",
+  },
+};
+
+export default DefaultOptions;

package/lib/ImageResize.ts

@@ -0,0 +1,253 @@
+import defaultsDeep from "lodash/defaultsDeep";
+import type Quill from "quill";
+import type { Range } from "quill";
+import type { Options, ImageResizeOptions, Modules } from "./types";
+import { Parchment } from "quill";
+import DefaultOptions from "./DefaultOptions";
+import { DisplaySize } from "./modules/DisplaySize";
+import { Resize } from "./modules/Resize";
+
+const knownModules = { DisplaySize: DisplaySize, Resize: Resize };
+
+/**
+ * Custom module for quilljs to allow user to resize <img> elements
+ * (Works on Chrome, Edge, Safari and replaces Firefox's native resize behavior)
+ * @see https://quilljs.com/blog/building-a-custom-module/
+ */
+export default class ImageResize {
+  quill: Quill;
+  options: Options;
+  moduleClasses: Modules;
+  modules: (DisplaySize | Resize)[];
+  img: HTMLImageElement | null = null;
+  overlay: HTMLDivElement | null = null;
+
+  constructor(quill: Quill, options: ImageResizeOptions = {}) {
+    // save the quill reference and options
+    this.quill = quill;
+
+    // Apply the options to our defaults, and stash them for later
+    // defaultsDeep doesn't do arrays as you'd expect, so we'll need to apply the classes array from options separately
+    let moduleClasses: Modules | false = false;
+    if (options.modules) {
+      moduleClasses = options.modules.slice();
+    }
+
+    // Apply options to default options
+    this.options = defaultsDeep({}, options, DefaultOptions) as Options;
+
+    // (see above about moduleClasses)
+    if (moduleClasses !== false) {
+      this.options.modules = moduleClasses;
+    }
+
+    // respond to image being selected
+    this.quill.root.addEventListener("click", this.handleClick);
+    this.quill.on("selection-change", this.handleSelectionChange);
+    this.quill.on("text-change", this.handleTextChange);
+
+    if (this.quill.root.parentNode instanceof HTMLElement) {
+      this.quill.root.parentNode.style.position =
+        this.quill.root.parentNode.style.position || "relative";
+    } else {
+      console.warn("parentNode is not an HTMLElement");
+    }
+
+    // setup modules
+    this.moduleClasses = this.options.modules;
+
+    this.modules = [];
+  }
+
+  initializeModules = () => {
+    this.removeModules();
+
+    this.modules = this.moduleClasses.map((ModuleClass) => {
+      if (typeof ModuleClass === "string") {
+        return new knownModules[ModuleClass](this);
+      } else {
+        return new ModuleClass(this);
+      }
+    });
+
+    this.modules.forEach((module) => {
+      module.onCreate();
+    });
+
+    this.onUpdate();
+  };
+
+  onUpdate = () => {
+    this.repositionElements();
+    this.modules.forEach((module) => {
+      module.onUpdate();
+    });
+  };
+
+  removeModules = () => {
+    this.modules.forEach((module) => {
+      module.onDestroy();
+    });
+
+    this.modules = [];
+  };
+
+  handleClick = (event: MouseEvent) => {
+    // chrome and webkit don't automatically select an image when it's clicked so need to do this manually
+    if (event.target instanceof HTMLImageElement) {
+      const blot = (this.quill.constructor as typeof Quill).find(event.target);
+      if (blot instanceof Parchment.EmbedBlot) {
+        this.quill.setSelection(blot.offset(this.quill.scroll), blot.length());
+      }
+    }
+  };
+
+  handleSelectionChange = (range: Range | null) => {
+    let firstImage: HTMLImageElement | null = null;
+
+    if (range) {
+      const blots = this.quill.scroll.descendants(
+        Parchment.EmbedBlot,
+        range.index,
+        range.length,
+      );
+      for (const blot of blots) {
+        if (blot.domNode instanceof HTMLImageElement) {
+          firstImage = blot.domNode;
+        }
+      }
+    }
+
+    if (firstImage) {
+      this.show(firstImage);
+    } else if (this.img) {
+      // clicked on a non image
+      this.hide();
+    }
+  };
+
+  handleTextChange = () => {
+    if (this.img) {
+      if (!(this.quill.constructor as typeof Quill).find(this.img)) {
+        this.hide();
+      }
+    }
+  };
+
+  show = (img: HTMLImageElement) => {
+    // keep track of this img element
+    this.img = img;
+
+    this.showOverlay();
+
+    this.initializeModules();
+  };
+
+  showOverlay = () => {
+    if (this.overlay) {
+      this.hideOverlay();
+    }
+
+    // prevent spurious text selection
+    this.setUserSelect("none");
+
+    this.quill.root.addEventListener("keydown", this.handleKeyboardShortcuts);
+
+    // Create and add the overlay
+    this.overlay = document.createElement("div");
+    Object.assign(this.overlay.style, this.options.overlayStyles);
+
+    this.quill.root.parentNode?.appendChild(this.overlay);
+
+    this.repositionElements();
+  };
+
+  hideOverlay = () => {
+    if (!this.overlay) {
+      return;
+    }
+
+    // Remove the overlay
+    this.quill.root.parentNode?.removeChild(this.overlay);
+    this.overlay = null;
+
+    // reset user-select
+    this.setUserSelect("");
+
+    this.quill.root.removeEventListener(
+      "keydown",
+      this.handleKeyboardShortcuts,
+    );
+  };
+
+  repositionElements = () => {
+    if (!this.overlay || !this.img) {
+      return;
+    }
+
+    // position the overlay over the image
+    if (this.quill.root.parentNode instanceof HTMLElement) {
+      const parent = this.quill.root.parentNode;
+      const imgRect = this.img.getBoundingClientRect();
+      if (imgRect.width === 0 || imgRect.height === 0) {
+        // Actual image is not in the DOM yet (just image tag)
+        // This occurs after undoing a delete, best to remove overlay
+        this.hide();
+        return;
+      }
+      const containerRect = parent.getBoundingClientRect();
+
+      Object.assign(this.overlay.style, {
+        left: `${imgRect.left - containerRect.left - 1 + parent.scrollLeft}px`,
+        top: `${imgRect.top - containerRect.top + parent.scrollTop}px`,
+        width: `${imgRect.width}px`,
+        height: `${imgRect.height}px`,
+      });
+    } else {
+      console.warn("parentNode is not an HTMLElement");
+    }
+  };
+
+  hide = () => {
+    this.hideOverlay();
+    this.removeModules();
+    this.img = null;
+  };
+
+  setUserSelect = (value: string) => {
+    // set on contenteditable element and <html>
+    this.quill.root.style.setProperty("user-select", value);
+    document.documentElement.style.setProperty("user-select", value);
+  };
+
+  handleKeyboardShortcuts = (event: KeyboardEvent) => {
+    if (event.defaultPrevented) {
+      return;
+    }
+
+    switch (event.key) {
+      case "+":
+        if (this.img) {
+          this.img.width = Math.max(
+            this.img.width + this.options.keyboardSizeDelta,
+            this.options.minWidth,
+          );
+          this.onUpdate();
+        }
+        break;
+      case "-":
+        if (this.img) {
+          this.img.width = Math.max(
+            this.img.width - this.options.keyboardSizeDelta,
+            this.options.minWidth,
+          );
+          this.onUpdate();
+        }
+        break;
+      default:
+        return;
+    }
+
+    event.preventDefault();
+  };
+}

package/lib/modules/BaseModule.ts

@@ -0,0 +1,49 @@
+import type ImageResize from "../ImageResize";
+import type { Options } from "../types";
+
+export class BaseModule {
+  overlay: HTMLDivElement | null;
+  img: HTMLImageElement | null;
+  options: Options;
+  requestUpdate: () => void;
+
+  constructor(resizer: ImageResize) {
+    this.overlay = resizer.overlay;
+    this.img = resizer.img;
+    this.options = resizer.options;
+    this.requestUpdate = resizer.onUpdate;
+  }
+  /*
+    requestUpdate (passed in by the library during construction, above) can be used to let the library know that
+    you've changed something about the image that would require re-calculating the overlay (and all of its child
+    elements)
+
+    For example, if you add a margin to the element, you'll want to call this or else all the controls will be
+    misaligned on-screen.
+  */
+
+  /*
+    onCreate will be called when the element is clicked on
+
+    If the module has any user controls, it should create any containers that it'll need here.
+    The overlay has absolute positioning, and will be automatically repositioned and resized as needed, so you can
+    use your own absolute positioning and the 'top', 'right', etc. styles to be positioned relative to the element
+    on-screen.
+  */
+  onCreate = () => {};
+
+  /*
+    onDestroy will be called when the element is de-selected, or when this module otherwise needs to tidy up.
+
+    If you created any DOM elements in onCreate, please remove them from the DOM and destroy them here.
+  */
+  onDestroy = () => {};
+
+  /*
+    onUpdate will be called any time that the element is changed (e.g. resized, aligned, etc.)
+
+    This frequently happens during resize dragging, so keep computations light while here to ensure a smooth
+    user experience.
+  */
+  onUpdate = () => {};
+}

package/lib/modules/DisplaySize.ts

@@ -0,0 +1,64 @@
+import { BaseModule } from "./BaseModule";
+
+export class DisplaySize extends BaseModule {
+  display: HTMLDivElement | null = null;
+
+  onCreate = () => {
+    // Create the container to hold the size display
+    this.display = document.createElement("div");
+
+    // Apply styles
+    Object.assign(this.display.style, this.options.displayStyles);
+
+    // Attach it
+    this.overlay?.appendChild(this.display);
+  };
+
+  onDestroy = () => {};
+
+  onUpdate = () => {
+    if (!this.display || !this.img) {
+      return;
+    }
+
+    const size = this.getCurrentSize();
+    this.display.innerHTML = size.join(" × ");
+    if (size[0] > 120 && size[1] > 30) {
+      // position on top of image
+      Object.assign(this.display.style, {
+        right: "4px",
+        bottom: "4px",
+        left: "auto",
+      });
+    } else if (this.img.style.float == "right") {
+      // position off bottom left
+      const dispRect = this.display.getBoundingClientRect();
+      Object.assign(this.display.style, {
+        right: "auto",
+        bottom: `-${dispRect.height + 4}px`,
+        left: `-${dispRect.width + 4}px`,
+      });
+    } else {
+      // position off bottom right
+      const dispRect = this.display.getBoundingClientRect();
+      Object.assign(this.display.style, {
+        right: `-${dispRect.width + 4}px`,
+        bottom: `-${dispRect.height + 4}px`,
+        left: "auto",
+      });
+    }
+  };
+
+  getCurrentSize = () => {
+    if (this.img) {
+      return [
+        this.img.width,
+        Math.round(
+          (this.img.width / this.img.naturalWidth) * this.img.naturalHeight,
+        ),
+      ];
+    } else {
+      return [0, 0];
+    }
+  };
+}

package/lib/modules/Resize.ts

@@ -0,0 +1,149 @@
+import { BaseModule } from "./BaseModule";
+
+export class Resize extends BaseModule {
+  boxes: HTMLElement[] = [];
+  dragBox: HTMLElement | null = null;
+  dragStartX: number = 0;
+  preDragWidth: number = 0;
+
+  onCreate = () => {
+    // track resize handles
+    this.boxes = [];
+
+    // add 4 resize handles
+    this.addBox("nwse-resize"); // top left
+    this.addBox("nesw-resize"); // top right
+    this.addBox("nwse-resize"); // bottom right
+    this.addBox("nesw-resize"); // bottom left
+
+    this.positionBoxes();
+  };
+
+  onDestroy = () => {
+    for (const box of this.boxes) {
+      box.removeEventListener("mousedown", this.handleMousedown, false);
+    }
+
+    // reset drag handle cursors
+    this.setCursor("");
+  };
+
+  positionBoxes = () => {
+    const handleXOffset = `${-parseFloat(this.options.handleStyles.width) / 2}px`;
+    const handleYOffset = `${-parseFloat(this.options.handleStyles.height) / 2}px`;
+
+    // set the top and left for each drag handle
+    [
+      { left: handleXOffset, top: handleYOffset }, // top left
+      { right: handleXOffset, top: handleYOffset }, // top right
+      { right: handleXOffset, bottom: handleYOffset }, // bottom right
+      { left: handleXOffset, bottom: handleYOffset }, // bottom left
+    ].forEach((pos, idx) => {
+      Object.assign(this.boxes[idx].style, pos);
+    });
+  };
+
+  addBox = (cursor: string) => {
+    // create div element for resize handle
+    const box = document.createElement("div");
+    box.classList.add(cursor);
+
+    // Star with the specified styles
+    Object.assign(box.style, this.options.handleStyles);
+    box.style.cursor = cursor;
+
+    // Set the width/height to use 'px'
+    box.style.width = this.options.handleStyles.width;
+    box.style.height = this.options.handleStyles.height;
+
+    // listen for mousedown on each box
+    box.addEventListener("mousedown", this.handleMousedown, false);
+    box.addEventListener("touchstart", this.handleMousedown, {
+      passive: false,
+    });
+    // add drag handle to document
+    this.overlay?.appendChild(box);
+    // keep track of drag handle
+    this.boxes.push(box);
+  };
+
+  handleMousedown = (evt: MouseEvent | TouchEvent) => {
+    if (evt.target instanceof HTMLElement) {
+      // note which box
+      this.dragBox = evt.target;
+      // note starting mousedown position
+      if (evt.type === "touchstart") {
+        this.dragStartX = (evt as TouchEvent).changedTouches[0].clientX;
+      } else {
+        this.dragStartX = (evt as MouseEvent).clientX;
+      }
+      // store the width before the drag
+      if (this.img) {
+        this.preDragWidth = this.img.width || this.img.naturalWidth;
+      }
+      // set the proper cursor everywhere
+      this.setCursor(this.dragBox.style.cursor);
+      // listen for movement and mouseup
+      document.addEventListener("mousemove", this.handleDrag);
+      document.addEventListener("touchmove", this.handleDrag, {
+        passive: false,
+      });
+      document.addEventListener("mouseup", this.handleMouseup, true);
+      document.addEventListener("touchend", this.handleMouseup, true);
+      document.addEventListener("touchcancel", this.handleMouseup, true);
+    } else {
+      console.warn("mousedown target is not an HTMLElement");
+    }
+  };
+
+  handleMouseup = (evt: MouseEvent | TouchEvent) => {
+    evt.stopPropagation();
+
+    // reset cursor everywhere
+    this.setCursor("");
+    // stop listening for movement and mouseup
+    document.removeEventListener("mousemove", this.handleDrag);
+    document.removeEventListener("touchmove", this.handleDrag);
+    document.removeEventListener("mouseup", this.handleMouseup, true);
+    document.removeEventListener("touchend", this.handleMouseup, true);
+    document.removeEventListener("touchcancel", this.handleMouseup, true);
+  };
+
+  handleDrag = (evt: MouseEvent | TouchEvent) => {
+    if (!this.img) {
+      // image not set yet
+      return;
+    }
+    // update image size
+    let clientX: number;
+    if (evt.type === "touchmove") {
+      clientX = (evt as TouchEvent).changedTouches[0].clientX;
+    } else {
+      clientX = (evt as MouseEvent).clientX;
+    }
+
+    const deltaX = clientX - this.dragStartX;
+    if (this.dragBox === this.boxes[0] || this.dragBox === this.boxes[3]) {
+      // left-side resize handler; dragging right shrinks image
+      this.img.width = Math.max(
+        Math.round(this.preDragWidth - deltaX),
+        this.options.minWidth,
+      );
+    } else {
+      // right-side resize handler; dragging right enlarges image
+      this.img.width = Math.max(
+        Math.round(this.preDragWidth + deltaX),
+        this.options.minWidth,
+      );
+    }
+    this.requestUpdate();
+  };
+
+  setCursor = (value: string) => {
+    [document.body, this.img].forEach((el) => {
+      if (el) {
+        el.style.cursor = value; // eslint-disable-line no-param-reassign
+      }
+    });
+  };
+}

package/lib/types.ts

@@ -0,0 +1,73 @@
+import type { DisplaySize } from "./modules/DisplaySize";
+import type { Resize } from "./modules/Resize";
+
+export type Modules = (
+  | "DisplaySize"
+  | "Resize"
+  | typeof DisplaySize
+  | typeof Resize
+)[];
+
+export type Options = {
+  modules: Modules;
+  minWidth: number;
+  keyboardSizeDelta: number;
+  overlayStyles: {
+    position: string;
+    boxSizing: string;
+    border: string;
+  };
+  handleStyles: {
+    position: string;
+    height: string;
+    width: string;
+    backgroundColor: string;
+    border: string;
+    boxSizing: string;
+    opacity: string;
+  };
+  displayStyles: {
+    position: string;
+    font: string;
+    padding: string;
+    textAlign: string;
+    backgroundColor: string;
+    color: string;
+    border: string;
+    boxSizing: string;
+    opacity: string;
+    cursor: string;
+  };
+};
+
+export type ImageResizeOptions = {
+  modules?: Modules;
+  minWidth?: number;
+  keyboardSizeDelta?: number;
+  overlayStyles?: {
+    position?: string;
+    boxSizing?: string;
+    border?: string;
+  };
+  handleStyles?: {
+    position?: string;
+    height?: string;
+    width?: string;
+    backgroundColor?: string;
+    border?: string;
+    boxSizing?: string;
+    opacity?: string;
+  };
+  displayStyles?: {
+    position?: string;
+    font?: string;
+    padding?: string;
+    textAlign?: string;
+    backgroundColor?: string;
+    colo?: string;
+    border?: string;
+    boxSizing?: string;
+    opacity?: string;
+    cursor?: string;
+  };
+};

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@mgreminger/quill-image-resize-module",
+  "private": false,
+  "version": "1.0.0",
+  "description": "A module for Quill rich text editor to allow images to be resized.",
+  "type": "module",
+  "scripts": {
+    "dev": "vite --port 5173",
+    "build": "vite build",
+    "test": "playwright test",
+    "lint": "prettier --write .",
+    "build-preview": "vite build --config vite.preview.config.js",
+    "preview": "vite preview --port 5173 --config vite.preview.config.js",
+    "deploy-gh-pages": "gh-pages -d dist-preview"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.50.1",
+    "@rollup/plugin-typescript": "^12.1.2",
+    "@types/lodash": "^4.17.15",
+    "@types/node": "^22.13.0",
+    "gh-pages": "^6.3.0",
+    "prettier": "^3.4.2",
+    "quill": "^2.0.3",
+    "tslib": "^2.8.1",
+    "typescript": "^5.7.3",
+    "vite": "^6.0.11"
+  },
+  "dependencies": {
+    "lodash": "^4.17.4"
+  }
+}

package/playwright.config.ts

@@ -0,0 +1,79 @@
+import { defineConfig, devices } from "@playwright/test";
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// import dotenv from 'dotenv';
+// import path from 'path';
+// dotenv.config({ path: path.resolve(__dirname, '.env') });
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: "./tests",
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: process.env.CI ? 1 : undefined,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: "html",
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Base URL to use in actions like `await page.goto('/')`. */
+    // baseURL: 'http://127.0.0.1:3000',
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: "on-first-retry",
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: "chromium",
+      use: { ...devices["Desktop Chrome"] },
+    },
+
+    {
+      name: "firefox",
+      use: { ...devices["Desktop Firefox"] },
+    },
+
+    {
+      name: "webkit",
+      use: { ...devices["Desktop Safari"] },
+    },
+
+    /* Test against mobile viewports. */
+    // {
+    //   name: 'Mobile Chrome',
+    //   use: { ...devices['Pixel 5'] },
+    // },
+    // {
+    //   name: 'Mobile Safari',
+    //   use: { ...devices['iPhone 12'] },
+    // },
+
+    /* Test against branded browsers. */
+    // {
+    //   name: 'Microsoft Edge',
+    //   use: { ...devices['Desktop Edge'], channel: 'msedge' },
+    // },
+    // {
+    //   name: 'Google Chrome',
+    //   use: { ...devices['Desktop Chrome'], channel: 'chrome' },
+    // },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  // webServer: {
+  //   command: 'npm run start',
+  //   url: 'http://127.0.0.1:3000',
+  //   reuseExistingServer: !process.env.CI,
+  // },
+});

package/preview/index.html

@@ -0,0 +1,40 @@
+<!doctype html>
+<html>
+
+<head>
+  <meta charset="utf-8" />
+  <title>Quill Image Resize Module Demo</title>
+</head>
+
+<body>
+  <h1>Quill Image Resize Module Demo</h1>
+  <div id="editor" style="max-height: 500px; overflow: auto">
+    <p>Click on the Image Below to resize</p>
+    <p>
+      <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/f/f5/Typescript.svg/64px-Typescript.svg.png" />
+    </p>
+    <p>Some initial <strong>bold</strong> text</p>
+    <p>
+      <img src="https://upload.wikimedia.org/wikipedia/commons/a/a4/JavaScript_code.png" />
+    </p>
+  </div>
+
+  <h1>Editor 2</h1>
+  <div id="editor2" style="max-height: 500px; overflow: auto">
+    <p>Click on the Image Below to resize</p>
+    <p>
+      <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/f/f5/Typescript.svg/64px-Typescript.svg.png" />
+    </p>
+    <p>Some initial <strong>bold</strong> text</p>
+    <p>
+      <img src="https://upload.wikimedia.org/wikipedia/commons/a/a4/JavaScript_code.png" />
+    </p>
+  </div>
+  <p>
+    <label>Text Input:</label>
+    <input></input>
+  </p>
+  <script type="module" src="./script.js"></script>
+</body>
+
+</html>

package/preview/script.js

@@ -0,0 +1,21 @@
+import "quill/dist/quill.snow.css";
+import Quill from "quill";
+import ImageResize from "../dist/quill-image-resize-module";
+
+Quill.register("modules/imageResize", ImageResize);
+
+console.log("Using production environment");
+
+let quill = new Quill("#editor", {
+  theme: "snow",
+  modules: {
+    imageResize: {},
+  },
+});
+
+let quill2 = new Quill("#editor2", {
+  theme: "snow",
+  modules: {
+    imageResize: {},
+  },
+});

package/tests/test_resize.spec.ts

@@ -0,0 +1,39 @@
+import { test, expect } from "@playwright/test";
+
+test("resize using mouse drag", async ({ page, browserName }) => {
+  await page.goto("http://localhost:5173/");
+
+  await page.locator("img").first().click();
+
+  await expect(page.locator("text=64 × 64")).toBeVisible();
+
+  const bounds = await page.locator("div.nwse-resize").nth(1).boundingBox();
+
+  expect(bounds).toBeTruthy();
+
+  const mouseX = bounds!.x + bounds!.width / 2;
+  const mouseY = bounds!.y + bounds!.height / 2;
+
+  await page.locator("div.nwse-resize").nth(1).hover();
+  await page.mouse.down();
+  await page.mouse.move(mouseX + 30, mouseY);
+  await page.mouse.up();
+
+  await expect(page.locator("text=94 × 94")).toBeVisible();
+
+  expect(await page.locator("img").first().getAttribute("width")).toBe("94");
+});
+
+test("resize using keyboard shortcuts", async ({ page, browserName }) => {
+  await page.goto("http://localhost:5173/");
+
+  await page.locator("img").first().click();
+
+  await expect(page.locator("text=64 × 64")).toBeVisible();
+
+  for (let i = 0; i < 3; i++) await page.keyboard.press("+");
+
+  await expect(page.locator("text=94 × 94")).toBeVisible();
+
+  expect(await page.locator("img").first().getAttribute("width")).toBe("94");
+});

package/tsconfig.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "module": "ESNext",
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "emitDeclarationOnly": true,
+    "declarationDir": "./dist",
+    "allowImportingTsExtensions": true,
+    "isolatedModules": true,
+    "moduleDetection": "force",
+    "declaration": true,
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedSideEffectImports": true
+  },
+  "include": ["lib"]
+}

package/vite.config.js

@@ -0,0 +1,28 @@
+import path, { dirname, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+import { defineConfig } from "vite";
+import typescript from "@rollup/plugin-typescript";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+export default defineConfig({
+  build: {
+    lib: {
+      entry: resolve(__dirname, "lib/ImageResize.ts"),
+      name: "ImageResize",
+      fileName: "quill-image-resize-module",
+    },
+    rollupOptions: {
+      plugins: [
+        typescript({
+          noForceEmit: true,
+        }),
+      ],
+      external: ["quill"],
+      output: {
+        globals: { quill: "Quill" },
+      },
+    },
+    minify: false,
+  },
+});

package/vite.preview.config.js

@@ -0,0 +1,10 @@
+import { defineConfig } from "vite";
+
+export default defineConfig({
+  root: "./preview",
+  build: {
+    outDir: "../dist-preview",
+    emptyOutDir: true
+  },
+  base: './'
+});