react-native-scalable-analog-clock
Version:
Scalable analog clock face.
42 lines (27 loc) • 3.26 kB
Markdown
# react-native-scalable-analog-clock
A react-native scalable analog clock.
```sh
npm i react-native-scalable-analog-clock -save
```
## Usage
### Basic
Import this module:
```javascript
import Clock from "react-native-scalable-analog-clock";
```
Use as a component:
```javascript
<Clock/>
```
```javascript
<Clock scale={1} handColor={'white'} secondsHandColor = {'red'} numberColor = {'white'} markingColor = {'white'} />
```
## API
### Props
| Prop | Type | Optional | Default | Description |
| ------------------------------ | ---------------------------------- | -------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `scale` | number | Yes | 1 | Sets the size of the whole clock |
| `handColor` | string | Yes | Color of hour and minute hands| Init text of the button. |
| `secondsHandColor` | string | Yes | 'white'| Seconds hand color |
| `numberColor` | string | Yes | 'white'. | Color of the numbers |
| `markingColor` | string | Yes | 'white' | markings color |