Date Component

Date

Function: a!dateField()

Displays and allows entry of a single date (year, month, day). When the field is editable, users can input dates by typing or by picking from a calendar.

When working with date and time (year, month, day, hour, minute, second), use a date & time component. To display a time (hour, minute, second), use a time component. To display a read-only date using a custom format, use a text component.

Parameters

Name Keyword Type Description
Label label Text Optional text to display as the field label.
Label Position labelPosition Text Optional text to determine where the label appears. Valid values include
  • "ABOVE" (default) Displays the label above the component.
  • "ADJACENT" Displays the label to the left of the component.
  • "COLLAPSED" Hides the label. The label will still be read by screen readers; see accessibility considerations for more information.
  • "JUSTIFIED" Aligns the label alongside the component starting at the edge of the page.
Instructions instructions Text Optional text displayed below the field's value.
Help Tooltip helpTooltip Text Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is "COLLAPSED".
Display Value value Date The value to display in the date field.
Save Input To saveInto Save Array One or more variables that are updated with the date when the user changes it. Use a!save() to save a modified or alternative value to a variable.
Required required Boolean Determines if a value is required to submit the form. Default is false.
Required Message requiredMessage Text Custom message to be displayed when the field's value is required and not provided.
Read-only readOnly Boolean If set to 'true', prohibits users from editing the value. Default is false.
Disabled disabled Boolean Determines if the user is prevented from changing the value. Default is false.
Validations validations Text Array Validation errors to be displayed below the field when the value is not null.
Validation Group validationGroup Text When present, this field is only validated when a button in the same validation group is clicked.
Alignment align Text Alignment of the date (except on mobile devices). Valid values are "LEFT", "CENTER", and "RIGHT". Appian recommends setting the alignment when used in an editable grid only.
Visibility showWhen Boolean Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.

Notes

  • The date is shown in the current user's time zone and calendar format. For example, Jan 12, 2013.
  • If you want to display a date with formatting other than the default, use the Text Field component.

Examples

Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.

Date with Only a Label

1
2
3
4

=a!dateField(
  label: "Created On",
  value: date(2013, 1, 12)
)

Displays the following:

Date with a Validation

1
2
3
4
5
6
7
8
9
10
11
12
13

=load(
  local!storedValue:today()-1,
  a!dateField(
    label:"RSVP By",
    value: local!storedValue,
    saveInto: local!storedValue,
    validations: if(
      local!storedvalue <= today(),
      "Please set the RSVP by to a future date",
      ""
    )
  )
)

Displays the following:

Open in Github
18.2

On This Page

FEEDBACK