clock

Clock UI component for use in time-picker

Click here to see online demo.

Installation

$ npm install --save component-clock

Example

const Clock = require('component-clock');
const clock = new Clock();
clock.el.appendTo('body');
clock.select({
	hour: 11,
	minute: 30
});

Events

• change (time, complete) - when the selected time is modified time is an object with hour and minute properties, complete is true only if both hours and minutes have been clicked by the user

API

Clock({ captions })

• captions - optional dictionary { hours, minutes, am, pm } - entries will be used by clock to render captions for Hours, Minutes, AM and PM - Object or HTMLElement.dataset can be used as a dictionary

Clock#select(time)

Select the given time ({ hour, minute }).

Clock#min(minTime)

Define the minimum time selectable with this clock (inclusive). Time values smaller than minTime are rendered with invalid class. All change events are generated only for values larger or equal to minTime.

Clock#max(maxTime)

Define the maximum time selectable with this clock (inclusive). Time values larger than maxTime are rendered with invalid class. All change events are generated only for values smaller or equal to maxTime.

Clock#type(type)

Set type to 12 to display 12 hour am/pm type of clock. Any other value resets the clock display to standard 24 hour display.

License

MIT