1.0.3 • Published 2 years ago

clock-web-widget v1.0.3

Weekly downloads
4
License
MIT
Repository
github
Last release
2 years ago

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
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
clock.pause();
closk.resume();

Overriding configs

Example
clock.update({
  speed: 300,
  draggable: true,
  size: 'large'
});