react-native-fast-image version 2.0.0

Open Beta Documentation Amazon offers this technical documentation as part of a pre-release, open beta. The features described might change as Amazon receives feedback and iterates on the features. For the most current feature information, see the Release Notes.

Note: This page refers to the react-native-fast-image library version 2.0.0, supported by Vega SDK version 0.20 and earlier. Starting with Vega SDK version 0.21, this library will not be supported. Upgrade to react-native-fast-image version 3.0.0.

@amazon-devices/react-native-fast-image version 2.0.0 provides support on Vega for react-native-fast-image which provides a performant React Native image component.

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 on other platforms besides Web.

This is a system-deployed library and is available to React Native for Vega apps without a separate installation process. It is deployed as an autolinking library which your app links to at runtime. Compatibility is guaranteed only between the library and the version of React Native for Vega for which it is built.

When you up level the version of React Native for Vega with which your app is built, it's a best practice to also uplevel the version of the library on which it is dependent.

For more information about this library and its API, see the README.md in the FastImage GitHub repo.

Installation

Add the JavaScript library dependency in the package.json file:

Copied to clipboard.

"dependencies": {
   ...
   "@amazon-devices/react-native-fast-image": "~2.0.0"
}

Reinstall dependencies using the npm install command.

Examples

Copied to clipboard.

import FastImage from '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}
    />
)

Supported APIs

Component API

Prop	Description	Default
`source`	Source for the remote image to load.	None
`source.uri`	Remote url to load the image from. For example, 'https://facebook.github.io/react/img/logo_og.png'.	None
`source.priority`	`FastImage.priority.low` - Low Priority `FastImage.priority.normal` - Normal Priority `FastImage.priority.high` - High Priority	`FastImage.priority.normal`
`resizeMode`	`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` - Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image is equal to or larger than the corresponding dimension of the view (minus padding) `FastImage.resizeMode.stretch` - Scale width and height independently, This might change the aspect ratio of the source. `FastImage.resizeMode.center` - Do not scale the image, keep centered	`FastImage.resizeMode.cover`
`onFastImageLoadStart`	Called when the image starts to load.	None
`onFastImageLoad`	Called on a successful image fetch. Called with the width and height of the loaded image.	None
`onFastImageError`	Called on an image fetching error.	None
`onFastImageLoadEnd`	Called when the image finishes loading, whether it was successful or an error.	None

Methods

Method	Description
`preLoad`	Preload images to display later.
`clearMemoryCache`	Clear all images from memory cache.
`clearDiskCache`	Clear all images from disk cache.

Exceptions on Vega

React Native for Vega library has a few exceptions in terms of API support. This section will go over those exceptions.

source.headers is not supported on Vega platform
source.cache is not supported on Vega platform
tintColor is not supported on Vega platform
defaultSource is not supported on Vega platform
onFastImageProgress is not supported on Vega platform due to known issues with Image.onProgress which this callback depends on

Backward compatibility issue

Vega OS versions v0.12, OS 1.1 (201010334050), and higher are not compatible with amzn/react-native-fast-image (npm package) versions <=2.0.1726598878.

When running an app built against an old version of the npm package on versions v0.12 and higher of the OS, you will see the following crash on startup:

Volta:Invariant Violation: TurboModuleRegistry.getEnforcing(...): 'FastImageTurboModule' could not be found. Verify that a module by this name is registered in the native binary.

To fix this, you must rebuild your app against the latest version of @amazon-devices/react-native-fast-image:

Make sure that your app's package.json does not hardcode any old version of fast-image.
1. Recommended to use semvar version ~2.0.0 to allow your app to pick up the latest patch.
Delete package-lock.json to remove any locked fast-image version.
1. If you are relying on package-lock.json to lock other dependencies, you can manually delete the entry for @amazon-devices/react-native-fast-image.
To make sure that npm doesn't pick up an old cached version, delete the node_modules folder.
Rebuild your app.

Supported versions

Package Version	Based On	@amazon-devices/react-native-kepler version
2.0.x	8.6.3	2.0.x

Additional Resources

For information on additonal libraries, see Supported Third-Party Libraries and Services.

Last updated: Sep 30, 2025