| Excerpt | ||
|---|---|---|
| ||
Displays a |
...
vertical Lightning calendar. |
Component Description
This component displays a
...
vertical Lightning calendar.
...
This version is only available for record pages. If you include this in an Experience Cloud, make sure it is on a record page.
...
For the standalone version see: Vertical Calendar
See this article for more information on how to Add a Calendar to a Record Page.
General Properties
Whether the component is added to an Experience Cloud or not, the following properties are always available:
Property | Required | Description |
|---|---|---|
Calendar | Yes | The component will take its configuration from the selected calendar record. Only calendars of record type |
Max Height | Yes | The maximum height of the calendar in pixels or percentage. |
Max heigh’s unit | No | If the max height property should be interpreted in pixels or as a percentage. |
Lookup to Dimension | No | A lookup on the record that points towards the dimension you want to display. More info below. |
Child dimensions to display | No | A related list attached to the record that contains the records you want to display. More info below. |
Filter identifier | No | Calendars with the same identifier share their filters. When empty, defaults to the name of the selected calendar. |
Additional Experience Cloud Properties
When added to an Experience Cloud environment, the following additional properties are available:
Property | Required | Description |
|---|---|---|
Record ID | Yes | The id of the record the component is located on. Enter |
Object Name | Yes | The object name of the current record. Enter |
...
Controlling what the calendar displays
You can use the two inputs Lookup to Dimension
...
and Child Dimensions to Display to control what the calendar displays.
If both these inputs are empty, the calendar component will display for the current record. This means the current record will be the dimension, and will be used to get the opening times from and any related reservations. So for example if you place this component on a Staff record page, and you navigate to a specific Staff record, the component will show the available times for that Staff member, as well as any reservations for that Staff member.
If Lookup to Dimension is filled in on the component, the
...
component will display
...
the related record contained in that lookup
...
. So
...
for example if you place this component on a record page with a ‘Resource’ lookup, the calendar will display the resource that the current record is related to. If that happens to be a parent resource, such as a building with multiple meeting rooms, all those child meeting rooms will also be displayed.
Child Dimensions to Display is very similar to Lookup to Dimension, except instead of a related parent record, it lets you choose a list of child records to display. For example, if a custom object ‘Store’ has a lookup ‘Manager’, you can select the ‘Stores’ child list to display all the stores that a manager is related to.