# @unpourtous/react-native-image-indicator

> react native component for image with indicator and default image

Latest version **1.1.2** (published 2018-01-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @unpourtous/react-native-image-indicator
pnpm add @unpourtous/react-native-image-indicator
yarn add @unpourtous/react-native-image-indicator
bun add @unpourtous/react-native-image-indicator
```

## 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.1.2 |
| Published | 2018-01-19 |
| First published | 2017-05-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | haywood |
| Maintainers | millerw, lemori, haywood, mcalsace, erichua23 |
| Keywords | react-native, image, indicator, default image |

## Links

- npm: https://www.npmjs.com/package/@unpourtous/react-native-image-indicator
- Repository: https://github.com/UnPourTous/react-native-image-indicator
- Homepage: https://github.com/UnPourTous/react-native-image-indicator#readme
- Issues: https://github.com/UnPourTous/react-native-image-indicator/issues
- npm.io page: https://npm.io/package/@unpourtous/react-native-image-indicator

## Dependencies (1)

- [react-native-cached-image](https://npm.io/package/react-native-cached-image.md) 1.4.3

## 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.1.2 (latest) — 2018-01-19
- 1.1.1 — 2018-01-05
- 1.1.0 — 2018-01-05
- 1.0.10 — 2017-09-18
- 1.0.6 — 2017-06-19
- 1.0.5 — 2017-05-23
- 1.0.4 — 2017-05-23
- 1.0.3 — 2017-05-23
- 1.0.2 — 2017-05-23
- 1.0.1 — 2017-05-23

## README

# A Image Component with Indicator, Default Image and Error Default Image

[![JavaScript Style Guide](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)

### React Native Indicator Image 

A image component with indicator and error default image

<img src='https://github.com/UnPourTous/react-native-image-indicator/blob/master/screenshots/react-native-image-indicator-demo.gif?raw=true' />

## Installation

`$ npm install @unpourtous/react-native-image-indicator --save`

## Usage

```js
import CustomImage from '@unpourtous/react-native-image-indicator'

<CustomImage
  style={{alignItems: 'center', justifyContent: 'center', height:300,width:300, backgroundColor: '#fdf9e6'}}
  source={'image url'}
  defaultImage={require('./images/default.jpg')}
  errorImage={require('./images/error.png')} />
```
## API

Props | Type | Description
--- | --- | --- 
source | string | The remote URL image source.
useQueryParamsInCacheKey | bool | Config if cache key contains `query` in url, default value is `true` 
defaultImage | number | The image before remote image loaded
errorImage | number | The image when remote image loade failed
renderIndicator | function | The function that render indicator component(exclusion indicator when renderIndicator setted)
indicator | function | The indicator component when image is loading
indicatorProps | object | The props of indicator component 
threshold | number | Delay before indicator component show in milliseconds, default value 50.

## License
This library is distributed under MIT Licence.<br>
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FUnPourTous%2Freact-native-image-indicator.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FUnPourTous%2Freact-native-image-indicator?ref=badge_large)

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