Skip to content

koenvg/quill-image-compress

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

quill-image-compress

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

Features

  • Will compress image when:
    • Drag/Dropped into quill
    • Pasted into quill
    • Clicked image load button
  • Handles most image formats a browser can read:
    • gif|jpeg|png|svg|webp|bmp|vnd
  • Compression options more info

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!

About

A Quill rich text editor Module which compresses images uploaded to the editor

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 77.5%
  • HTML 22.5%