1.0.2 • Published 6 years ago

rn-parallax-scroll-view v1.0.2

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

Example

//LIBRARIES
import React from "react";
import { View, Platform } from "react-native";
import RNParallaxScrollView from "rn-parallax-scroll-view";

const HEADER_MAX_HEIGHT = 300;
const HEADER_MIN_HEIGHT = Platform.OS === 'ios' ? 60 : 73;
const HEADER_SCROLL_DISTANCE = 240;

const thumbnail = require("./images/food.jpg");

class App extends React.Component{

  renderFixedHeader(){
    return(
      <View><Text>Title</Text></View>
    )
  }

  renderScrollViewContent() {
    const data = Array.from({ length: 30 });
    return (
      <View style={styles.scrollViewContent}>
        {data.map((_, i) => (
          <View key={i} style={styles.row}>
            <Text>{i}</Text>
          </View>
        ))}
      </View>
    );
  }
  render(){

    return (
      <View style={{flex:1}}>
        <RNParallaxScrollView
          thumbnail={thumbnail}
          renderFixedHeader={()=>this.renderFixedHeader()}
          renderScrollViewContent={()=>this.renderScrollViewContent()}
          transformHeader
        />
      </View>
    );
  }
}
export default App;

react-native-parallax-scroll-view

A scroll view component that includes:

  • parallax header
  • sticky header
  • customization
  • Works on iOS and Android

Installation

$ npm install rn-parallax-scroll-view --save

Demo

npm.io

Usage (API)

All of the properties of ScrollView are supported. Please refer to the ScrollView documentation for more detail.

The ParallaxScrollView component adds a few additional properties, as described below.

PropertyTypeRequiredDescription
headerMaxHeightnumberNoThe max height of the header defaults to 300
headerMinHeightnumberNoThe max height of the header defaults to 60 for ios and 73 for android
headerScrollDistancenumberNoDefaults to 240
renderFixedHeaderfuncYesRenders the fixed header
renderScrollViewContentfuncYesRenders the scroll view content
headerBarStylesobjectNoHeader component styles
transformHeaderboolNoIs header scalable
headerWrapperStylesobjectNoHeader wrapper for wrapping the header
backgroundImageStylesobjectNoStyle background Image

Contributing

I welcome contributions! Please open an issues if you have any feature ideas or find any bugs. I also accept pull requests with open arms. I will go over the issues when I have time. :)