Skip to main content

beforeClose

fires before closing the timepicker

beforeClose: (value: string | object) => boolean | void;

Parameters:

  • value: string | object - the current value of a timepicker

Returns:

Return false to prevent closing the timepicker; otherwise, true.

Example

timepicker.events.on("beforeClose", function(value){
console.log(value);
return false;
})

Related sample: Timepicker. Events

The type of the value parameter depends on the applied valueFormat and timeFormat:

  • If valueFormat: "string" and timeFormat:24 are specified, the string value will include just the hour and minutes: "00:39"
  • If valueFormat: "string" and timeFormat:12 are specified, the string value will include hour, minutes, and am/pm identifiers: "06:00AM"
  • If valueFormat: "timeObject" and timeFormat:24 are specified, the object value will contain key:value pairs for hours, minutes and their values: {hour: 0, minute: 39}
  • If valueFormat: "timeObject" and timeFormat:12 are specified, the object value will contain key:value pairs for hours, minutes, am/pm identifiers and their values: {hour: 6, minute: 0, AM: true}

Change log:

  • The value parameter was added in v7.0
  • The event was added in v6.4