widgets.pbDatePicker.help.html Maven / Gradle / Ivy
Show all versions of ui-designer-artifact-builder-generator-angularjs Show documentation
Use this widget to select a date (e.g., a date of birth).
To select a date and a time (e.g., to schedule a meeting), use the Date time picker widget instead.
This widget can be used to display/update business variable attributes defined in the Business Data Model (BDM) with the following types:
- DATE ONLY (based on
java.time.LocalDate
)
- DATE (NOT RECOMMENDED) (based on
java.util.Date
)
Value Format
This widget supports the following types for its Value property as input:
- ISO 8601 String variables (with or without time information)
- Date objects
- Long number values (Milliseconds since epoch)
However, the output of the widget is always a Javascript Date object. So it will change the type of the variable bound to the widget Value to a Date object when the user selects a date. This is required in order to ensure backward compatibility for pages designed with older UI Designer versions.
When sent in the JSON body of a request, it is serialized into an ISO 8601 formatted String variable with the time set to midnight UTC (e.g., 2016-12-31T00:00:00.000Z).
Technical Format
The Technical date format property define the format of the values displayed in the date input.
It should be a valid AngularJS date format.
To display (and not update) a date retrieved from the BDM API (or another API), you can either use this Date picker widget with Read-only property set to "yes" or use a Text, Title or a Table widget and format the value using the provided uiDate filter.
The content of Label, Technical date format, Placeholder properties, as well as the label of button Today are localized by default. Localized format can be edited in the asset localization.json.
The values of all properties are also used as translation keys. As a result, if you choose not to keep the default values, update the asset localization.json accordingly.
Make sure the technical format value and its translations is a valid date format.
For more information, refer to the localization help section.