DateTime

The DateTime type provides a date picker. If not configured otherwise, the value is stored as a timestamp.

Settings

Name	Type	Default
default	string	''
format	string	''
dbType	string	''
range	array
disableAgeDisplay	boolean	false
required	boolean	false
searchable	boolean	true

default

Type: string
Default: ''

Default value in Y-m-d format. Set if a new record is created. For example 2023-01-01.

format

Type: string
Default: ''

Defines how the date should be formatted in the backend. Possible values are datetime, date or time and timesec.

dbType

Type: string
Default: ''

This option changes the date field to a native MySql DATETIME, DATE or TIME field. Possible values are datetime, date or time respectively.

range

Type: array

An array which defines an integer range within which the value must be. Keys:

lower (string in format Y-m-d H:i:s): Defines the min date.
upper (string in format Y-m-d H:i:s): Defines the max date.

It is allowed to specify only one of both of them.

Example:

range:
  lower: '2020-01-01'
  upper: '2020-12-31'

disableAgeDisplay

Type: boolean
Default: false

Disable the display of the age in the backend view.

required

Type: boolean
Default: false

If set, the field becomes mandatory.

searchable

Type: boolean
Default: true

If set to false, the field will not be considered in backend search.

Examples

Minimal

name: example/datetime
fields:
  - identifier: datetime
    type: DateTime
    format: date

name: example/datetime
fields:
  - identifier: datetime
    type: DateTime
    format: datetime
    dbType: datetime

Advanced / use case

name: example/datetime
fields:
  - identifier: datetime
    type: DateTime
    format: datetime
    default: '2023-02-11 12:00:00'
    disableAgeDisplay: true
    size: 20
    range:
      lower: '2019-01-31 12:00:00'
      upper: '2040-01-31 12:00:00'
    required: true