1.0.0 • Published 1 year ago

@freakycoder/react-native-progressive-fast-image v1.0.0

Weekly downloads
79
License
MIT
Repository
github
Last release
1 year ago

Battle Tested ✅

Customizable progressive image for React Native with FastImage

npm version npm Platform - Android and iOS License: MIT styled with prettier

Installation

Add the dependency:

npm i @freakycoder/react-native-progressive-fast-image

Peer Dependencies

"react-native-fast-image": ">= 8.3.2"

Usage

Import

import ProgressiveFastImage from "@freakycoder/react-native-progressive-fast-image";

Fundamental Usage

It accepts every Image and FastImage props. You can use it like you used to.

<ProgressiveFastImage
  source={require("./assets/my-image.png")}
  thumbnailSource={require("./assets/my-image.png")}
/>

Configuration - Props

PropertyTypeDefaultDescription
sourceSourceundefinedset the main source of the image
thumbnailSourceImageSourcePropTypeundefinedset the thumbnail source of the image
loadingSourceImageSourcePropTypeundefinedset the error source of the image
errorSourceImageSourcePropTypeundefinedset the loading source of the image
loadingImageComponentComponentdefaultWARNING: Read the below!
blurRadiusnumber15change the blur radius level

loadingImageComponent Usage

If you want to set your own component for the loading image, you should set this style for the top of the component

{
  top: 0,
  left: 0,
  right: 0,
  bottom: 0,
  position: "absolute",
  alignItems: "center",
  alignSelf: "center",
  justifyContent: "center",
}

Customization Props

PropertyTypeDefaultDescription
stylestyledefaultchange or override main image style
loadingImageContainerStylestyledefaultchange or override loading image container style
loadingImageStylestyledefaultchange or override loading image style
thumbnailImageStylestyledefaultchange or override thumbnail image style
thumbnailAnimationDurationnumberdefaultchange the thumbnail animation's duration
imageAnimationDurationnumberdefaultchange the main image animation's duration
onLoadfunctiondefaultcalling the onLoad
onThumbnailLoadfunctiondefaultcalling the onThumbnailLoad
onLoadEndfunctiondefaultcalling the onLoadEnd
onErrorfunctiondefaultcalling the onError

Future Plans

  • LICENSE
  • Built-in Loading Indicator
  • Built-in Error Image Source
  • Write an article about the lib on Medium

Better with built-in bug fix

Fixes FastImage's source null bug-fix.

Author

FreakyCoder, kurayogun@gmail.com

License

React Native Progressive Fast Image is available under the MIT license. See the LICENSE file for more info.