KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #typescript #dsh #dsh-plugin #ai-agent #codex #ai-agents #deepseek-harness #claude-code #cli #react #mcp

react-native-ximage

★ 31 Open GitHub ↗

An alternative to react native's Image component with cache support.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# DEPRECATED
**You would not need this package** as react-native's Image component does caching. Also, react-native>=0.25 allows [prefetch remote images](https://github.com/facebook/react-native/commit/f7bcb3e98d489bb40ee8fd7dd69918521344f657).

# react-native-ximage
**XImage** is an alternative to react native's Image component with cache support. It offers a component and a storage class.

# Usage
XImage depends on [react-native-fs](https://github.com/johanneslumpe/react-native-fs). You need to install this package frist and link the library using rnpm.

```
npm i -S react-native-fs
rnpm link
```

Then install react-native-ximage:
```
npm i -S react-native-ximage
```

# XImage component
To make XImage download and cache an image, you need to set `url` prop.

```jsx
import XImage from 'react-native-ximage`;

// ...
<XImage url="https://facebook.github.io/react/img/logo_og.png"/>
```

If you want XImage to show a default image while the image is being downloaded or in case for some reason the download process failed, you can set the `defaultSource` prop as well:

```jsx
<XImage 
  url="https://facebook.github.io/react/img/logo_og.png"
  defaultSource={require('./images/defaultLogo.jpg')}
/>
```

# Storage options configuration
XImage by default stores the downloaded images in `BASE_DIR/.images/` and hashes the URL with md5. If you want to change any of those options you can call two methods on Storage singleton.

```js
import { storage } from 'react-native-ximage/src/Storage';
import sha512 from 'some-crypt-lib';

storage.setCacheDirectory('path/to');
storage.setHashFunction(sha512);
```

react-native-ximage

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README