# @viviedu/react-clock

> An analog clock for your React app.

Latest version **3.0.0-vivi9** (published 2024-12-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install @viviedu/react-clock
pnpm add @viviedu/react-clock
yarn add @viviedu/react-clock
bun add @viviedu/react-clock
```

## Health

**Score 40/100 (D)** — status: stable.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 3.0.0-vivi9 |
| Published | 2024-12-02 |
| First published | 2021-12-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 85.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Wojciech Maj |
| Maintainers | deanylev, tristanpenman, ethanhusband |
| Keywords | clock, digital clock, analog clock, time, react |

## Links

- npm: https://www.npmjs.com/package/@viviedu/react-clock
- Repository: https://github.com/viviedu/react-clock
- Homepage: https://github.com/viviedu/react-clock#readme
- Issues: https://github.com/viviedu/react-clock/issues
- npm.io page: https://npm.io/package/@viviedu/react-clock

## Dependencies (3)

- [prop-types](https://npm.io/package/prop-types.md) ^15.6.0
- [merge-class-names](https://npm.io/package/merge-class-names.md) ^1.1.1
- [@wojtekmaj/date-utils](https://npm.io/package/@wojtekmaj/date-utils.md) ^1.0.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 3.0.0-vivi9 (latest) — 2024-12-02
- 3.0.0-vivi8 — 2024-10-16
- 3.0.0-vivi7 — 2024-06-20
- 3.0.0-vivi6 — 2024-06-20
- 3.0.0-vivi5 — 2021-12-15
- 3.0.0-vivi4 — 2021-12-15
- 3.0.0-vivi3 — 2021-12-15
- 3.0.0-vivi2 — 2021-12-15
- 3.0.0-vivi1 — 2021-12-15

## README

[![npm](https://img.shields.io/npm/v/react-clock.svg)](https://www.npmjs.com/package/react-clock) ![downloads](https://img.shields.io/npm/dt/react-clock.svg) [![CI](https://github.com/wojtekmaj/react-clock/workflows/CI/badge.svg)](https://github.com/wojtekmaj/react-clock/actions) ![dependencies](https://img.shields.io/david/wojtekmaj/react-clock.svg
) ![dev dependencies](https://img.shields.io/david/dev/wojtekmaj/react-clock.svg
) [![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://github.com/facebook/jest)

# React-Clock

An analog clock for your React app.

## tl;dr
* Install by executing `npm install @viviedu/react-clock` or `yarn add @viviedu/react-clock`.
* Import by adding `import Clock from '@viviedu/react-clock'`.
* Use by adding `<Clock />`.

## Demo

A minimal demo page can be found in `sample` directory.

## Installation

Add React-Clock to your project by executing `npm install @viviedu/react-clock` or `yarn add @viviedu/react-clock`.

### Usage

Here's an example of basic usage:

```js
import React, { useEffect, useState } from 'react';
import Clock from '@viviedu/react-clock';

function MyApp() {
  const [value, setValue] = useState(new Date());

  useEffect(() => {
    const interval = setInterval(
      () => setValue(new Date()),
      1000
    );

    return () => {
      clearInterval(interval);
    }
  }, []);

  return (
    <div>
      <p>Current time:</p>
      <Clock value={value} />
    </div>
  )
}
```

### Custom styling

If you want to use default React-Clock styling to build upon it, you can import React-Clock's styles by using:

```js
import '@viviedu/react-clock/dist/Clock.css';
```

## User guide

### Clock

Displays a complete clock.

#### Props

|Prop name|Description|Default value|Example values|
|----|----|----|----|
|className|Class name(s) that will be added along with `"react-clock"` to the main React-Clock `<time>` element.|n/a|<ul><li>String: `"class1 class2"`</li><li>Array of strings: `["class1", "class2 class3"]`</li></ul>|
|hourHandLength|Hour hand length, in %.|`50`|`80`|
|hourHandOppositeLength|The length of the part of an hour hand on the opposite side the hand is pointing to, in %.|`10`|`20`|
|hourHandWidth|Hour hand width, in pixels.|`4`|`3`|
|hourMarksLength|Hour marks length, in %.|`10`|`8`|
|hourMarksWidth|Hour marks width, in pixels.|`3`|`2`|
|minuteHandLength|Minute hand length, in %.|`70`|`80`|
|minuteHandOppositeLength|The length of the part of a minute hand on the opposite side the hand is pointing to, in %.|`10`|`20`|
|minuteHandWidth|Minute hand width, in pixels.|`2`|`3`|
|minuteMarksLength|Minute marks length, in %.|`6`|`8`|
|minuteMarksWidth|Minute marks width, in pixels.|`1`|`2`|
|numbersMultiplier|What to multiply each number by (e.g. for a stopwatch).|`1`|`5`|
|preciseSecondHandAngle|Whether to take milliseconds into account when calculating the angle of the seconds hand.|`false`|`true`|
|renderHourMarks|Whether hour marks shall be rendered.|`true`|`false`|
|renderHourHand|Whether hour hand shall be rendered.|`true`|`false`|
|renderMinuteHand|Whether minute hand shall be rendered.|`true`|`false`|
|renderMinuteMarks|Whether minute marks shall be rendered.|`true`|`false`|
|renderNumbers|Whether numbers shall be rendered.|`false`|`true`|
|renderSecondHand|Whether second hand shall be rendered.|`true`|`false`|
|secondHandLength|Second hand length, in %.|`90`|`80`|
|secondHandOppositeLength|The length of the part of a second hand on the opposite side the hand is pointing to, in %.|`10`|`20`|
|secondHandWidth|Second hand width, in pixels.|`1`|`2`|
|size|Clock size, in pixels.|`150`|`250`|
|value|Clock value. Must be provided.|n/a|Date: `new Date()`|

## License

The MIT License.

---
_Source: https://npm.io/package/@viviedu/react-clock · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._