Skip to content

React Native component for onboarding processes with animated background.

License

Notifications You must be signed in to change notification settings

elie-chaaban/react-native-animated-onboarding

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

Name Type Default Value Definition
scenes array of object { component: (required), backgroundColor: (optional) } - component: the view that will be displayed, backgroundColor: color of the view's background that will be animated
enableBackgroundColorTransition boolean undefined Set to true to animate background color when transitining view/component
activeColor string (hex, rgba, etc.) rgba(32, 119, 336, 1) color of active indicator, Continue button background color
inactiveColor string (hex, rgba, etc.) rgba(0, 0, 0, 0.2) color of inactive indicator

Property injected in each scence props

Name Type Default Value Definition
animatedValue interpolate value of Animated.Value inputRange: [0, windowWidth] an animated value, use for animation within a page by using this.props.animatedValue.interpolate

About

React Native component for onboarding processes with animated background.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published