Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

react-native-turbo-image

Package Overview
Dependencies
Maintainers
0
Versions
66
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-native-turbo-image

Performant image for React native

  • 1.11.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
9.1K
increased by25.66%
Maintainers
0
Weekly downloads
 
Created
Source

You can find more examples in example folder

react-native-turbo-image

Performant image Component for React Native. Powered by Nuke and Coil

Features

  • Support New Architecture. see the example
  • Support authorization headers
  • Support thumbhash and blurhash for placeholder
  • Memory cache, aggressive LRU disk cache and HTTP disk cache
  • Prefetch, cleanMemoryCache and cleanDiskCache
  • Written in TypeScript, Swift and Kotlin
  • Support special formats (SVG, Gif, APNG)

Installation

npm install react-native-turbo-image

cd ios && pod install

Usage

import TurboImage from 'react-native-turbo-image';

// remote image

<TurboImage
  source={{ uri: "https://placedog.net/300/300?id=1" }}
  style={{ width: 300, height: 300 }}
  cachePolicy="urlCache"
/>;

// local asset

<TurboImage
  source={require('../../assets/local.png')}
  style={{ width: 300, height: 300 }}
/>;

Paramaters

ParameterTypeDescriptionDefault
sourceObject or number(Required) Can be an object containing a uri string for remote image or local asset using require.-
styleImageStyleStyles to be applied to the image.-
placeholderobjectshow placeholder while loading, either thumbhash or blurhash-
cachePolicystringmemory: LRU memory cache for processed images. dataCache: aggressive LRU disk cache urlCache: HTTP disk cache, respect cache-controlmemory
resizeModeStringResize the image with one of the options: contain cover stretch centercontain
indicatorobjectstyle: medium(default) or largecolor: number / ColorValue-
fadeDurationnumberThe transition duration of the image. Note: To avoid flicking, it will be set to 0 when a placeholder is provided300(iOS) / 100(Android)
resizenumberScales an image to the given width preserving aspect ratio-
blurnumberThe blur radius of the blur filter added to the image-
monochromenumber / ColorValueThe color applied to the image. note: For iOS and Android Q+, it works with any color. For Android Q-, it only supports grayscale-
tintnumber / ColorValueThe color is applied to every non-transparent pixel, causing the image’s shape to adopt that color. This effect is not applied to placeholders-
showPlaceholderOnFailurebooleanShow the blur placeholder image in the case of a failurefalse
roundedbooleanRound the image into a circlefalse
enableLiveTextInteractionbooleanEnables Live Text interaction with the image (iOS 16+ only)false
allowHardwarebooleanSetting this to false this will reduce performance on API 26 and above. Only disable this if necessary. Coil's docs (Android only)false
formatstringSpecify the format for special image, e.g. svg, gif and apng. In general, TurboImage will determine the decoder automatically.-
onStartFunctionThe function to call when the image is fetching.-
onSuccessFunctionThe function to call when the image is successfully loaded-
onFailureFunctionThe function to call when the request failed-
onCompletionFunctionThe function to call when the request is completed-

Methods

prefetch

TurboImage.prefetch([URLs]);

clearMemoryCache

await TurboImage.clearMemoryCache();

clearDiskCache

await TurboImage.clearDiskCache();

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

Keywords

FAQs

Package last updated on 08 Aug 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc