# clock-web-widget

> Simple clock widget with zero dependency

Latest version **1.0.3** (published 2019-06-09) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install clock-web-widget
pnpm add clock-web-widget
yarn add clock-web-widget
bun add clock-web-widget
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2019-06-09 |
| First published | 2019-06-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 14.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Vladyslav Ohirenko |
| Maintainers | agurets |
| Keywords | clock, widget, draggable |

## Links

- npm: https://www.npmjs.com/package/clock-web-widget
- Repository: https://github.com/vladagurets/clock-widget
- Homepage: https://github.com/vladagurets/clock-widget#readme
- Issues: https://github.com/vladagurets/clock-widget/issues
- npm.io page: https://npm.io/package/clock-web-widget

## 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

- 1.0.3 (latest) — 2019-06-09
- 1.0.4-beta.0 (beta) — 2022-01-28
- 1.0.2 — 2019-06-07
- 1.0.1 — 2019-06-06
- 1.0.0 — 2019-06-06

## README

## Simple Clock Widget
This lib allows you to add simple clock widget to your app.

ZERO dependency.

### Example
**https://vladagurets.github.io/clock-widget-example/**

### Features
- Simple clock
- Draggable clock
- Countdown mode
- Speed configuration

### Configs
To add clock to yor app run ClockWidget with prefered options:
- **countdown**: false, // countdown mode - **{boolean}**
- **draggable**: false, // make clock draggable - **{boolean}**
- **hMirrored**: false, // horizontal mirrored clock - **{boolean}**
- **vMirrored**: false, // vertical mirorred clock - **{boolean}**
- **date**: new Date("December 17, 1995 03:24:00"), // start from Date - **{DATE}**, by default new Date()
- **lowBattery**: false, // just for fun - **{boolean}**
- **size**: 277,  // size of clock, one of **['small', 'medium', large']** or **custom number**
- **speed**: 1 // speed of each tick **{Number}**

### Manual
#### Initialization
###### Example
```javascript
import ClockWidget = 'clock-web-widget';
import 'clock-web-widget/index.css';

const clock = ClockWidget({
  countdown: false,
  draggable: false,
  hMirrored: false,
  vMirrored: false,
  date: new Date("December 17, 1995 03:24:00"),
  lowBattery: false,
  size: 277,
  speed: 1
});
```
#### Pause/Resume
###### Example
```javascript
clock.pause();
closk.resume();
```

#### Overriding configs
###### Example
```javascript
clock.update({
  speed: 300,
  draggable: true,
  size: 'large'
});
```

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