The Calendar component for Retool Apps

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.

DataDay max eventsShow all-day slotShow event timesDisplayShow weekendsEvent max stackEvent handlersFirst dayHiddenDefault dateShow on desktopShow on mobileOptionsMaintain space when hiddenMarginAlways show in edit modeStylesFormat

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

boolean[]

A list of boolean values for each item, by index, that reflect whether they are all-day events.

changeSet

object[]

Edited values for each row.

colorByIndex

string[]

A list of colors for each item, by index.

data

any[]

The source data.

dayMaxEvents

number

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

boolean

Whether to display the all-day event slot.

displayEventTime

boolean

Whether to display event times.

displayTimeZone

enum

The time zone (UTC offset) that applies to the display value. Uses the time zone reported by the browser if set to local.

displayWeekends

boolean

Whether to display weekends.

endByIndex

string[]

A list of end times, by index.

eventIdByIndex

string[]

A list of event IDs, by index.

eventMaxStack

number

The maximum number of events to display in a stack.

events

object[]

A list of configured event handlers that trigger actions or queries.

Properties

event

enum

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 true.
false	A user sets the value to false.
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

enum

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

type

enum

The type of action to perform.

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

enum

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.

groupIdByIndex

hidden

boolean

Whether the component is visible.

hoveredEvent

object

The event on which the cursor hovers.

id

string

The unique identifier.

initialDate

string

The initial date to display.

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

itemMode

enum

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

enum

The date range to display in list view.

Values

day	Day
week	Week
month	Month
year	Year

maintainSpaceWhenHidden

boolean

Whether the component takes up space on the canvas if hidden is true.

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

pluginType

string

The plugin type.

selectedEvent

object

The selected event.

selectedInterval

object

The selected interval.

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

startByIndex

string[]

A list of start times, by index.

style

object

Custom style options in use. Not all style options may be available for all components.

timeFormat

String

The format of the time.

titleByIndex

string[]

A list of item titles, by index.

view

enum

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

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

block

enum

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

hidden

boolean

Whether the component is visible.

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.