Skip to main content

Calendar component

Configuring the Calendar component in the App Builder.

The Calendar component is used to display activities in a calendar view.

📌 Note: The Calendar component can only use the Activities table as its source of events.


Calendar component properties

Selecting the calendar component shows its configurable properties.


Event Card

Clicking Event card details will open up a new panel to configure. This includes the following sub sections:

  • Event card fields

  • Card events

  • Button menu items

Event card fields

The fields are the fields that show on the event card. They will default to the appropriate fields from the Activity table. Unless something specific is required, they do not need to be changed.

Event card fields

Default field from Activity table

Start date & time

DueDateStart field

End date & time

DueDateEnd field

Event title

ActivityType field

Event description

Comments field

Appointment colors

ActivityStatusColor field

All day appointment

IsAllDayAppointment field

Card events

Button variant

The button appearance on the event card. Select between Primary and Secondary.

Button color

Select from the given list of colors.

You can also have the button on the event card be a button menu. The Button menu items section manages that.

Button Menu items

+ Plus symbol

Add a new menu item, which will show in the list.

Sort order

Change sort order by dragging this handle.

Delete

Delete the menu item.

Display

The Display section allows for different layout options. These are standard and cannot be altered, but can be set to visible or invisble.

Display

Title

Header text for the calendar.

Show title

Toggle the visibility of the Title.

Layout options

See below.

Mobile event time display

How the event time looks on a phone

  • None

  • Left of event title

  • Right of event title

  • Left of description

Default state

The default state of the control (Regular/Hidden/Disabled).

Layout options

The following layout options are available to the user. They can be set to visible or invisible by toggling its eye icon (). Selecting the star will set the default layout.

  • Day View and Week View options:

    • Standard: all calendar entries will show without a separation for different users (resources).

    • Vertical: calendar entries will be separated into columns for each user (resource).

    • Horizontal: calendar entries will be separated into rows for each user (resource).

  • Month view options:

    • Standard calendar view

  • List view options:

    • Weekly: show only entries for the selected week

    • Monthly: show entries for the entire month

Interactions

On the right of the calendar is an icon to toggle a panel which will show interaction tabs. The visibility of these tabs can be configured via this section.

Interactions

Resources tab

This tab will manage the number of users (resources) will be visible on the calendar.

Wait list tab

Activities and work orders can be put on a wait list, where they are not scheduled in the calendar. These will show here, and can be dragged onto the calendar when the time is known.

Settings tab

Can change what is visible on the calendar:

  • Days of the week

  • Show all day events on top

  • Show inactive users (resources)

  • Color event background

  • Start time for calendar

  • End time for calendar

Filter

Filter which activities will show on the calendar. Please see "Filter Configurations".


Events

The Calendar has three events associated with it (not including the events within the Event Card buttons).

📌 Note: You will notice the word "event" being used within the calendar but that refers to activities in the calendar. It is not the same as Actions and Events when customizing.

Events

Add calendar event:

Triggered when a user selects the ⊕ button on the calendar.

Drag / Move

Triggered when a user edits an activity in the calendar by dragging it on the calendar to a different time.

Selection

Triggered when a user clicks and drags an empty range within the calendar.

Did this answer your question?