# react-native-circle-svg-timer

> Circular Timer component for React Native

Latest version **0.0.3** (published 2020-03-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-native-circle-svg-timer
pnpm add react-native-circle-svg-timer
yarn add react-native-circle-svg-timer
bun add react-native-circle-svg-timer
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2020-03-19 |
| First published | 2020-03-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 11.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | thousandsofraccoons |
| Keywords | react-native, react-component, react-native-component, react-native-circular, react-native-timer, react-native-circular-timer, react native, react native circular, react native timer, react native circular timer, react, mobile, ios, android, ui, timer, circular |

## Links

- npm: https://www.npmjs.com/package/react-native-circle-svg-timer
- npm.io page: https://npm.io/package/react-native-circle-svg-timer

## Dependencies (1)

- [react-native-svg](https://npm.io/package/react-native-svg.md) ^12.0.3

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.0.3 (latest) — 2020-03-19
- 0.0.2 — 2020-03-18
- 0.0.1 — 2020-03-18

## README

# react-native-circle-svg-timer

Circular Timer component for React Native based on react-native-svg

## Example

![image](react-native-circle-svg-timer.gif)

## Getting Started

### Installation

```bash
npm i react-native-circle-svg-timer --save
```

### Props

| parameter     | type   | required | description                          | default         |
| :------------ | :----- | :------- | :----------------------------------- | :-------------- |
| duration      | number | no       | Time in seconds                      | `15`            |
| radius        | number | no       | Radius of the circle                 | `30`            |
| strokeWidth   | number | no       | The border width of the circle       | `10`            |
| strokeColor   | string | no       | The color of the filler border       | `"lightblue"`   |
| fillColor     | string | no       | The background color of circle       | `"transparent"` |
| strokeBgColor | string | no       | The color of the border's background | `"grey"`        |

### Basic Usage

```javascript
import CircularTimer from 'react-native-circular-timer';

export const Example = props => {
  return <CircularTimer />;
};
```

<!--

### Methods

| method  | description                |
| :------ | :------------------------- |
| restart | To restart the timer again |

### Note:

Firstly, you need to create reference of the component and then call the restart method using that reference [GUIDE](https://stackoverflow.com/questions/37949981/call-child-method-from-parent).

### To run example

```bash
cd example
npm install
npx react-native run-android (For android)
npx react-native run-ios (For ios)
```

#### In case of any issue follow the [GUIDE](https://facebook.github.io/react-native/docs/getting-started).

### Supported React Native Versions

This project aims to support any version of React Native.

If you require new features or bug fixes for older versions you can fork this project.

### Credits

The idea for this modules came from MrToph react-native-countdown-circle package.

### Licenses

CircularTimer - MIT © MeharBhutta -->

---
_Source: https://npm.io/package/react-native-circle-svg-timer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._