Skip to main content

Date Picker

Ant Design

The Date Picker component lets users pick a date from a calendar, such as a due date or a delivery date. It can also pick a week, month, quarter or year, or a date and time.

Properties​

Property
Description
Expected Value
LabelText shown above the field, or beside it when Layout is horizontal.Text. Default: Date
ExtraHelp text shown under the field. A validation message replaces it while the value is invalid.Text
TooltipText shown when the user hovers over an info icon after the label.Text
Layoutvertical puts the label above the field; horizontal puts it at the left.vertical, horizontal. Default: vertical
ValueDate selected when the app loads, as YYYY-MM-DD, or YYYY-MM-DDTHH:mm:ss when Show time is on. Reset field returns to this value.Text
Show timeAdds hour and minute columns, so the user picks a date and a time.On or off. Default: Off
FormatHow the date is written in the field, such as DD MMM YYYY. It doesn't change the value's format. Leave it empty for YYYY-MM-DD.Text
PickerWhat the user picks. For week, month, quarter and year, the value is the first day of the period picked.date, week, month, quarter, year. Default: date
Min dateEarliest date the user can pick, as YYYY-MM-DD. An earlier value shows a validation error.Text
Max dateLatest date the user can pick, as YYYY-MM-DD. A later value shows a validation error.Text
PlaceholderHint shown in the field while it is empty.Text. Default: Pick a date
Allow clearShows a button in the field that clears the date.On or off. Default: On
VariantStyle of the field box. outlined has a border, filled has a gray fill, borderless has neither, and underlined has only a bottom line.outlined, filled, borderless, underlined. Default: outlined
SizeHeight and text size of the field.small, middle, large. Default: middle

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off
Dynamic heightLets the component grow with its content in the running app instead of keeping a fixed height.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On changeTriggers when the selected date changes, by the user or an action.
On open changeTriggers when the calendar opens or closes.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Set field valueChanges the date to the one given as YYYY-MM-DD and fires On change. Text that isn't a date is ignored; empty text clears the field.components.datepicker1.setFieldValue("")
Reset fieldReturns the date to the Value property's value.components.datepicker1.resetFields()
Set visibilityShows the component when true, hides it when false.components.datepicker1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.datepicker1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.datepicker1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
labelText shown above the field, or beside it when Layout is horizontal.{{components.datepicker1.label}}
extraHelp text shown under the field. A validation message replaces it while the value is invalid.{{components.datepicker1.extra}}
tooltipText shown when the user hovers over an info icon after the label.{{components.datepicker1.tooltip}}
layoutvertical puts the label above the field; horizontal puts it at the left.{{components.datepicker1.layout}}
valueDate selected when the app loads, as YYYY-MM-DD, or YYYY-MM-DDTHH:mm:ss when Show time is on. Reset field returns to this value.{{components.datepicker1.value}}
showTimeAdds hour and minute columns, so the user picks a date and a time.{{components.datepicker1.showTime}}
formatHow the date is written in the field, such as DD MMM YYYY. It doesn't change the value's format. Leave it empty for YYYY-MM-DD.{{components.datepicker1.format}}
pickerWhat the user picks. For week, month, quarter and year, the value is the first day of the period picked.{{components.datepicker1.picker}}
minDateEarliest date the user can pick, as YYYY-MM-DD. An earlier value shows a validation error.{{components.datepicker1.minDate}}
maxDateLatest date the user can pick, as YYYY-MM-DD. A later value shows a validation error.{{components.datepicker1.maxDate}}
placeholderHint shown in the field while it is empty.{{components.datepicker1.placeholder}}
allowClearShows a button in the field that clears the date.{{components.datepicker1.allowClear}}
variantStyle of the field box. outlined has a border, filled has a gray fill, borderless has neither, and underlined has only a bottom line.{{components.datepicker1.variant}}
sizeHeight and text size of the field.{{components.datepicker1.size}}
isVisibleWhether the component is visible.{{components.datepicker1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.datepicker1.isLoading}}
isDisabledWhether the component is disabled.{{components.datepicker1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.