https://github.com/wrathchaos/react-native-countdown

Moment based extremely easy to use Countdown for React Native
https://github.com/wrathchaos/react-native-countdown

android apple freakycoder front-end google ios javascript kuray library mobile mobile-app mobile-app-development react react-native reactjs

Last synced: 5 days ago
JSON representation

Moment based extremely easy to use Countdown for React Native

• Host: GitHub
• URL: https://github.com/wrathchaos/react-native-countdown
• Owner: WrathChaos
• License: mit
• Created: 2019-12-26T19:45:43.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-10-21T02:31:31.000Z (about 1 year ago)
• Last Synced: 2024-11-02T14:51:37.665Z (12 days ago)
• Topics: android, apple, freakycoder, front-end, google, ios, javascript, kuray, library, mobile, mobile-app, mobile-app-development, react, react-native, reactjs
• Language: Java
• Homepage: https://freakycoder.com
• Size: 5.38 MB
• Stars: 7
• Watchers: 3
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![Battle Tested ✅](https://img.shields.io/badge/-Battle--Tested%20%E2%9C%85-03666e?style=for-the-badge)](https://github.com/WrathChaos/react-native-countdown)

[![Moment based extremely easy to use Countdown for React Native](https://img.shields.io/badge/-Moment%20based%20extremely%20easy%20to%20use%20Countdown%20for%20React%20Native-lightgrey?style=for-the-badge)](https://github.com/WrathChaos/react-native-countdown)

[![npm version](https://img.shields.io/npm/v/@freakycoder/react-native-countdown.svg?style=for-the-badge)](https://www.npmjs.com/package/freakycoder/react-native-countdown)

[![npm](https://img.shields.io/npm/dt/@freakycoder/react-native-countdown.svg?style=for-the-badge)](https://www.npmjs.com/package/freakycoder/react-native-countdown)

![Platform - Android and iOS](https://img.shields.io/badge/platform-Android%20%7C%20iOS-blue.svg?style=for-the-badge)

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)



  



# Installation

Add the dependency:

```js

npm i @freakycoder/react-native-countdown

```

## Peer Dependencies

###### IMPORTANT! You need install them

```js

"moment": ">= 2.24.0",

"moment-duration-format": ">= 2.3.2"

```

# Usage

## Import

```js

import moment from "moment";

import Countdown from "react-native-countdown";

```

## Usage

All Text Component feature can be send via props OR you can use textStyle

```jsx

```

# Configuration - Props

Check the example for the customizable `format` and `defaultCountdown` props.

| Property         |  Type   |  Default  | Description                                             |

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

| start            | boolean |   true    | make the button outline                                 |

| end              | boolean |   false   | make the button with a solid background and a shadow    |

| textStyle        | boolean |   false   | make the button with a gradient background and a shadow |

| defaultCountdown | string  | - : - : - | default countdown format before the countdown starts    |

| format           | string  | hh:mm:ss  | set your own format for the countdown                   |

## Roadmap

- [x] ~~LICENSE~~

- [ ] Typescript

- [ ] Article for Medium

- [ ] BuyMeACoffee Link/Widget

## Author

FreakyCoder, [email protected]

## License

React Native Countdown is available under the MIT license. See the LICENSE file for more info.