react-native-progress-step-bar

!versión npm
!Download npm
[![MIT License][license-shield]][license-url]

Table of Contents

* About the Project
* Built With
* Getting Started
* Installation
* Api Reference
* Examples of Usage
* Roadmap
* Contributing
* License
* Contact

About The Project

Package to configure an Animated Progress Bar with multiple variations.
You can use animated dots in the middle of each step or not using any of them at all and you can put a range number on each step.
You can also create a bar or a dot with LinearGradient if you want something more customizable.

Examples

Getting Started

$3

Installation can be done through npm or yarn:

``shell
npm i react-native-progress-step-bar --save
`

`shell
yarn add react-native-progress-step-bar
`




Api Reference

#### Props

| Prop | Type | Required(Default Value) | Description |
| --------------------------- | ----------------------------| ---------------------------- | --------------------------------------------------- |
| steps | number | required | The number of steps that the progress bar will support. If you are using dots, the bar will have (steps + 1) dots. |
| width | number | required | The width of the progress bar. |
| height | number | required | The height of the progress bar |
| dotDiameter | number | optional | If you are using dots, you can set the diameter of each dot using this prop |
| ranges | string[] | optional | If you want to implement ranges and put a string below each dot (or without dots), you will have to use this prop. |
| currentStep | number | required | This is the currentStep of the progress bar. You will have to control it in order to avoid it to be less than 0 and also avoid it to be greather than the number of steps that you have set.
| backgroundBarStyle | StyleProp | optional | This is useful if you want to set another backgroundColor to the bar when it is not filled. You can also set a borderRadius here if you want the bar to have borderRadius on the corners.
| filledBarStyle | StyleProp | optional | This is useful if you want to set a different backgroundColor to the filled bar (the progress bar).
| filledBarContainerStyle | StyleProp | optional | If you want to add some borderRadius to the filledBar, you will have to add that borderRadius to the container, and not to the filledBarStyle. This is the proper place to add borderRadius to the filledBar.
| backgroundDotStyle | StyleProp | optional | This is useful if you want to modify the backgroundColor of the dot when it is not filled
| filledDotStyle | StyleProp | optional | This is useful if you want to set another backgroundColor of the dot when it is filled.
| stepToStepAnimationDuration | number | optional - Default to 1000ms | If you want to use another animation duration on the bar when it is moving between steps, you can modify this prop. It is in ms.
| withDots | boolean | optional - Default to true | With this props you can configure if the bar will have dots or not. Not setting this prop will cause the bar to support dots.
| rangeTextContainerWidth | number | optional - default is 40 | In case you want to put bigger numbers or bigger strings on the ranges, you will have to increase this value since the default is 40. You will rarely use this prop.
| rangeTextStyle | StyleProp | optional | With this prop, you will be able to add styles to the Text Range. This is necessary if you are implementing ranges in your progress bar
| CustomizedFilledBar | ReactNode | optional | This is useful if you are implementing a complex progress bar with LinearGradient for example. If you want your filled bar to be implemented with LinearGradient, you will probably want to use this prop.
| CustomizableDot | ReactNode | optional | This is useful if you are implementing a complex dot with LinearGradient for example. If you want your filled dot to be implemented with LinearGradient, you will probably want to use this prop.




Usage

$3


`js
import * as React from 'react';
import { StyleSheet, View, Text, TouchableOpacity } from 'react-native';
import AnimatedDotsCarousel from 'react-native-progress-step-bar';

export default function App() {
const [currentStep, setCurrentStep] = useState(0);
const handlePrevStep = useCallback(() => {
setCurrentStep((prevStep) => prevStep - 1);
}, []);

const handleNextStep = useCallback(() => {
setCurrentStep((prevStep) => prevStep + 1);
}, []);

return (
style={{
flex: 1,
justifyContent: 'center',
alignItems: 'center',
backgroundColor: 'black',
}}
>

steps={6}
ranges={['0', '150', '400', '600', '800', '1000', '1200']}
width={325}
height={3}
currentStep={currentStep}
stepToStepAnimationDuration={1000}
withDots={false}
/>

style={{
flexDirection: 'row',
width: 400,
alignItems: 'center',
justifyContent: 'center',
marginTop: 40,
}}
>
onPress={handlePrevStep}
style={{ backgroundColor: 'green', marginRight: 30 }}
>
PrevStep

onPress={handleNextStep}
style={{ backgroundColor: 'green' }}
>
NextStep



);
}
`

$3


`js
import * as React from 'react';
import { StyleSheet, View, Text, TouchableOpacity } from 'react-native';
import AnimatedDotsCarousel from 'react-native-progress-step-bar';

export default function App() {
const [currentStep, setCurrentStep] = useState(0);
const handlePrevStep = useCallback(() => {
setCurrentStep((prevStep) => prevStep - 1);
}, []);

const handleNextStep = useCallback(() => {
setCurrentStep((prevStep) => prevStep + 1);
}, []);

return (
style={{
flex: 1,
justifyContent: 'center',
alignItems: 'center',
backgroundColor: 'black',
}}
>

steps={6}
width={325}
height={3}
currentStep={currentStep}
stepToStepAnimationDuration={1000}
withDots={false}
/>

style={{
flexDirection: 'row',
width: 400,
alignItems: 'center',
justifyContent: 'center',
marginTop: 40,
}}
>
onPress={handlePrevStep}
style={{ backgroundColor: 'green', marginRight: 30 }}
>
PrevStep

onPress={handleNextStep}
style={{ backgroundColor: 'green' }}
>
NextStep



);
}
`

$3


`js
import * as React from 'react';
import { StyleSheet, View, Text, TouchableOpacity } from 'react-native';
import AnimatedDotsCarousel from 'react-native-progress-step-bar';

export default function App() {
const [currentStep, setCurrentStep] = useState(0);
const handlePrevStep = useCallback(() => {
setCurrentStep((prevStep) => prevStep - 1);
}, []);

const handleNextStep = useCallback(() => {
setCurrentStep((prevStep) => prevStep + 1);
}, []);

return (
style={{
flex: 1,
justifyContent: 'center',
alignItems: 'center',
backgroundColor: 'black',
}}
>

steps={6}
width={325}
height={10}
currentStep={currentStep}
stepToStepAnimationDuration={1000}
filledBarStyle={{ borderRadius: 10, backgroundColor: 'white' }}
backgroundBarStyle={{ borderRadius: 10, backgroundColor: '#777777' }}
filledBarContainerStyle={{ borderRadius: 10 }}
withDots={false}
/>

style={{
flexDirection: 'row',
width: 400,
alignItems: 'center',
justifyContent: 'center',
marginTop: 40,
}}
>
onPress={handlePrevStep}
style={{ backgroundColor: 'green', marginRight: 30 }}
>
PrevStep

onPress={handleNextStep}
style={{ backgroundColor: 'green' }}
>
NextStep



);
}
`

$3


`js
import * as React from 'react';
import { StyleSheet, View, Text, TouchableOpacity } from 'react-native';
import AnimatedDotsCarousel from 'react-native-progress-step-bar';

export default function App() {
const [currentStep, setCurrentStep] = useState(0);
const handlePrevStep = useCallback(() => {
setCurrentStep((prevStep) => prevStep - 1);
}, []);

const handleNextStep = useCallback(() => {
setCurrentStep((prevStep) => prevStep + 1);
}, []);

return (
style={{
flex: 1,
justifyContent: 'center',
alignItems: 'center',
backgroundColor: 'black',
}}
>

steps={6}
ranges={['0', '150', '400', '600', '800', '1000', '1200']}
dotDiameter={10}
width={325}
height={3}
currentStep={currentStep}
stepToStepAnimationDuration={1000}
withDots
/>

style={{
flexDirection: 'row',
width: 400,
alignItems: 'center',
justifyContent: 'center',
marginTop: 40,
}}
>
onPress={handlePrevStep}
style={{ backgroundColor: 'green', marginRight: 30 }}
>
PrevStep

onPress={handleNextStep}
style={{ backgroundColor: 'green' }}
>
NextStep



);
}
`

$3


`js
import * as React from 'react';
import { StyleSheet, View, Text, TouchableOpacity } from 'react-native';
import AnimatedDotsCarousel from 'react-native-progress-step-bar';

export default function App() {
const [currentStep, setCurrentStep] = useState(0);
const handlePrevStep = useCallback(() => {
setCurrentStep((prevStep) => prevStep - 1);
}, []);

const handleNextStep = useCallback(() => {
setCurrentStep((prevStep) => prevStep + 1);
}, []);

return (
style={{
flex: 1,
justifyContent: 'center',
alignItems: 'center',
backgroundColor: 'black',
}}
>

steps={6}
dotDiameter={10}
width={325}
height={3}
currentStep={currentStep}
stepToStepAnimationDuration={1000}
withDots
/>

style={{
flexDirection: 'row',
width: 400,
alignItems: 'center',
justifyContent: 'center',
marginTop: 40,
}}
>
onPress={handlePrevStep}
style={{ backgroundColor: 'green', marginRight: 30 }}
>
PrevStep

onPress={handleNextStep}
style={{ backgroundColor: 'green' }}
>
NextStep



);
}
`




$3

If you want to implement a bar with LinearGradient you will have to install the library react-native-linear-gradient in your project, and then implement something like this:

`js
import React, { useState, useCallback, useMemo } from 'react';
import { View, Text, TouchableOpacity } from 'react-native';
import ProgressBar from 'react-native-progress-step-bar';
import LinearGradient from 'react-native-linear-gradient';

export default function App() {
const [currentStep, setCurrentStep] = useState(0);
const handlePrevStep = useCallback(() => {
setCurrentStep((prevStep) => prevStep - 1);
}, []);

const handleNextStep = useCallback(() => {
setCurrentStep((prevStep) => prevStep + 1);
}, []);

const CustomizableFilledBar = useMemo(
() => (
start={{ x: 0, y: 0 }}
end={{ x: 1, y: 0 }}
colors={['#4c669f', '#3b5998', '#192f6a']}
style={{ width: 325, height: 10 }}
/>
),
[]
);
const CustomizableDot = useMemo(
() => (
start={{ x: 0, y: 0 }}
end={{ x: 1, y: 0 }}
colors={['#4c669f', '#3b5998', '#192f6a']}
style={{ width: 20, height: 20, borderRadius: 20 }}
/>
),
[]
);
return (
style={{
flex: 1,
justifyContent: 'center',
alignItems: 'center',
backgroundColor: 'black',
}}
>
steps={6}
dotDiameter={20}
width={325}
height={10}
currentStep={currentStep}
stepToStepAnimationDuration={1000}
filledBarContainerStyle={{ borderRadius: 10 }}
backgroundBarStyle={{ borderRadius: 10, backgroundColor: '#777777' }}
withDots={true}
CustomizedFilledBar={CustomizableFilledBar}
CustomizableDot={CustomizableDot}
/>
style={{
flexDirection: 'row',
width: 400,
alignItems: 'center',
justifyContent: 'center',
marginTop: 40,
}}
>
onPress={handlePrevStep}
style={{ backgroundColor: 'green', marginRight: 30 }}
>
PrevStep

onPress={handleNextStep}
style={{ backgroundColor: 'green' }}
>
NextStep



);
}
`

If you want to implement a progress bar without dots, just set the withDots prop to false and do not use the CustomizableDot prop.




Roadmap

See the open issues for a list of proposed features (and known issues).

If you want to suggest a new feature, please create an issue and we will check it.




Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request




License

Distributed under the MIT License. See LICENSE` for more information.

Contact

Project Link: https://github.com/felire/react-native-progress-step-bar

[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=flat-square
[license-url]: https://github.com/felire/react-native-progress-step-bar/blob/master/LICENSE