k-lpmg / faster-image Goto Github PK

This project forked from candlefinance/faster-image

Fast image loading for React Native backed by performant native libraries.

License: MIT License

JavaScript 0.55% Ruby 1.18% C 0.03% Objective-C 0.93% Java 2.21% Kotlin 0.35% TypeScript 1.62% Objective-C++ 0.34% Swift 92.79%

faster-image's Introduction

trimmed2.mp4

A performant way to render images in React Native (iOS only, Android defaults to the standard component Image) with a focus on speed and memory usage. Powered by Nuke, the smallest and most performant image loading library for iOS and macOS.

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.

Features

Installation

yarn add @candlefinance/faster-image

Usage

import { FasterImageView } from '@candlefinance/faster-image';

<FasterImageView
  rounded={true}
  onError={(event) => console.warn(event.nativeEvent.error)}
  style={{ width: 300, height: 300 }}
  thumbhash="k0oGLQaSVsJ0BVhn2oq2Z5SQUQcZ"
  cachePolicy="discNoCacheControl"
  transitionDuration={0.3}
  url="https://picsum.photos/seed/3240/4000/3000"
/>;

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
blurhash	string		The blurhash of the image to show while loading
showActivityIndicator	boolean	false	Whether to show the UIActivityIndicatorView indicator when the image is loading
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	The transition duration of the image
rounded	boolean	false	Round the image into a circle
failureImage	string		If the image fails to download this will be set (blurhash, thumbhash, base64)
progressiveLoadingEnabled	boolean	false	Progressively load images
onError	function		The function to call when an error occurs. The error is passed as the first argument of the function
onSucess	function		The function to call when the image is successfully loaded