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 Types Description

Label

label

Text

Text to display as the field label.

Instructions

instructions

Text

Supplemental text about this field.

Required

required

Boolean

Determines if a value is required to submit the form. Default: false.

Read-only

readOnly

Boolean

Determines if the field should display as not editable. Default: false.

Disabled

disabled

Boolean

Determines if the field should display as potentially editable but grayed out. Default: false.

Display Value

value

Date

Date to display in the field.

Validations

validations

List of Text String

Validation errors to display below the field when the value is not null.

Save Input To

saveInto

List of Save

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.

Validation Group

validationGroup

Text

When present, this field is only validated when a button in the same validation group is pressed. See the documentation for more information about how to use validation groups.

Required Message

requiredMessage

Text

Custom message to display when the field's value is required and not provided.

Alignment

align

Text

Determines alignment of the date value. Appian recommends this setting only be used inside the Grid Layout component. Valid values: "LEFT", "CENTER", "RIGHT".

Label Position

labelPosition

Text

Determines where the label appears. Valid values:

  • "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.

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".

Accessibility Text

accessibilityText

Text

Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.

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.
  • If you want to display a date with formatting other than the default, use the Text Field component.
  • When focused in the calendar, "T" will select today's date and "Delete" will clear the value in the field.

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
=a!localVariables(
  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:

The following patterns include usage of the Date Component.

FEEDBACK