Skip to content

1.0.0

Compare
Choose a tag to compare
@HichemTab-tech HichemTab-tech released this 11 Jun 01:58
· 10 commits to master since this release

TickWatch v1.0.0 Release Notes

We are excited to announce the first release of TickWatch – a versatile jQuery plugin for creating dynamic electronic clocks. This initial release includes the following features:

Features

  • Count Up/Down: Choose the direction of your clock.
  • Customizable Format: Display hours, minutes, seconds, and even days.
  • Control Methods: Start, stop, set time, clear, and destroy the clock instance.
  • Event Triggers: Listen for start, stop, update, end, clear, and destroy events.
  • Easy Integration: Simply attach to a div and start your clock.
  • Lightweight Design: Minimal overhead, easy to use, and integrates seamlessly with jQuery projects.

Options

  • partsKeys: Defines each part of the clock and its maximum value. Example: ['seconds', 'minutes', {hours: 24}, {days: 31}, {month: 12}].
  • direction: The direction of the clock ('up' for count up, 'down' for count down).
  • startTime: The initial time of the clock.
  • endTime: The end time of the clock. Used in countdown mode.
  • activeCellClass: The class to add to the active segment of the electronic cell (e.g., red or high opacity).
  • inactiveCellClass: The class to add to the inactive segment of the electronic cell (e.g., low opacity).

Methods

  • start(): Start the clock.
  • stop(): Stop the clock.
  • set(time): Set the clock to a specific time.
  • clear(): Clear the current time and reset to the start time.
  • option(key, value): Get or set an option dynamically.
  • destroy(): Destroy the clock instance.

Events

  • TickWatch.start: Triggered when the clock starts.
  • TickWatch.stop: Triggered when the clock stops.
  • TickWatch.update: Triggered when the clock updates.
  • TickWatch.end: Triggered when the clock reaches the end time.
  • TickWatch.clear: Triggered when the clock is cleared.
  • TickWatch.destroy: Triggered when the clock instance is destroyed.