- Notifications
You must be signed in to change notification settings - Fork4
A react native button component that can show progress.
License
NotificationsYou must be signed in to change notification settings
xinghui0000/react-native-progress-button
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
A react native button component that can show progress.
$ npm install react-native-progress-button --save
import {ProgressButton} from 'react-native-progress-button';<ProgressButton {...props}/>
Props | Description | Default |
---|---|---|
style | button style - width : width of button- height :height of button.- borderWidth :width of outer border.- borderRadius : radius of outer border, this will influence inner progress view in android.- backgroundColor : background color of button, not visiable whenbuttonState is 'static'.- padding : padding area betweenn outer border and inner progresss view | -width :400- height :40- borderWidth :0- borderRadius :5- backgroundColor :'limegreen'- padding :0 |
buttonState | the state which control button whether in progress, one of three follow value: - 'staic' : static button, button not in progress.- 'indeterminate' : indeterminate progress button,activityIndicator is shown.- 'progress' : like progress bar. | 'static' |
smoothly | whether the progress is smooth,only used whenbuttonState is'progress' | true |
paused | Whether to pause the animation of progress, - false : pause a progress animation or deley new progress animation start.- true : restart a progress animation, The progress speed is the same as before the pause,so try not settimingConfig before restart the progress | false |
timingConfig | config of theAnimated.timing() in which smooth progress animation used.duration ,delay ,easing | {duration: 100} |
progressColor | background color of inner progress bar. | 'limegreen' |
unfilledColor | Color of the remaining progress. | 'lightgrey' |
progress | Progress value when the button in 'progress' state. A number between 0 andmaxProgress | 0 |
activityIndicator | a indetermimate indicator whenbuttonState is'indetermimate' ,shown left of text | ActitvityIndicator |
activityIndicatorPadding | padding area between indetermimate indicator and text | 5 |
text | Text shown in the center of the button | 'OK' |
textStyle | text style of the text. they will be included instyle attr of text | textStyle:{color: 'white'} |
onPress | A function to be called as soon as the user press the button.(event, buttonState, progress) => {} | |
onProgressAnimatedFinished | A function to be called as soon as the progress animation finished,(progress) => {} |
Because ofoverflow:hidden
is not supported on Android, inner progress view displayed diffrently between android and ios whenbuttonState
is progress. inner progress view will has border radius , but not in ios, according to outer border radius in android. And when the progress is small, inner progress view will look odd.So try not to set border radius too large in android.
MIT
About
A react native button component that can show progress.
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Releases
No releases published
Packages0
No packages published
Uh oh!
There was an error while loading.Please reload this page.