https://github.com/candlefinance/faster-image/assets/12258850/ede91008-4dca-417c-a2ca-4d2177066316
A performant way to render images in React Native with a focus on speed and memory usage. Powered by Nuke, the smallest and most performant image loading library for iOS and macOS and Coil on Android.
The framework is lean and compiles in under 2 seconds¹. Nuke has an automated test suite 2x the size of the codebase itself, ensuring excellent reliability. Every feature is carefully designed and optimized for performance.
Coil performs a number of optimizations including memory and disk caching, downsampling the image in memory, automatically pausing/cancelling requests, and more.
Features
- Supports visionOS
- Fast image loading
- Memory and disk caching
- Placeholder support:
- Animated transition
- Failure image
- Typescript support
- Written in Swift/Kotlin
To be added
- GIF support
Installation
yarn add @candlefinance/faster-image
Usage
import { FasterImageView, clearCache, prefetch } from '@candlefinance/faster-image';
<FasterImageView
style={styles.image}
onSuccess={(event) => {
console.log(event.nativeEvent);
}}
onError={(event) => console.warn(event.nativeEvent.error)}
source={{
transitionDuration: 0.3,
borderRadius: 50,
cachePolicy: 'discWithCacheControl',
showActivityIndicator: true,
url: 'https://picsum.photos/200/200?random=1',
}}
/>;
// Clear memory and disk cache
await clearCache();
// Prefetch
await prefetch(['https://picsum.photos/200/200?random=0'])
Props
| Prop | Type | Default | Description |
|---|---|---|---|
| url | string | The URL of the image | |
| style | object | The style of the image | |
| resizeMode | string | contain | The resize mode of the image |
| thumbhash | string | The thumbhash of the image as a base64 encoded string to show while loading (Android not tested) | |
| blurhash | string | The blurhash of the image to show while loading (iOS only) | |
| showActivityIndicator | boolean | false (iOS only) | Whether to show the UIActivityIndicatorView indicator when the image is loading |
| activityColor | ColorValue | undefined (iOS only) | Activity indicator color. Changed default activity indicator color. Only hex supported |
| base64Placeholder | string | The base64 encoded placeholder image to show while the image is loading | |
| cachePolicy | string | memory | The cache policy of the image |
| transitionDuration | number | 0.75 (iOS) Android (100) | The transition duration of the image |
| borderRadius | number | 0 | border radius of image |
| borderTopLeftRadius | number | 0 | top left border radius of image |
| borderTopRightRadius | number | 0 | top right border radius of image |
| borderBottomLeftRadius | number | 0 | bottom left border radius of image |
| borderBottomRightRadius | number | 0 | bottom right border radius of image |
| failureImage | string | If the image fails to download this will be set (blurhash, thumbhash, base64) | |
| progressiveLoadingEnabled | boolean | false | Progressively load images (iOS only) |
| onError | function | The function to call when an error occurs. The error is passed as the first argument of the function | |
| onSuccess | function | The function to call when the image is successfully loaded | |
| grayscale | number | 0 | Filter or transformation that converts the image into shades of gray (0-1). |
| colorMatrix | number[][] | Color matrix that is applied to image | |
| ignoreQueryParamsForCacheKey | boolean | false | Ignore URL query parameters in cache keys |
| allowHardware | boolean | true | Allow hardware rendering (Android only) |
| headers | Record<string, string> | undefined | Pass in headers |
| accessibilityLabel | string | undefined | accessibility label |
| accessible | boolean | undefined | is accessible |
Contributing
See the contributing guide to learn how to contribute to the repository and the development workflow.
License
MIT