Naughty Programmer's Madness
    Wondering what’s next for npm?Check out our public roadmap! »

    @aaxis/react-native-fast-image
    TypeScript icon, indicating that this package has built-in type declarations

    8.3.6 • Public • Published

    🚩 FastImage

    Performant React Native image component. This is fork from react-native-fast-image:v8.3.4, and fixed an issue which support 0.60+ react-native.

    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

    • [x] Aggressively cache images.
    • [x] Add authorization headers.
    • [x] Prioritize images.
    • [x] Preload images.
    • [x] GIF support.
    • [x] Border radius.

    Usage

    Note: You must be using React Native 0.60.0 or higher to use the most recent version of react-native-fast-image.

    yarn add @aaxis/react-native-fast-image
    import FastImage from '@aaxis/react-native-fast-image'
    
    const YourImage = () => (
        <FastImage
            style={{ width: 200, height: 200 }}
            source={{
                uri: 'https://unsplash.it/400/400?image=1',
                headers: { Authorization: 'someAuthToken' },
                priority: FastImage.priority.normal,
            }}
            resizeMode={FastImage.resizeMode.contain}
        />
    )

    Are you using Glide already using an AppGlideModule?

    Are you using Proguard?

    If you use Proguard you will need to add these lines to android/app/proguard-rules.pro:

    -keep public class com.dylanvann.fastimage.* {*;}
    -keep public class com.dylanvann.fastimage.** {*;}
    -keep public class * implements com.bumptech.glide.module.GlideModule
    -keep public class * extends com.bumptech.glide.module.AppGlideModule
    -keep public enum com.bumptech.glide.load.ImageHeaderParser$** {
      **[] $VALUES;
      public *;
    }
    

    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.

    source.cache?: enum

    • FastImage.cacheControl.immutable - (Default) - Only updates if url changes.
    • FastImage.cacheControl.web - Use headers and follow normal caching procedures.
    • FastImage.cacheControl.cacheOnly - Only show images from cache, do not make any network requests.

    resizeMode?: enum

    • FastImage.resizeMode.contain - 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 (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 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.

    onLoadStart?: () => void

    Called when the image starts to load.


    onProgress?: (event) => void

    Called when the image is loading.

    e.g. onProgress={e => console.log(e.nativeEvent.loaded / e.nativeEvent.total)}


    onLoad?: (event) => void

    Called on a successful image fetch. Called with the width and height of the loaded image.

    e.g. onLoad={e => console.log(e.nativeEvent.width, e.nativeEvent.height)}


    onError?: () => void

    Called on an image fetching error.


    onLoadEnd?: () => void

    Called when the image finishes loading, whether it was successful or an error.


    style

    A React Native style. Supports using borderRadius.


    fallback: boolean

    If true will fallback to using Image. In this case the image will still be styled and laid out the same way as FastImage.


    tintColor?: number | string

    If supplied, changes the color of all the non-transparent pixels to the given color.

    Static Methods

    FastImage.preload: (source[]) => void

    Preload images to display later. e.g.

    FastImage.preload([
        {
            uri: 'https://facebook.github.io/react/img/logo_og.png',
            headers: { Authorization: 'someAuthToken' },
        },
        {
            uri: 'https://facebook.github.io/react/img/logo_og.png',
            headers: { Authorization: 'someAuthToken' },
        },
    ])

    Troubleshooting

    If you have any problems using this library try the steps in troubleshooting and see if they fix it.

    If you meet an issue with "unable to access 'https://chromium.googlesource.com/webm/libwebp'" when execute pod install. Please go to your cocoapod folder: /Users//.cocoapods/repos/trunk/Specs/1/9/2/libwebp/1.1.0 then change libwebp.podspec.json source.git to "https://github.com/webmproject/libwebp.git"

    Development

    Follow these instructions to get the example app running.

    Supported React Native Versions

    This project only aims to support the latest version of React Native.
    This simplifies the development and the testing of the project.

    If you require new features or bug fixes for older versions you can fork this project.

    Credits

    The idea for this modules came from vovkasm's react-native-web-image package. It also uses Glide and SDWebImage, but didn't have some features I needed (priority, headers).

    Thanks to @mobinni for helping with the conceptualization

    Licenses

    • FastImage - MIT © DylanVann
    • SDWebImage - MIT
    • Glide - BSD, part MIT and Apache 2.0. See the LICENSE file for details.

    Install

    npm i @aaxis/react-native-fast-image

    DownloadsWeekly Downloads

    0

    Version

    8.3.6

    License

    (MIT AND Apache-2.0)

    Unpacked Size

    121 kB

    Total Files

    35

    Last publish

    Collaborators

    • avatar