Skip to content

Latest commit

 

History

History

bpk-component-image

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

bpk-component-image

Backpack React Native image component.

Default

Day Night
bpk-component-image default iPhone 8 simulator bpk-component-image default iPhone 8 simulator - dark mode
bpk-component-image default Google Pixel emulator bpk-component-image default Google Pixel emulator - dark mode

No border radius

Day Night
bpk-component-image no-border-radius iPhone 8 simulator bpk-component-image no-border-radius iPhone 8 simulator - dark mode
bpk-component-image no-border-radius Google Pixel emulator bpk-component-image no-border-radius Google Pixel emulator - dark mode

Installation

Check the main Readme for a complete installation guide.

Usage

Default

import React, { Component } from 'react';
import { StyleSheet, View } from 'react-native';
import { spacingBase, spacingLg } from '@skyscanner/bpk-foundations-react-native/tokens/base.react.native';
import BpkImage from 'backpack-react-native/bpk-component-image';

const styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: 'center',
    padding: spacingBase,
  },
  image: {
    width: '100%',
    height: spacingLg * 10,
  },
});

export default () => (
  <View style={styles.container}>
    <BpkImage style={styles.image} alt="image title" source={{uri: "imageUri"}} />
  </View>
);

With Loading Behaviour

import React, { Component } from 'react';
import { StyleSheet, View } from 'react-native';
import { spacingBase, spacingLg } from '@skyscanner/bpk-foundations-react-native/tokens/base.react.native';
import BpkImage, { withLoadingBehaviour } from 'backpack-react-native/bpk-component-image';

const BpkImageWithLoading = withLoadingBehaviour(BpkImage);

const styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: 'center',
    padding: spacingBase,
  },
  image: {
    width: '100%',
    height: spacingLg * 10,
  },
});

export default () => (
  <View style={styles.container}>
    <BpkImageWithLoading style={styles.image} alt="image title" source={{uri: "imageUri"}} />
  </View>
);

Props

BpkImage

Property PropType Required Default Value
source oneOf(number, object, arrayOf(object)) true -
imageComponent function false Animated.Image
inView boolean false true
loaded boolean false true
onLoad function false null
rounded boolean false true
style style false null