README.md

React Native Scalable Image

React Native <Image/> component which scales width or height automatically to keep the aspect ratio. Is useful when you need to display an entire network image but don't know its size and can limit it only by width or height.

The following example creates an image which fits the full screen width and keeps the aspect ratio:

import React from 'react';
import { Dimensions } from 'react-native';
import Image from 'react-native-scalable-image';

const image = <Image width={Dimensions.get('window').width} source={{uri: '<image uri>'}} />;

Install

npm install react-native-scalable-image --save

Usage

Specify width or height which may be calculated dynamically like in the example above. All other props are the same as in regular React Native <Image/> component.

props

name	type	default	description
height	number	Calculated dynamically	Image height
width	number	Calculated dynamically	Image width
maxHeight	number	Number.MAX_VALUE	Maximum image height
maxWidth	number	Number.MAX_VALUE	Maximum image width
onPress	function	none	Touchable functionality
background	boolean	false	Replacing with ImageBackground