Time

Type key: time_picker. Renders a time picker in 24-hour (HH:mm) or 12-hour (hh:mm A) format. In the editor this is the Time block.

A question: the question rules apply, and it can sit in a layout row column.

Meta fields

The meta fields of this node type are listed in the request body of Replace the draft document, under pages › nodes, in the time_picker tab.

Example

A minimal Time node

{
  "public_id": "nChk",
  "sort_order": 1,
  "type": "time_picker",
  "meta": {
    "question": "<span>Preferred check-in time</span>",
    "time_format": "HH:mm",
    "validation": {
      "required": false
    }
  }
}

Defaults and rules

• The defaults are time_format: "hh:mm A", time_minute_step: "30", and an open time_range, with min and max both null.
• time_minute_step is a string: "1", "5", "10", "15", "30", or "60". time_range.min and time_range.max are HH:mm strings; null leaves a bound open.
• default_value is { "type": "static", "value": "09:30" } or { "type": "relative" }. A static value must be a time the picker offers, inside time_range and on the minute step, or it is ignored. A relative default picks the offered time closest to when the respondent opens the form.