2.0.1 • Published 4 years ago

react-native-animated-onboarding v2.0.1

Weekly downloads
4
License
MIT
Repository
github
Last release
4 years ago

React Native Onboarding Animate

React native component for onboarding processes with animation

Install

Install react-native-animated-onboarding package and save into package.json:

$ npm install react-native-animated-onboarding --save

How to use?

import React, { Component } from 'react';

import OnboardingAnimate from 'react-native-animated-onboarding';
import {
  FirstScene,
  SecondScene,
  ThirdScene
} from './ExampleScenes';

export default class App extends Component {
  
  render() {

    // Define scenes, it will be displayed in order
    let scenes = [
      {
        component: FirstScene,
        backgroundColor: 'yellow'
      }, {
        component: SecondScene,
        backgroundColor: 'orange'
      }, {
        component: ThirdScene,
        backgroundColor: 'red'
      }
    ];

    return <OnboardingAnimate
        scenes={scenes}
        enableBackgroundColorTransition={true}
    />;
  }
}

Properties

NameTypeDefault ValueDefinition
scenesarray of object { component: (required), backgroundColor: (optional) }-component: the view that will be displayed, backgroundColor: color of the view's background that will be animated
enableBackgroundColorTransitionbooleanundefinedSet to true to animate background color when transitining view/component
activeColorstring (hex, rgba, etc.)rgba(32, 119, 336, 1)color of active indicator, Continue button background color
inactiveColorstring (hex, rgba, etc.)rgba(0, 0, 0, 0.2)color of inactive indicator

Property injected in each scence props

NameTypeDefault ValueDefinition
animatedValueinterpolate value of Animated.ValueinputRange: 0, windowWidthan animated value, use for animation within a page by using this.props.animatedValue.interpolate