Releases: HichemTab-tech/TickWatch-js
1.1.2
TickWatch v1.1.2 Release Notes
Changes:
- typescript types added for last option.
Full Changelog: 1.1.1...1.1.2
1.1.1
TickWatch v1.1.1 Release Notes
New Features:
- Add the get method: We have added the ability to get the current value of the clock or the display using the method
get
How to Use:
$('.display').TickWatch('get');
We hope these additions enhance your development experience. Thank you for using our library!
Full Changelog: 1.1.0...1.1.1
1.1.0
TickWatch v1.1.0 Release Notes
New Features:
- Display Number Support: We have added the ability to display static numbers with a specified number of digits, providing greater flexibility for displaying numerical information.
Details:
- Introduced the
displayOnly
option which, when set to true, displays static numbers instead of a clock. - Added the
displaySize
option to specify the number of digits to display whendisplayOnly
is true. - Provided new examples to demonstrate the usage of these features.
Impact:
This update allows developers to utilize TickWatch for a wider range of use cases, including displaying static numerical data in a customizable format.
How to Use:
To display a static number, initialize TickWatch with the displayOnly
option set to true, and optionally specify the number of digits using the displaySize
option. For example:
$('.display').TickWatch({
displayOnly: true,
displaySize: 2,
});
You can dynamically set the displayed number using the set
method:
$('.display').TickWatch('set', '42');
We hope these additions enhance your development experience. Thank you for using our library!
Full Changelog: 1.0.2...1.1.0
1.0.2
Full Changelog: 1.0.1...1.0.2
1.0.1
TickWatch v1.0.1 Release Notes
New Features:
- TypeScript Support: We have added TypeScript type definitions to our library. These type definitions will help TypeScript developers use our library with improved type safety and better development experience.
Details:
- Introduced a
types/index.d.ts
file that provides type definitions for theTickWatch
function, its settings, data structures, and methods. - Ensured the
package.json
file points to the newtypes/index.d.ts
file using thetypes
field.
Impact:
- This update allows TypeScript developers to benefit from autocomplete, type checking, and improved documentation directly within their development environment.
How to Use:
- The type definitions are included automatically. There is no need for additional steps to use the types in your TypeScript projects.
We hope these additions enhance your development experience. Thank you for using our library!
Full Changelog: 1.0.0...1.0.1
1.0.0
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.