Skip to main content

Calendar

Ant Design

The Calendar component shows a month of dates with events marked on their days, such as deadlines or releases. Users pick a date by clicking it.

Properties​

Property
Description
Expected Value
ValueThe selected date, as YYYY-MM-DD. It updates when the user picks a date. When empty, the calendar opens on today.Text
FullscreenShows a large month grid with event names in the cells. Turn it off for a small card calendar that marks events with dots.On or off. Default: On
EventsEvents to mark on the calendar, as a list of {date, title, type}. type sets the color: success, warning, error or processing.Array

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

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 selectTriggers when the user picks a date, a month or a year.
On panel changeTriggers when the user moves to another month or year, or switches between the month and year views.

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 visibilityShows the component when true, hides it when false.components.calendar1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.calendar1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.calendar1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
valueThe selected date, as YYYY-MM-DD. It updates when the user picks a date. When empty, the calendar opens on today.{{components.calendar1.value}}
fullscreenShows a large month grid with event names in the cells. Turn it off for a small card calendar that marks events with dots.{{components.calendar1.fullscreen}}
eventsEvents to mark on the calendar, as a list of {date, title, type}. type sets the color: success, warning, error or processing.{{components.calendar1.events}}
panelDateA date in the month or year the calendar shows after the user changed it, as YYYY-MM-DD.{{components.calendar1.panelDate}}
isVisibleWhether the component is visible.{{components.calendar1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.calendar1.isLoading}}
isDisabledWhether the component is disabled.{{components.calendar1.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.