0.0.1 • Published 3 years ago

react-native-screen-steps v0.0.1

Weekly downloads
-
License
ISC
Repository
github
Last release
3 years ago

React-Native-Screen-Steps

Custom steps indicator component for React-Native. This component is very simple to and ready to use, no other configuration is required. just pass totalPages, currentPage, heading and pageTitle as props and you are good to go.

Screen Shots

Install

 npm i react-native-screen-steps

Import

 import Steps from 'react-native-screen-steps';

Usage

Simple Example

    <Steps
        heading={'Create Your Profile'}
        pageTitle={'Personal Information'}
        currentPage={1}
        totalPages={6}
    />

You can also pass extra optional params to styling

    <Steps
        heading={'Create Your Profile'}
        pageTitle={'Personal Information'}
        currentPage={1}
        totalPages={6}
        titleStyle={{
            fontFamily:Fonts.bold
        }}
        pageTitleStyle={{
            fontFamily:Fonts.bold,
        }}
        pageNoTextStyle={{
            fontFamily:Fonts.bold
        }}
    />

Props for Customization

* Required

PropTypeDefaultDescription
heading *String'Heading'Main title like 'Create Your Profile'
pageTitle *String‘Page Title'Screen title like 'Personal Information'
currentPage *NumberCurrent page number (Current Steps)
totalPages *NumberTotal pages or screens (Total Steps)
titleStyleObjectcustom styling for Main title
pageTitleStyleObjectcustom styling for Screen title
activeStepColorString'#14BFFF'background color of active steps
inActiveStepColorString'white'background color of in-active steps
activeStepTextColorString'#FFFFFF'text color of active steps
inActiveStepTextColorString'#506D85'text color of in-active steps
backgroundColorString'#F5F8FA'background color of component\