https://github.com/talalmajali/react-native-countdown-component

React Native CountDown
https://github.com/talalmajali/react-native-countdown-component

countdown countdown-timer counter react-native timer

Last synced: 7 days ago
JSON representation

React Native CountDown

• Host: GitHub
• URL: https://github.com/talalmajali/react-native-countdown-component
• Owner: talalmajali
• License: mit
• Created: 2017-12-02T16:59:11.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-01-18T00:22:40.000Z (10 months ago)
• Last Synced: 2024-10-27T18:56:47.842Z (17 days ago)
• Topics: countdown, countdown-timer, counter, react-native, timer
• Language: JavaScript
• Size: 97.7 KB
• Stars: 275
• Watchers: 4
• Forks: 237
• Open Issues: 64
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# react-native-countdown

React Native CountDown

## Installation

Run `npm install react-native-countdown-component --save` OR `yarn add react-native-countdown-component --save`

## Props

| Name | Description | Type | Default Value |

| :--- | :----- | :--- | :---: |

| id | Counter id, to determine whether to reset the counter or not | string | null |

| style | Override the component style | object | {} |

| digitStyle |  Digit style | object | {backgroundColor: ![#FAB913](https://placehold.it/15/FAB913/000000?text=+) `'#FAB913'`} |

| digitTxtStyle | Digit Text style | object | {color: ![#FAB913](https://placehold.it/15/000000/000000?text=+) `'#000'`} |

| timeLabelStyle | Time Label style | object | {color: ![#FAB913](https://placehold.it/15/000000/000000?text=+) `'#000'`} |

| separatorStyle | Separator style | object | {color: ![#FAB913](https://placehold.it/15/000000/000000?text=+) `'#000'`} |

| size | Size of the countdown component | number | 15 |

| until | Number of seconds to countdown | number | 0 |

| onFinish | What function should be invoked when the time is 0 | func | null |

| onChange | What function should be invoked when the timer is changing | func | null |

| onPress | What function should be invoked when clicking on the timer | func | null |

| timeToShow | What Digits to show | array | ['D', 'H', 'M', 'S'] |

| timeLabels | Text to show in time label | object | {d: 'Days', h: 'Hours', m: 'Minutes', s: 'Seconds'} |

| showSeparator | Should show separator | bool | false |

| running | a boolean to pause and resume the component | bool | true |

## Preview

![React Native Countdown](https://media.giphy.com/media/xT0xeLWYNSaLerFGko/giphy.gif "React Native Countdown")

## Code

```javascript

import CountDown from 'react-native-countdown-component';

render() {

    return (

       alert('finished')}

        onPress={() => alert('hello')}

        size={20}

      />

    )

}

```

## Custom Styling Example

![React Native Countdown](https://media.giphy.com/media/wIwc1dinsZhx6v2PxB/giphy.gif "React Native Countdown")

## Code

```javascript

import CountDown from 'react-native-countdown-component';

render() {

    return (

       alert('Finished')}

        digitStyle={{backgroundColor: '#FFF'}}

        digitTxtStyle={{color: '#1CC625'}}

        timeToShow={['M', 'S']}

        timeLabels={{m: 'MM', s: 'SS'}}

      />

    )

}

```

## Separator Example

![React Native Countdown](https://media.giphy.com/media/4H7qQF4UPwQKEc0Qpx/giphy.gif "React Native Countdown")

## Code

```javascript

import CountDown from 'react-native-countdown-component';

render() {

    return (

       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

      />

    )

}

```