Apostrophe 3 Documentation

# time

time fields are text field with UI support, and limitation, for saving time values. Times are stored in 24 hour HH:MM:SS format.

# Module field definition

// Configuring the `eventTime` field in a module's `fields.add` subsection:
eventTime: {
  label: 'What time is the event?',
  type: 'time'
}

# Settings

# Required

Property Type Default Description
label String n/a Sets the visible label for the field in the UI
type String n/a Specifies the field type (string for this type)

# Optional

Property Type Default Description
def String n/a The default value for the field. Must be in HH:MM:SS format.
help String n/a Help text for the content editor
htmlHelp String n/a Help text with support for HTML markup
if Object {} Conditions to meet before the field is active. See the guide for details.
required Boolean false If true, the field is mandatory
readOnly Boolean false If true, prevents the user from editing the field value

NOTE

If you do not set def: null or required: true, the time defaults to the current time.

# Use in templates

Times are stored, and will print, in the HH:MM:SS format.

{{ data.piece.eventTime }}

← url →