TimePicker

A control that allows a user to select time value either by moving handles along track bars or by entering hour and minutes values directly into related inputs.

TimePicker

Related sample:  All dhxForm inputs - DHTMLX Form

Adding TimePicker

You can easily add a TimePicker control during initialization of a form:

var form = new dhx.Form("form_container", {
    rows: [
        {
            type: "timepicker",
            label: "time",
            labelInline: true,
            labelWidth: "50px"
        }
    ]
});

Attributes

You can provide the following attributes in the configuration object of a TimePicker:

  • type - (string) the type of a control, set it to "timepicker"
  • id - (string) the id of a control, auto-generated if not set
  • value - (string) the initial value of TimePicker
  • validation - (object|function) the rule of input validation. Can be set in two ways:
    • as an object with validation rules listed below:
      • "" - empty
      • "email" - validEmail
      • "integer" - validInteger
      • "numeric" - validNumeric
      • "alphanumeric" - validAplhaNumeric
      • "IPv4" - validIPv4
    • as a function that defines a custom validation rule. It takes as a parameter the value typed in the input and returns true, if the entered value is valid.
  • icon - (string) the name of an icon from the used icon font
  • placeholder - (string) a tip for the input
  • editing - (boolean) allows a user to enter the value of the control manually

  • parent - (string) the id of the parent control
  • width - (string) the width of a control
  • height - (string) the height of a control
  • css - (string) adds style classes to a control
  • disabled - (boolean) defines whether a control is enabled (false) or disabled (true)
  • label - (string) specifies a label for a control
  • labelWidth - (string) sets the width of the label of a control
  • hiddenLabel - (boolean) invisible label that will be used to identify the input on the server side
  • labelInline - (boolean) defines the position of a label: true - to set a label inline with a control
  • name - (string) the name of a control
  • required - (boolean) defines whether a control is required
  • help - (string) adds a help message to a control
  • preMessage - (string) a message that contains instructions for interacting with the control
  • successMessage - (string) a message that appears in case of successful validation of the control value
  • errorMessage - (string) a message that appears in case of error during validation of the control value
  • gravity - (boolean) arranges form controls evenly throughout the container, depending on the direction of layout ("cols" or "rows"), true by default

  • timeFormat - (number) defines what clock format is activated: the 12-hour or 24-hour one. Set the property to 12 or 24 (default) value, correspondingly
  • actions - (boolean) defines whether a timepicker is equipped with the Close and Save buttons
Back to top