typedef DateOptions

package shared.component.field

import shared.component.field.Date

Date fields give you a date picker, and optionally a time picker as well.

{
  "key": "date",
  "label": "Date",
  "type": "Date",
  "options": {
    "default_value": "today"
  }
}

Properties

@:optionaldefault_value:Null<String>

Select today's date as default.

"default_value": "today"
  • Select today's date and time as default.
  • Requires the option "time" set to "true".
"default_value": "now"

@:optionalhelp:Null<Dynamic>

Adding help or instructional text to a field.

"help": "This field can only contain letters."

@:optionalhidden:Null<Bool>

Hide this field in the interface.

"hidden": true

@:optionalmax:Null<String>

Maximum date

@:optionalmin:Null<String>

Minimum date

@:optionalminimal:Null<Bool>

Hide the label of the textfield.

"minimal": true

@:optionaloverview:Null<Bool>

@:optionaloverview_editable:Null<Bool>

@:optionaloverview_filter:Null<Bool>

@:optionaloverview_searchable:Null<Bool>

@:optionalreadonly:Null<Bool>

Field is read only.

"readonly": true

@:optionalrequired:Null<Bool>

This field can't be empty.

"required": true

@:optionalsaveAsDisplayFormat:Null<Bool>

Saves dates as display format, deprecated

@:optionalshow_when:Null<EitherType<ShowOptions, Array<ShowOptions>>>

The "value" can be set to "null" of "!null" to check if something is empty.

@:optionaltime:Null<Bool>

Show the date and also the time.

"time": "true"

@:optionalvalue:Null<Any>

@:optionalwidth:Null<Float>

Width percentpoint 0-1.

"width": 0.5"