avtomon/quill-image-compress.js

There is no license information available for the latest version (dev-master) of this package.

Quill editor base64 images compress plugin

Maintainers

Details

github.com/avtomon/quill-image-compress.js

Source

Installs: 10

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 29

Language:JavaScript

dev-master 2020-04-27 17:56 UTC

Unknown License 13b4cda8d26eb9180e64d2f69076f112473aacda

This package is auto-updated.

Last update: 2025-03-28 05:18:28 UTC

README

NPM Version License Downloads/week Github Issues Build and Publish

Quill.js Module which compresses images that are uploaded to the editor

Install

yarn add quill-image-compress

Quickstart

import ImageCompress from 'quill-image-compress';

Quill.register('modules/imageCompress', ImageCompress);

const quill = new Quill(editor, {
  // ...
  modules: {
    // ...
    imageCompress: {
      quality: 0.7, // default
      maxWidth: 1000, // default
      maxHeight: 1000, // default
      imageType: 'image/jpeg', // default
      debug: true, // default
    }
  }
});

Quickstart (script tag)

    <script src="/dist/quill.imageCompressor.min.js"></script>
    <script>
      Quill.register("modules/imageCompressor", imageCompressor);
      
      var quill = new Quill("#editor", {
        modules: {
          imageCompressor: {
            quality: 0.9,
            maxWidth: 1000, // default
            maxHeight: 1000, // default
            imageType: 'image/jpeg'
          }
        }
      });
    </script>

Options

  • maxWidth
    • Maximum width of images (in pixels)
  • quality
    • Image quality range: 0.0 - 1.0
  • imageType
    • Values: 'image/jpeg' , 'image/png' ... etc
  • debug
    • Displays console logs: true/false

Thanks

This project is based on quill-image-uploader, thanks mate!