The Calendar web component
A content area to display calendar events.
Calendar uses the FullCalendar library.
Settings
Calendar includes the following configurable options when building apps in the IDE.
Properties
All properties for Calendar with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
allDayByIndex
A list of boolean values for each item, by index, that reflect whether they are all-day events.
changeSet
Edited values for each row.
colorByIndex
A list of colors for each item, by index.
dayMaxEvents
The maximum number of events to display, per day, when viewType is month. If not set, events stack to the height of the cell.
displayAllDaySlot
Whether to display the all-day event slot.
displayEventTime
Whether to display event times.
displayTimeZone
The time zone (UTC offset) that applies to the display value. Uses the time zone reported by the browser if set to local.
displayWeekends
Whether to display weekends.
endByIndex
A list of end times, by index.
eventIdByIndex
A list of event IDs, by index.
eventMaxStack
The maximum number of events to display in a stack.
Properties
event
The event type.
Values
change | A user changes the value. |
click | A user clicks or taps the component. |
submit | A user submits the value. |
focus | A user selects the input field. |
blur | A user deselects the input field. |
scan | A user scans a barcode. |
open | A user opens the component. |
close | A user closes the component. |
true | A user sets the value to |
false | A user sets the value to |
select | A user selects a value. |
clear | A user clears the value. |
upload | A user uploads a file. |
parse | An uploaded file is parsed. |
inputValueChange | A user changes the value of the input field. |
method
The JavaScript method to perform when type is datasource, widget, state, or localStorage.
Values
datasource | Control query. |
widget | Control component. |
script | Run script. |
state | Set variable. |
localStorage | Set localStorage. |
util | Perform utility action (e.g., Open URL or Confetti). |
firstDayOfWeek
The first day of the week, by index, with Sunday as 0.
Values
0 | Sunday. |
1 | Monday. |
2 | Tuesday. |
3 | Wednesday. |
4 | Thursday. |
5 | Friday. |
6 | Saturday. |
global
Whether the object is globally scoped for use in all app pages.
groupIdByIndex
hoveredEvent
The event on which the cursor hovers.
id
The unique identifier.
initialDate
The initial date to display.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
The configuration mode for option lists. Either dynamic for mapped options or static for manual options.
Values
dynamic | Options dynamically mapped from an array. |
manual | Options manually configured in the IDE. |
listType
The date range to display in list view.
Values
day | Day |
week | Week |
month | Month |
year | Year |
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden is true.
pluginType
The plugin type.
selectedEvent
The selected event.
selectedInterval
The selected interval.
showInEditor
Whether to remain visible in the editor if hidden is true.
startByIndex
A list of start times, by index.
timeFormat
The format of the time.
titleByIndex
A list of item titles, by index.
view
The view.
Values
day | Day |
week | Week |
month | Month |
year | Year |
list | List |
Methods
JavaScript API methods for interacting with Calendar. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
scrollIntoView
Scrolls the canvas or parent container so that the selected component appears in the visible area.
calendar.scrollIntoView(scrollIntoViewOptions)
Parameters
scrollIntoViewOptions
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
The scroll position relative to the component.
Values
nearest | Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view. |
start | Scrolls to position the component at the top of the visible area. |
center | Scrolls to position the component in the middle of the visible area. |
end | Scrolls to position the component at the bottom of the visible area. |
setHidden
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
calendar.setHidden(hidden)
Parameters
Events
Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.
changeEvent
An event is changed.
clickEvent
An item is clicked or pressed.
createEvent
An event is created.
removeEvent
An event is removed.