Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fregante/image-promise
🎑🤞 Load one or more images, return a promise. Tiny, browser-only, no dependencies.
https://github.com/fregante/image-promise
events image imagesloaded onload promise
Last synced: 8 days ago
JSON representation
🎑🤞 Load one or more images, return a promise. Tiny, browser-only, no dependencies.
- Host: GitHub
- URL: https://github.com/fregante/image-promise
- Owner: fregante
- Created: 2016-04-03T08:41:54.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-06-17T19:36:31.000Z (over 1 year ago)
- Last Synced: 2024-05-22T15:07:58.979Z (6 months ago)
- Topics: events, image, imagesloaded, onload, promise
- Language: TypeScript
- Homepage: https://npm.im/image-promise
- Size: 117 KB
- Stars: 146
- Watchers: 4
- Forks: 16
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Deprecated
See https://github.com/fregante/image-promise/issues/27, use the native `img.decode()` instead.
# image-promise [![][badge-gzip]](#link-npm)
[badge-gzip]: https://img.shields.io/bundlephobia/minzip/image-promise.svg?label=gzipped
[link-npm]: https://www.npmjs.com/package/image-promise
> Load one or more images, return a promise. Only 0.5KB, for the browser, no dependencies.
It can be used in two ways:
- pass a URL: it will generate an `![]()
` and wait for it to load:
```js
loadImage('img.jpg').then(/* It's loaded! */)
```
- pass an `![]()
`: it will wait for it to load:
```js
const img = document.querySelector('img.my-image');
loadImage(img).then(/* It's loaded! */)
```
- pass an array of URLs and/or `![]()
`s, wait for them to load:
```js
const img = document.querySelector('img.my-image');
loadImage([img, 'loading.gif']).then(/* Both are loaded! */)
```
## Install
You can download the [standalone bundle](https://bundle.fregante.com/?pkg=image-promise&global=loadImage)
Or use `npm`:
```sh
npm install image-promise
```
```js
// This module is only offered as a ES Module
import loadImage from 'image-promise';
```
## Usage
### One image
`loadImage(image)` will return a Promise that resolves when the image load, or fails when the image
```js
const image = 'cat.jpg';
// const image = $('img')[0]; // it can also be an ![]()
element
loadImage(image)
.then(function (img) {
ctx.drawImage(img, 0, 0, 10, 10);
})
.catch(function () {
console.error('Image failed to load :(');
});
```
### Multiple images
`image-promise` can load multiple images at a time
```js
const images = ['cat.jpg', 'dog.jpg'];
// const images = $('img'); // it can also be a jQuery object
// const images = document.querySelectorAll('img'); // or a NodeList
loadImage(images)
.then(function (allImgs) {
console.log(allImgs.length, 'images loaded!', allImgs);
})
.catch(function (err) {
console.error('One or more images have failed to load :(');
console.error(err.errored);
console.info('But these loaded fine:');
console.info(err.loaded);
});
```
### Set custom attributes
`loadImage(image, attributes)` lets you pass as the second argument an object of attributes you want to assign to the image element before it starts loading.
This is useful for example when you need [CORS enabled image](https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image), where you need to set the attribute `crossorigin="anonymous"` before the image starts downloading.
```js
const image = 'https://catpics.com/cat.jpg';
loadImage(image, { crossorigin: 'anonymous' })
.then(function (img) {
ctx.drawImage(img, 0, 0, 10, 10);
// now you can do this
canvas.toDataURL('image/png')
})
.catch(function () {
console.error('Image failed to load :(');
});
```
## Dependencies
None! But you need to polyfill `window.Promise` in IE11 and lower.
## License
MIT © [Federico Brigante](https://bfred.it)