# angular-image

> directive to catch image load errors

Latest version **1.0.3** (published 2018-09-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install angular-image
pnpm add angular-image
yarn add angular-image
bun add angular-image
```

## 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.3 |
| Published | 2018-09-13 |
| First published | 2018-09-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | brandomota |

## Links

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

## Recent versions

- 1.0.3 (latest) — 2018-09-13
- 1.0.2 — 2018-09-13
- 1.0.1 — 2018-09-12
- 1.0.0 — 2018-09-12

## README

# `angular-image`

Fix and report image load errors. Provide a fallback image src if desired.

### Report Image Failure

The jquery error event is exposed as `$event` and the failed image url is exposed as `$src`.

```html
<img ng-src="{{ user.image }}" ng-error="report($event, $src)">
```

```javascript
app.controller(function ($scope) {
  $scope.user = getUser()

  $scope.report = function (ev, src) {
    // reload user resource
  }
})
```

You can specify a fallback image src with interpolation.

```html
<img ng-src="{{ user.image }}" ng-error-src="/fallback/{{ user.type }}.png">
```

The `ng-error` invocation injects a special `$src` variable in case you want the exact image url that failed.

### Real Use Case

Why would you want to catch image load errors? For my use case, I want to replace broken social media profile pictures. If the image is broken, it sends an http request to refresh the image on the server, and then replaces the image with the correct url. 

In practice, this means that instead of a completely broken or missing image, it just looks like it took a little longer to load than usual. With something real-time like Firebase, it's hard to tell what loaded correctly the first time and what needed to be corrected. 

### Install

Install the package.

```sh
$ bower install --save angular-image
```

Include the script.

```
bower_components/angular-image/angular-image.js
```

Add the `ngImage` dependency.

```javascript
angular.module('myApp', [ 'ngImage' ])
```

**Original package repository is:** https://github.com/aj0strow/angular-image (thanks to original developer :) )

RELEASE NOTES:

1.0.3:
 - Add to original code the directive ´ng-src-success´:

 ```html
 <img ng-src="{{ user.image }}" ng-src-success="sendOkMessage()">
 ```


**MIT License**.

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