Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juliomrqz/nuxt-optimized-images
🌅🚀 Automatically optimizes images used in Nuxt.js projects (JPEG, PNG, SVG, WebP and GIF).
https://github.com/juliomrqz/nuxt-optimized-images
gif image jpeg marquez nuxt nuxt-module nuxtjs optimization optimization-packages plugin svg webp
Last synced: about 2 months ago
JSON representation
🌅🚀 Automatically optimizes images used in Nuxt.js projects (JPEG, PNG, SVG, WebP and GIF).
- Host: GitHub
- URL: https://github.com/juliomrqz/nuxt-optimized-images
- Owner: juliomrqz
- License: mit
- Created: 2019-02-28T11:52:22.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2023-03-05T18:34:39.000Z (over 1 year ago)
- Last Synced: 2024-05-16T01:02:11.112Z (6 months ago)
- Topics: gif, image, jpeg, marquez, nuxt, nuxt-module, nuxtjs, optimization, optimization-packages, plugin, svg, webp
- Language: JavaScript
- Homepage: https://marquez.co/docs/nuxt-optimized-images/
- Size: 5.13 MB
- Stars: 842
- Watchers: 11
- Forks: 29
- Open Issues: 72
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://travis-ci.org/juliomrqz/nuxt-optimized-images)
[](https://david-dm.org/juliomrqz/nuxt-optimized-images?type=peer)
[](https://david-dm.org/juliomrqz/nuxt-optimized-images?type=dev)
[](https://www.npmjs.com/package/@aceforth/nuxt-optimized-images)
[](https://raw.githubusercontent.com/juliomrqz/nuxt-optimized-images/develop/LICENSE)
> **⚠️ IMPORTANT:** This module is under maintenance mode, that means that new features are not developed but bug fixes are adressed.
> **ℹ️ NOTE:** For Nuxt v3, it's recommended the Official Nuxt Image Module https://github.com/nuxt/image
# :sunrise: :rocket: Nuxt Optimized Images
Automatically optimizes images used in Nuxt.js projects (JPEG, PNG, SVG, WebP and GIF).
> This module is inspired by the work of [Cyril Wanner](https://github.com/cyrilwanner) in [next-optimized-images](https://github.com/cyrilwanner/next-optimized-images).
*Read this in other languages: [English][docs], [Español][docs-es]*
## Features
Image sizes can often get reduced up to 60%, but this is not the only thing `@aceforth/nuxt-optimized-images` does:
* **Reduces image size** by optimizing images during build.
* Improves loading speed by providing **progressive images** (for formats that support it).
* JPEG/PNG images can be **converted to [`WebP` on the fly](./docs/usage.md#webp)** for an even smaller size.
* Can **[resize](./docs/usage.md#resize)** images or generate **low-quality image placeholders** ([lqip](./docs/usage.md#lqip)) and extract the dominant [colors](./docs/usage.md#lqip-colors) of it.
* Provides **[query params](./docs/usage.md#query-params)** for file-specific handling/settings.
* And supports these features already included in Nuxt.js:
* **Content hash** to the file name so images can get cached on CDN level and in the browser for a long time.
* **Inlined small images** to save HTTP requests and additional roundtrips.
* Same URLs for unchanged images over multiple builds for long time caching.
## Installation
:warning: `node >= 10` and `nuxt >= 2` are required.
```bash
npm install --save-dev @aceforth/nuxt-optimized-images
```
or
```bash
yarn add --dev @aceforth/nuxt-optimized-images
```
Add `@aceforth/nuxt-optimized-images` to `buildModules` section of nuxt.config.js:
:warning: If you are using Nuxt `< 2.9.0`, use `modules` instead.
```js
{
buildModules: [
'@aceforth/nuxt-optimized-images',
],
optimizedImages: {
optimizeImages: true
}
}
```
See the [configuration][docs-configuration] section for all available options.
:warning: Images won't get optimized out of the box. You have to install the optimization packages you really need in addition to this module. This doesn't force you to download big optimization libraries you don't even use. Please check out the table of all [optional optimization packages](#optimization-packages).
## Optimization Packages
You have to install the optimization packages you need in your project in addition to this module. Then, `@aceforth/nuxt-optimized-images` detects all the supported packages and uses them.
**So you only have to install these packages with npm, there is no additional step needed after that.**
The following optimization packages are available and supported:
| Optimization Package | Description | Project Link |
|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|
| `imagemin-mozjpeg` | Optimizes JPEG images | [Link][imagemin-mozjpeg] |
| `imagemin-pngquant` | Optimizes PNG images | [Link][imagemin-pngquant] |
| `imagemin-optipng` | Alternative for optimizing PNG images | [Link][imagemin-optipng] |
| `imagemin-gifsicle` | Optimizes GIF images | [Link][imagemin-gifsicle] |
| `imagemin-svgo` | Optimizes SVG images and icons | [Link][imagemin-svgo] |
| `webp-loader` | Optimizes WebP images and can convert JPEG/PNG images to WebP on the fly ([WebP resource query](./docs/usage.md#webp)) | [Link][webp-loader] |
| `lqip-loader` | Generates low quality image placeholders and can extract the dominant colors of an image ([lqip resource query](./docs/usage.md#lqip)) | [Link][lqip-loader] |
| `responsive-loader` | Can resize images on the fly and create multiple versions of it for a `srcSet`. **Important**: You need to additionally install either `jimp` (node implementation, slower) or `sharp` (binary, faster) | [Link][responsive-loader] |
| `sqip-loader` | Loads images and exports tiny SQIP previews as `image/svg+xml` URL-encoded data | [Link][sqip-loader] |
Example: If you have JPG, PNG, and SVG images in your project, you would then need to run
```sh
npm install --save-dev imagemin-mozjpeg imagemin-pngquant imagemin-svgo
# or
yarn add --dev imagemin-mozjpeg imagemin-pngquant imagemin-svgo
```
To install **all** optional packages, run:
```sh
npm install --save-dev imagemin-mozjpeg imagemin-pngquant imagemin-gifsicle imagemin-svgo webp-loader lqip-loader responsive-loader sqip-loader sharp
# or
yarn add --dev imagemin-mozjpeg imagemin-pngquant imagemin-gifsicle imagemin-svgo webp-loader lqip-loader responsive-loader sqip-loader sharp
```
:warning: Please note that by default, images are only optimized for **production builds, not development builds**. However, this can get changed with the [`optimizeImagesInDev` config][docs-configuration-optimizeimagesindev].
## Documentation & Support
- 📄 If you want extra details of how to configure and use this project, the **full documentation** is available at [https://marquez.co/docs/nuxt-optimized-images/][docs].
- 🐞 For **Bug reports** or **Feature requests**, use the [Issues section][issues].
- 💬 For **questions**, you can also use the [Discussions section][discussions].
- 🚀 You may also want to **follow me** [on Twitter][twitter].
## Professional Support
This project is sponsored by me, a Full Stack Developers. If you require Professional Assistance on your project(s), please contact me at [https://marquez.co][support-page].
## Code of Conduct
Everyone participating in this project is expected to agree to abide by the [Code of Conduct][code-of-conduct].
## License
Code released under the [MIT License][license-page].
[docs]: https://marquez.co/docs/nuxt-optimized-images/?utm_source=github&utm_medium=readme&utm_campaign=nuxt-optimized-images
[docs-es]: https://marquez.co/es/docs/nuxt-optimized-images/?utm_source=github&utm_medium=readme&utm_campaign=nuxt-optimized-images
[docs-configuration]: https://marquez.co/docs/nuxt-optimized-images/configuration/?utm_source=github&utm_medium=readme&utm_campaign=nuxt-optimized-images
[docs-configuration-optimizeimagesindev]: https://marquez.co/docs/nuxt-optimized-images/configuration/?utm_source=github&utm_medium=readme&utm_campaign=nuxt-optimized-images#optimizeimagesindev
[issues]: https://github.com/juliomrqz/nuxt-optimized-images/issues
[discussions]: https://github.com/juliomrqz/nuxt-optimized-images/discussions
[twitter]: https://twitter.com/juliomrqz
[support-page]: https://marquez.co/?utm_source=github&utm_medium=readme&utm_campaign=nuxt-optimized-images
[code-of-conduct]: https://www.contributor-covenant.org/version/2/0/code_of_conduct/
[license-page]: https://github.com/juliomrqz/nuxt-optimized-images/blob/develop/LICENSE
[imagemin-mozjpeg]: https://www.npmjs.com/package/imagemin-mozjpeg
[imagemin-pngquant]: https://www.npmjs.com/package/imagemin-pngquant
[imagemin-optipng]: https://www.npmjs.com/package/imagemin-optipng
[imagemin-gifsicle]: https://www.npmjs.com/package/imagemin-gifsicle
[imagemin-svgo]: https://www.npmjs.com/package/imagemin-svgo
[webp-loader]: https://www.npmjs.com/package/webp-loader
[lqip-loader]: https://www.npmjs.com/package/lqip-loader
[responsive-loader]: https://www.npmjs.com/package/responsive-loader
[sqip-loader]: https://github.com/EmilTholin/sqip-loader