What is @uppy/thumbnail-generator?
@uppy/thumbnail-generator is a plugin for the Uppy file uploader that generates image thumbnails for preview purposes. It is particularly useful for providing users with a visual representation of the images they are uploading.
What are @uppy/thumbnail-generator's main functionalities?
Generate Thumbnails
This feature allows you to generate thumbnails for images that are being uploaded. The `thumbnailWidth` option specifies the width of the generated thumbnail. The `thumbnail:generated` event is triggered when a thumbnail is successfully created, providing the file and preview URL.
const Uppy = require('@uppy/core');
const ThumbnailGenerator = require('@uppy/thumbnail-generator');
const uppy = Uppy();
uppy.use(ThumbnailGenerator, {
thumbnailWidth: 200,
});
uppy.on('thumbnail:generated', (file, preview) => {
console.log(file.name, preview);
// You can now use the preview URL to display the thumbnail
});
Custom Thumbnail Dimensions
This feature allows you to specify custom dimensions for the generated thumbnails. By setting both `thumbnailWidth` and `thumbnailHeight`, you can control the size of the thumbnails more precisely.
const Uppy = require('@uppy/core');
const ThumbnailGenerator = require('@uppy/thumbnail-generator');
const uppy = Uppy();
uppy.use(ThumbnailGenerator, {
thumbnailWidth: 300,
thumbnailHeight: 300,
});
uppy.on('thumbnail:generated', (file, preview) => {
console.log(file.name, preview);
// You can now use the preview URL to display the thumbnail
});
Thumbnail Quality
This feature allows you to set the quality of the generated thumbnails. The `quality` option accepts a value between 0 and 1, where 1 is the highest quality.
const Uppy = require('@uppy/core');
const ThumbnailGenerator = require('@uppy/thumbnail-generator');
const uppy = Uppy();
uppy.use(ThumbnailGenerator, {
thumbnailWidth: 200,
quality: 0.8,
});
uppy.on('thumbnail:generated', (file, preview) => {
console.log(file.name, preview);
// You can now use the preview URL to display the thumbnail
});
Other packages similar to @uppy/thumbnail-generator
sharp
Sharp is a high-performance image processing library that can resize, crop, and convert images in various formats. Unlike @uppy/thumbnail-generator, which is specifically designed for generating thumbnails within the Uppy ecosystem, Sharp is a more general-purpose library that can be used in a variety of image processing tasks.
jimp
Jimp is an image processing library for Node.js that supports image resizing, cropping, and various other manipulations. Similar to Sharp, Jimp is a general-purpose library and not specifically tied to any file uploader like Uppy. It offers a wide range of image processing functionalities.
gm
GraphicsMagick (gm) is a Node.js wrapper for the GraphicsMagick and ImageMagick image processing libraries. It provides extensive image manipulation capabilities, including resizing and thumbnail generation. Unlike @uppy/thumbnail-generator, gm is not specifically designed for integration with file uploaders but offers a broader range of image processing features.
@uppy/thumbnail-generator
Uppy plugin that generates small previews of images to show on your upload UI.
Uppy is being developed by the folks at Transloadit,
a versatile file encoding service.
Example
import Uppy from '@uppy/core'
import ThumbnailGenerator from '@uppy/thumbnail-generator'
const uppy = new Uppy()
uppy.use(ThumbnailGenerator, {
thumbnailWidth: 200,
})
Installation
$ npm install @uppy/thumbnail-generator
Alternatively, you can also use this plugin in a pre-built bundle from
Transloadit’s CDN: Edgly. In that case Uppy
will attach itself to the global
window.Uppy
object. See the
main Uppy documentation for instructions.
License
The MIT License.
4.0.0
Released: 2024-07-10
| Package | Version | Package | Version |
| ------------------------- | ------- | ------------------------- | ------- |
| @uppy/angular | 0.7.0 | @uppy/onedrive | 4.0.0 |
| @uppy/audio | 2.0.0 | @uppy/progress-bar | 4.0.0 |
| @uppy/aws-s3 | 4.0.0 | @uppy/provider-views | 4.0.0 |
| @uppy/aws-s3-multipart | 4.0.0 | @uppy/react | 4.0.0 |
| @uppy/box | 3.0.0 | @uppy/react-native | 0.6.0 |
| @uppy/companion | 5.0.0 | @uppy/redux-dev-tools | 4.0.0 |
| @uppy/companion-client | 4.0.0 | @uppy/remote-sources | 2.0.0 |
| @uppy/compressor | 2.0.0 | @uppy/screen-capture | 4.0.0 |
| @uppy/core | 4.0.0 | @uppy/status-bar | 4.0.0 |
| @uppy/dashboard | 4.0.0 | @uppy/store-default | 4.0.0 |
| @uppy/drag-drop | 4.0.0 | @uppy/store-redux | 4.0.0 |
| @uppy/drop-target | 3.0.0 | @uppy/svelte | 4.0.0 |
| @uppy/dropbox | 4.0.0 | @uppy/thumbnail-generator | 4.0.0 |
| @uppy/facebook | 4.0.0 | @uppy/transloadit | 4.0.0 |
| @uppy/file-input | 4.0.0 | @uppy/tus | 4.0.0 |
| @uppy/form | 4.0.0 | @uppy/unsplash | 4.0.0 |
| @uppy/golden-retriever | 4.0.0 | @uppy/url | 4.0.0 |
| @uppy/google-drive | 4.0.0 | @uppy/utils | 6.0.0 |
| @uppy/google-photos | 0.2.0 | @uppy/vue | 2.0.0 |
| @uppy/image-editor | 3.0.0 | @uppy/webcam | 4.0.0 |
| @uppy/informer | 4.0.0 | @uppy/xhr-upload | 4.0.0 |
| @uppy/instagram | 4.0.0 | @uppy/zoom | 3.0.0 |
| @uppy/locales | 4.0.0 | uppy | 4.0.0 |
- meta: Bump docker/setup-qemu-action from 3.0.0 to 3.1.0 (dependabot[bot] / #5314)
- meta: Bump docker/build-push-action from 6.2.0 to 6.3.0 (dependabot[bot] / #5313)
- @uppy/core: bring back resetProgress (Merlijn Vos / #5320)
- docs: add note regarding
COMPANION_CLIENT_ORIGINS_REGEX
(Antoine du Hamel / #5322) - @uppy/companion: make streaming upload default to
true
(Mikael Finstad / #5315) - docs: change slug for aws docs (Merlijn Vos / #5321)
- @uppy/core: export UppyOptions, UppyFile, Meta, Body (Merlijn Vos / #5319)
- meta: fix React linter rules (Antoine du Hamel / #5317)
- meta: enforce use of extension in import type declarations (Antoine du Hamel / #5316)
- @uppy/companion: remove
oauthOrigin
(Antoine du Hamel / #5311) - docs,@uppy/companion-client: don't close socket when pausing (Mikael Finstad / #4821)
- @uppy/aws-s3: fix signing on client for bucket name with dots (Antoine du Hamel / #5312)
- @uppy/react: introduce useUppyEvent (Merlijn Vos / #5264)
- @uppy/companion: do not list Node.js 20.12 as compatible (Antoine du Hamel / #5309)
- @uppy/provider-views:
.openFolder()
- return progress indication (Evgenia Karunus / #5306) - examples,@uppy/companion: Release: uppy@3.27.3 (github-actions[bot] / #5304)
- @uppy/companion: fix
TypeError
when parsing request (Antoine du Hamel / #5303)