# image-loaded-promise

> 要素の画像読込みを待つぞ

Latest version **1.0.0** (published 2018-06-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install image-loaded-promise
pnpm add image-loaded-promise
yarn add image-loaded-promise
bun add image-loaded-promise
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-06-01 |
| First published | 2018-06-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 9.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | honeo |
| Maintainers | honeo |
| Keywords | element, image, src, load, loaded, background-image, promise, lazyload |

## Links

- npm: https://www.npmjs.com/package/image-loaded-promise
- Repository: https://github.com/honeo/image-loaded-promise
- Homepage: https://github.com/honeo/image-loaded-promise#readme
- Issues: https://github.com/honeo/image-loaded-promise/issues
- npm.io page: https://npm.io/package/image-loaded-promise

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2018-06-01

## README

# image-loaded-promise
* [honeo/image-loaded-promise](https://github.com/honeo/image-loaded-promise)  
* [image-loaded-promise](https://www.npmjs.com/package/image-loaded-promise)


## なにこれ
要素の画像読み込みを待つ。  
Lazy Load対応。


## 使い方
```bash
$ npm i image-loaded-promise
```
```js
import imageLoadedPromise from 'image-loaded-promise';

// or CDN, Dynamic import
const {default: Mod} = await import('https://cdn.rawgit.com/honeo/image-loaded-promise/master/image-loaded.min.mjs');



// img.srcを監視
await imageLoadedPromise(img);

// background-imageを監視
await imageLoadedPromise(div);

// PNG画像がURLに設定されるまで待ってから監視
await imageLoadedPromise(img, /\.png$/);
```



## API

### imageLoadedPromise(element [, regexp])
引数1要素の画像読み込みを監視する。  
読み込み終了時に要素を引数に解决するpromiseを返す。  

* 引数2に正規表現があるとき
	- 要素にそれとmatchする画像URLが設定されるまで待機する。

* 既に要素の画像読込が終了しているとき
	- 即座に解決する。

* 要素にsrc属性やbackground-Imageが未設定なとき
	- 要素に画像URLが設定されるまで待機する。


## 注意
* [MutationObserver - Web API インターフェイス | MDN](https://developer.mozilla.org/ja/docs/Web/API/MutationObserver)を使っている。
	- レガシー環境では要Polyfill.
* 同じような名前の他ライブラリ・モジュールとは一切関係ない。

---
_Source: https://npm.io/package/image-loaded-promise · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._