🚩 FastImage, performant React Native image component.
Go to file
Dylan Vann 2e2a4175c4 🚫 Add error state. 2017-04-18 10:43:35 -04:00
__snapshots__ 📸 Add basic snapshot test. 2017-04-17 19:50:22 -04:00
android 🚩 Initial commit. 2017-04-17 18:42:16 -04:00
example 🚫 Add error state. 2017-04-18 10:43:35 -04:00
ios 🚩 Initial commit. 2017-04-17 18:42:16 -04:00
server 🗒 sort-package-json. 2017-04-18 02:05:10 -04:00
.babelrc 📸 Add basic snapshot test. 2017-04-17 19:50:22 -04:00
.gitignore 🚩 Initial commit. 2017-04-17 18:42:16 -04:00
.gitmodules 🚩 Initial commit. 2017-04-17 18:42:16 -04:00
.npmignore Document running example server and move server directory. 2017-04-18 01:45:28 -04:00
FastImage.js 🚩 Initial commit. 2017-04-17 18:42:16 -04:00
FastImage.test.js 📸 Add basic snapshot test. 2017-04-17 19:50:22 -04:00
LICENSE 🚩 Initial commit. 2017-04-17 18:42:16 -04:00
README.md 🎞 More gifs. 2017-04-17 21:11:33 -04:00
circle.yml Add circle.yml. 2017-04-17 19:55:56 -04:00
package.json Add prettier-check to test. 2017-04-18 02:06:21 -04:00
sample.png 🚩 Initial commit. 2017-04-17 18:42:16 -04:00
yarn.lock Add prettier-check to test. 2017-04-18 02:06:21 -04:00

README.md

FastImage

FastImage, performant React Native image component.

npm CircleCI license


Comparing FastImage to Image in the example app.

React Native's Image component handles image caching like browsers for the most part. If the server is returning proper cache control headers for images you'll generally get the sort of built in caching behavior you'd have in a browser. Even so many people have noticed:

  • Flickering.
  • Cache misses.
  • Low performance loading from cache.
  • Low performance in general.

FastImage is an Image replacement that solves these issues. FastImage is a wrapper around SDWebImage (iOS) and Glide (Android).

Features

  • Aggressively cache images.
  • Add authorization headers.
  • Prioritize images.

Usage

yarn add react-native-fast-image
react-native link

import FastImage from 'react-native-fast-image'

const YourImage = () =>
  <FastImage
    style={styles.image}
    source={{
      uri: 'https://unsplash.it/400/400?image=1',
      headers:{ Authorization: 'someAuthToken' },
      priority: FastImage.priority.normal,
    }}
    resizeMode={FastImage.resizeMode.contain}
  />

Properties

source?: object

Source for the remote image to load.


source.uri?: string

Remote url to load the image from. e.g. 'https://facebook.github.io/react/img/logo_og.png'.


source.headers?: object

Headers to load the image with. e.g. { Authorization: 'someAuthToken' }.


source.priority?: enum

  • FastImage.priority.low - Low Priority
  • FastImage.priority.normal (Default) - Normal Priority
  • FastImage.priority.high - High Priority

resizeMode?: enum

  • FastImage.resizeMode.contain (Default) - Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or less than the corresponding dimension of the view (minus padding).
  • FastImage.resizeMode.cover - Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or larger than the corresponding dimension of the view (minus padding).
  • FastImage.resizeMode.stretch - Scale width and height independently, This may change the aspect ratio of the src.
  • FastImage.resizeMode.center - Do not scale the image, keep centered.

onLoad?: () => void

Called on a successful image fetch.


onError?: () => void

Called on an image fetching error.