Skip to content

๐ŸŽ† A Vite plugin to compress images (JPEG and PNG) during the build process using imagemin.

Notifications You must be signed in to change notification settings

eugeneoshepkov/vite-plugin-image-compression

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

1 Commit
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Vite Image Compression Plugin

A Vite plugin to compress images (JPEG and PNG) during the build process using imagemin.

Installation

npm i -D vite-plugin-image-compression

Usage

Import and use the plugin in your Vite configuration file (usually vite.config.ts):

// vite.config.ts
import { defineConfig } from 'vite';
import imageCompressionPlugin from 'vite-plugin-image-compression';

export default defineConfig({
  plugins: [imageCompressionPlugin()],
});

By default, the plugin compresses JPEG and PNG images located in the "assets" folder and saves the compressed images in a "compressed" subfolder during the build process.

Configuration

The plugin accepts custom settings for both imagemin-pngquant and imagemin-mozjpeg:

// vite.config.ts
import { defineConfig } from 'vite';
import imageCompressionPlugin from 'vite-plugin-image-compression';

export default defineConfig({
  plugins: [
    imageCompressionPlugin({
      pngquantOptions: { quality: [0.5, 0.7] },
      mozjpegOptions: { quality: 80 },
    }),
  ],
});

In this example, we've provided custom settings for both pngquant and mozjpeg. You can adjust the settings according to your needs.

License

MIT License

About

๐ŸŽ† A Vite plugin to compress images (JPEG and PNG) during the build process using imagemin.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published