# react-native-beautiful-image

> Beautiful Image component for React Native

Latest version **2.0.0** (published 2025-05-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-native-beautiful-image
pnpm add react-native-beautiful-image
yarn add react-native-beautiful-image
bun add react-native-beautiful-image
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2025-05-07 |
| First published | 2017-04-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 577.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 62 |
| Author | hauvo |
| Maintainers | hauvo |
| Keywords | react-native |

## Links

- npm: https://www.npmjs.com/package/react-native-beautiful-image
- Repository: https://github.com/phuochau/react-native-beautiful-image
- Homepage: https://github.com/phuochau/react-native-beautiful-image#readme
- Issues: https://github.com/phuochau/react-native-beautiful-image/issues
- npm.io page: https://npm.io/package/react-native-beautiful-image

## Recent versions

- 2.0.0 (latest) — 2025-05-07
- 1.0.4 — 2017-04-02
- 1.0.3 — 2017-04-02
- 1.0.2 — 2017-04-02
- 1.0.1 — 2017-04-02
- 1.0.0 — 2017-04-02

## README

# react-native-beautiful-image

A beautiful image component for React Native with fade-in animation and placeholder support.

## Installation

```bash
npm install react-native-beautiful-image
# or
yarn add react-native-beautiful-image
```

## Usage

```typescript
import Image from 'react-native-beautiful-image';

// Basic usage
<Image
  source={{ uri: 'https://example.com/image.jpg' }}
  style={{ width: 200, height: 200 }}
/>

// With placeholder
<Image
  source={{ uri: 'https://example.com/image.jpg' }}
  placeholderSource={require('./assets/placeholder.jpg')}
  style={{ width: 200, height: 200 }}
/>

// With callbacks
<Image
  source={{ uri: 'https://example.com/image.jpg' }}
  onLoad={() => console.log('Image loaded')}
  onError={() => console.log('Image failed to load')}
  style={{ width: 200, height: 200 }}
/>
```

## Props

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| source | ImageSourcePropType | Yes | The source of the image |
| style | StyleProp<ImageStyle> | No | Style for the image |
| onLoad | () => void | No | Callback when image loads successfully |
| onError | () => void | No | Callback when image fails to load |
| placeholderSource | ImageSourcePropType | No | Image to show while loading or on error |

## TypeScript Support

This library is written in TypeScript and includes type definitions. The main component is exported as:

```typescript
import Image, { ImageExtProps } from 'react-native-beautiful-image';
```

## License

MIT

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