Gathering detailed insights and metrics for react-native-fast-image
Gathering detailed insights and metrics for react-native-fast-image
Gathering detailed insights and metrics for react-native-fast-image
Gathering detailed insights and metrics for react-native-fast-image
@preflower/react-native-web-fast-image
react-native-fast-image for Web
@d11/react-native-fast-image
🚩 FastImage, performant React Native image component.
@phantom/react-native-fast-image
🚩 FastImage, performant React Native image component.
react-native-fast-image-check
🚩 FastImage, performant React Native image component.
🚩 FastImage, performant React Native image component.
npm install react-native-fast-image
Module System
Min. Node Version
Typescript Support
Node Version
NPM Version
8,229 Stars
575 Commits
1,508 Forks
61 Watching
4 Branches
65 Contributors
Updated on 27 Nov 2024
Minified
Minified + Gzipped
TypeScript (51.8%)
Java (31.39%)
Objective-C (13.93%)
JavaScript (1.29%)
Ruby (1.14%)
Starlark (0.44%)
Cumulative downloads
Total Downloads
Last day
4.9%
50,301
Compared to previous day
Last week
9%
253,288
Compared to previous week
Last month
2.1%
1,029,477
Compared to previous month
Last year
14.9%
12,097,464
Compared to previous year
FastImage 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:
FastImage
is an Image
replacement that solves these issues.
FastImage
is a wrapper around
SDWebImage (iOS)
and
Glide (Android).
Note: You must be using React Native 0.60.0 or higher to use the most recent version of react-native-fast-image
.
1yarn add react-native-fast-image 2cd ios && pod install
1import FastImage from 'react-native-fast-image' 2 3const YourImage = () => ( 4 <FastImage 5 style={{ width: 200, height: 200 }} 6 source={{ 7 uri: 'https://unsplash.it/400/400?image=1', 8 headers: { Authorization: 'someAuthToken' }, 9 priority: FastImage.priority.normal, 10 }} 11 resizeMode={FastImage.resizeMode.contain} 12 /> 13)
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 *;
}
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.defaultSource?: number
require(...)
.Image
implementation, on Android defaultSource
does not work in debug mode. This is due to the fact that assets are sent from the dev server, but RN's functions only know how to load it from res
.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.
FastImage.preload: (source[]) => void
Preload images to display later. e.g.
1FastImage.preload([ 2 { 3 uri: 'https://facebook.github.io/react/img/logo_og.png', 4 headers: { Authorization: 'someAuthToken' }, 5 }, 6 { 7 uri: 'https://facebook.github.io/react/img/logo_og.png', 8 headers: { Authorization: 'someAuthToken' }, 9 }, 10])
FastImage.clearMemoryCache: () => Promise<void>
Clear all images from memory cache.
FastImage.clearDiskCache: () => Promise<void>
Clear all images from disk cache.
If you have any problems using this library try the steps in troubleshooting and see if they fix it.
Follow these instructions to get the example app running.
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.
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
The latest stable version of the package.
Stable Version
1
5.3/10
Summary
Credential leak in react-native-fast-image
Affected Versions
< 8.3.0
Patched Versions
8.3.0
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
Reason
binaries present in source code
Details
Reason
Found 7/30 approved changesets -- score normalized to 2
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
Reason
project is not fuzzed
Details
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
Reason
branch protection not enabled on development/release branches
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Reason
67 existing vulnerabilities detected
Details
Score
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More