1.0.1 • Published 3 years ago

native-countdown v1.0.1

Weekly downloads
63
License
MIT
Repository
github
Last release
3 years ago

native-countdown

React Native CountDown

Fork of talalmajali/react-native-countdown-component

Installation

Run npm install native-countdown --save OR yarn add native-countdown --save

Props

NameDescriptionTypeDefault Value
idCounter id, to determine whether to reset the counter or notstringnull
styleOverride the component styleobject{}
digitStyleDigit styleobject{backgroundColor: #FAB913 '#FAB913'}
digitTxtStyleDigit Text styleobject{color: #FAB913 '#000'}
timeLabelStyleTime Label styleobject{color: #FAB913 '#000'}
separatorStyleSeparator styleobject{color: #FAB913 '#000'}
sizeSize of the countdown componentnumber15
untilNumber of seconds to countdownnumber0
onFinishWhat function should be invoked when the time is 0funcnull
onChangeWhat function should be invoked when the timer is changingfuncnull
onPressWhat function should be invoked when clicking on the timerfuncnull
timeToShowWhat Digits to showarray'D', 'H', 'M', 'S'
timeLabelsText to show in time labelobject{d: 'Days', h: 'Hours', m: 'Minutes', s: 'Seconds'}
showSeparatorShould show separatorboolfalse
runninga boolean to pause and resume the componentbooltrue

Preview

React Native Countdown

Code

import CountDown from 'native-countdown';

render() {
    return (
      <CountDown
        until={10}
        onFinish={() => alert('finished')}
        onPress={() => alert('hello')}
        size={20}
      />
    )
}

Custom Styling Example

React Native Countdown

Code

import CountDown from 'native-countdown';

render() {
    return (
      <CountDown
        until={60 * 10 + 30}
        size={30}
        onFinish={() => alert('Finished')}
        digitStyle={{backgroundColor: '#FFF'}}
        digitTxtStyle={{color: '#1CC625'}}
        timeToShow={['M', 'S']}
        timeLabels={{m: 'MM', s: 'SS'}}
      />
    )
}

Separator Example

React Native Countdown

Code

import CountDown from 'native-countdown';

render() {
    return (
      <CountDown
        size={30}
        until={1000}
        onFinish={() => alert('Finished')}
        digitStyle={{backgroundColor: '#FFF', borderWidth: 2, borderColor: '#1CC625'}}
        digitTxtStyle={{color: '#1CC625'}}
        timeLabelStyle={{color: 'red', fontWeight: 'bold'}}
        separatorStyle={{color: '#1CC625'}}
        timeToShow={['H', 'M', 'S']}
        timeLabels={{m: null, s: null}}
        showSeparator
      />
    )
}