DateFieldDefinition renders a calendar that allows the user to select a date and optionally a time.
This date field definition is part of the Magnolia 6 UI framework. The fully qualified class name is info.magnolia.ui.field.DateFieldDefinition.
If you work with the Magnolia 5 UI framework, see Date field for Magnolia 5 UI instead.
Example date field definition
date: label: Date $type: dateField type: java.util.Date time: true
Date field properties
Field-specific properties
| optional, default is Format in which the date is displayed to users. See the Examples: dateFormat: yyyy-MM-dd # 2017-10-31 dateFormat: yyyy-MMMM-dd # 2017-October-31 dateFormat: EEE, MMM d, yyyy # Tue, Oct 31, 2017 |
| optional, default is Set a specific date and time such as The default value applies only to new content items, not to those that have already been created. Enclose the property value in quotes when using YAML: defaultValue: "2017-10-31" defaultValue: "2017-10-31 15:09" If you define the dateFormat: MM/dd/yyyy timeFormat: h:mm a defaultValue: "10/31/2017 3:09 PM" |
| optional, default is Enables time selection. Renders dropdown lists at the bottom of the calendar. |
| optional, default is Format in which the time is displayed to users. See the Examples: timeFormat: HH:mm # 15:09 timeFormat: h:mm a # 3:09 PM |
Common simple field properties
| required Name of the field definition item. Derived from the configured node name. Use alphanumeric characters without spaces. |
| required (unless Type of the field definition item. The value must be a fully qualified class name and a subtype of |
| You can use this as a shortcut for See Field types for possible values. |
type | required, default is Model type of the field. Use the fully qualified class name. See PropertyType for possible values. A default type is typically hard-coded in each definition class. You only need to add this property if you want to override the default implementation (for example, with |
| optional Converts values between presentation (UI) and model (stored data). The property must extend com.vaadin.data.Converter. |
| optional, default is translated Message shown when there is an error in the conversion process. The value can be literal or a key of a message bundle. Use alphanumeric characters in literal values. |
| optional Pre-filled default value displayed in the field. The value can be overwritten by the user. Use alphanumeric characters.
|
| optional Help text displayed when the user clicks the help icon. The value can be literal or a key of a message bundle. |
| optional Defines the factory class that initializes and builds the Vaadin form field. The default factory class depends on the particular field. The value must be a fully qualified class name and a subtype of |
| optional Defines the binder class that applies configuration parameters from the field. |
| optional, default is Enables i18n authoring support, which allows editors to write foreign-language or regionally targeted content. A two-letter language identifier ( |
| optional Field label displayed to editors. The value can be literal or a key of a message bundle. If you do not provide the property, Magnolia will fall back to a generated i18n key. If you do not want to have any label, set the property to an empty string such as |
| optional, default is Makes the field uneditable. |
| optional, default is Makes the field required. An asterisk is displayed next to the field label. |
| optional, default is translated Error message shown when |
| optional Additional style information for an editor property definition item applied to the element when the form is rendered. The value can be a CSS class or a list of CSS classes separated by white spaces. |
validators | optional List of field validator definition items. Any value must be a subtype of See Field validators for more information. |
Applied only when creating a new item, not for already existing items.Overview
Content Tools