Flare

The flare enables you to display content with a pointer to directional content.

bpk-component-flare

Backpack React Native flare component.

Default

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

With Image

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

Pointer up

Day Night
bpk-component-flare pointer-up iPhone 8 simulator bpk-component-flare pointer-up iPhone 8 simulator - dark mode
bpk-component-flare pointer-up Google Pixel emulator bpk-component-flare pointer-up Google Pixel emulator - dark mode

Installation

Check the main Readme for a complete installation guide.

Usage


                                                
                                                import React, { Component } from 'react';
                                                import { StyleSheet, View } from 'react-native';
                                                import { spacingBase } from '@skyscanner/bpk-foundations-react-native/tokens/base.react.native';
                                                import BpkImage from 'backpack-react-native/bpk-component-image';
                                                import BpkText from 'backpack-react-native/bpk-component-text';
                                                import BpkFlare, { FLARE_POINTER_DIRECTIONS } from 'backpack-react-native/bpk-component-flare';
                                                
                                                const styles = StyleSheet.create({
                                                  container: {
                                                    flex: 1,
                                                    justifyContent: 'center',
                                                    padding: spacingBase,
                                                  },
                                                  flare: {
                                                    maxHeight: spacingBase * 10
                                                  }
                                                });
                                                
                                                export default () => (
                                                  <View style={styles.container}>
                                                
                                                    // With arbitrary content.
                                                    <BpkFlare style={styles.flare}>
                                                        <BpkText>Hotels in Valparaiso.</BpkText>
                                                    </BpkFlare>
                                                
                                                    // With an image.
                                                    <BpkFlare style={styles.flare}>
                                                      <BpkImage source={{uri: "imageUri" }} alt="Image title" />
                                                    </BpkFlare>
                                                
                                                    // With the pointer facing up.
                                                    <BpkFlare pointerDirection={FLARE_POINTER_DIRECTIONS.up} style={styles.flare}>
                                                        <BpkText>Hotels in Valparaiso.</BpkText>
                                                    </BpkFlare>
                                                  </View>
                                                );

Props

Property PropType Required Default Value
children node true -
pointerDirection oneOf('down', 'up') false down