Skip to content

kanelloc/react-native-animated-header-scroll-view

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ae83639 Â· Jan 7, 2023

History

99 Commits
Jan 7, 2023
Jan 7, 2023
Dec 28, 2022
Dec 29, 2022
Dec 28, 2022
Dec 28, 2022
Dec 28, 2022
Dec 28, 2022
Dec 28, 2022
Dec 28, 2022
Jan 7, 2023
Dec 28, 2022
Dec 28, 2022
Dec 28, 2022
Dec 29, 2022
Dec 28, 2022
Dec 28, 2022
Jan 7, 2023
Dec 28, 2022
Dec 28, 2022
Dec 28, 2022
Dec 28, 2022

Repository files navigation

React Native Animated Header ScrollView

NPM version npm npm runs with expo

A performant animated ScrollView component that:

  • 🔥Animates an image or a custom component into a navbar header
  • 🔥Supports bounce animation on scroll down
  • 🔥Supports both iOS and Android devices

React Native Animated Header ScrollView

Installation

$ npm install @kanelloc/react-native-animated-header-scroll-view

Usage

import { Card, TopNavBar, HeaderNavBar } from '../components';
import { AnimatedScrollView } from '@kanelloc/react-native-animated-header-scroll-view';
import * as React from 'react';

export const App = () => {
  const data = Array.from(Array(20).keys());
  return (
    <AnimatedScrollView
      HeaderNavbarComponent={<HeaderNavBar />}
      TopNavBarComponent={<TopNavBar />}
      headerImage={require('../../assets/cabin.jpg')}
    >
      {data.map((e) => {
        return <Card item={e} key={e} />;
      })}
    </AnimatedScrollView>
  );
};

You can find a set of detailed examples here

Also a running snack here

Props

Prop name Description Type Required
TopNavBarComponent Rendered on top of the screen as a navbar when scrolling to the top JSX.Element true
HeaderComponent A component to use on top of header image. It can also be used without header image to render a custom component as header. JSX.Element false
HeaderNavbarComponent Rendered on top of the header. Transitions to TopNavbarComponent as you scroll JSX.Element false
headerMaxHeight Height of the header (headerImage or HeaderComponent). Default value is 300 number false
topBarHeight Height of the top navbar. Default value is 90 number false
headerImage Image header source ImageSourcePropType false
disableScale Disables header scaling when scrolling. Default value is false boolean false

Contributing

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

License

MIT