GM - Single Calendar
Documentation
The Single Calendar component enables users to easily manage and view schedules in one place. It features drag-and-drop support, conditional coloring, and filtering by criteria, making calendar management more efficient and visually engaging.
Use case : Setting up a calendar to visualize project tasks efficiently.
Specification
recordId
String
recordId to use. Keep this empty if you want to use the current record.
Calendar Label
String
Set the label of the calendar.
Custom Icon
String
Customize the calendar icon. All lightning icons are supported.
Default Calendar View
String
Set the default view (daily|weekly|monthly|schedule)
Calendar Height
Integer
Set the calendar height. Use 9999 for dynamic height.
Activity Object
String
Activity Object API Name. Don’t forget __c for custom objects.
Activity Title Field
String
Activity Title Field API Name. Don’t forget __c for custom fields.
Activity Sub Title Field
String
Activity Sub Title Field API Name. Don’t forget __c for custom fields.
Activity Date Field
String
Activity Date Field API Name. Don’t forget __c for custom fields.
Activity From Date Field
String
Activity From Date Field API Name. Don’t forget __c for custom fields.
Activity To Date Field
String
Activity To Date Field API Name. Don’t forget __c for custom fields.
Activity Popover Fields
String
Activity Popover Fields to display. Keep it empty to use the compact layout.
Activity Popover Columns #
Integer
Activity Popover Columns #
Activity Filter
String
Activity Filter. The filter should be a JSON string.
Activity Default Values
String
JSON string to initialize a new activity created from the calendar. Don’t forget __c for custom fields.
Activity Coloring
String
Activity Coloring. The coloring should be a JSON string.
Activity Actions
String
JSON string to initialize the list of available actions for an activity.
Activity Icon
String
Activity Icon.
Activity Label
String
Activity Label.
Enable Create Activity
Boolean
Check this option if you want to create activities.
Enable Update Activity
Boolean
Check this option if you want to update activities.
Enable Delete Activity
Boolean
Check this option if you want to delete activities.
Enable Toggle Fullscreen
Boolean
Check this option if you want to enable toggle fullscreen.
Extra Activities
String
Extra Activities Config.
API Reference
<?xml version="1.0" encoding="UTF-8"?>
<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
<apiVersion>62.0</apiVersion>
<isExposed>true</isExposed>
<targets>
<target>lightning__RecordPage</target>
<target>lightning__AppPage</target>
<target>lightning__HomePage</target>
<target>lightningCommunity__Page</target>
<target>lightningCommunity__Default</target>
</targets>
<masterLabel>GM - Single Calendar</masterLabel>
<targetConfigs>
<targetConfig
targets="lightning__RecordPage,lightning__AppPage,lightning__HomePage,lightningCommunity__Default"
>
<property
name="recordId"
type="String"
label="recordId"
description="recordId to use. Keep this empty if you want to use the current record"
/>
<!-- UI props-->
<property
name="customLabel"
type="String"
label="Calendar Label"
description="Set the label of the calendar."
/>
<property
name="customIcon"
type="String"
label="Custom Icon"
description="Customize the calendar icon. All lightning icons are supported"
/>
<property
name="defaultTimelineView"
type="String"
label="Default Calendar View"
description="Set the default view (daily|weekly|monthly)"
/>
<property
name="height"
type="Integer"
label="Calendar Height"
description="Set the calendar height. Use 9999 for dynamic height"
/>
<!-- Activity props-->
<property
name="objectName"
type="String"
label="Activity Object"
description="Activity Object API Name. Don’t forget __c for custom objects"
/>
<property
name="titleFieldName"
type="String"
label="Activity Title Field"
description="Activity Title Field API Name. Don’t forget __c for custom fields"
/>
<property
name="subTitleFieldName"
type="String"
label="Activity Sub Title Field"
description="Activity Sub Title Field API Name. Don’t forget __c for custom fields"
/>
<property
name="dateFieldName"
type="String"
label="Activity Date Field"
description="Activity Date Field API Name. Don’t forget __c for custom fields"
/>
<property
name="fromDateFieldName"
type="String"
label="Activity From Date Field"
description="Activity From Date Field API Name. Don’t forget __c for custom fields"
/>
<property
name="toDateFieldName"
type="String"
label="Activity To Date Field"
description="Activity To Date Field API Name. Don’t forget __c for custom fields"
/>
<property
name="popoverFields"
type="String"
label="Activity Popover Fields"
description="Activity Popover Fields to display. Keep it empty to use the compact layout"
/>
<property
name="popoverColums"
type="Integer"
label="Activity Popover Columns #"
description="Activity Popover Columns #"
/>
<property
name="filter"
type="String"
label="Activity Filter"
description="Activity Filter. The filter should be a JSON string"
/>
<property
name="defaultValues"
type="String"
label="Activity Default Values"
description="Json string to initialize a new activity created from the calendar. Don’t forget __c for custom fields"
/>
<property
name="coloring"
type="String"
label="Activity Coloring"
description="Activity Coloring. The coloring should be a JSON string"
/>
<property
name="actions"
type="String"
label="Activity Actions"
description="Json string to initialize the list of available actions for an activity"
/>
<property name="recordIcon" type="String" label="Activity Icon" description="Activity Icon" />
<property name="recordLabel" type="String" label="Activity Label" description="Activity Label" />
<!-- Permissions props-->
<property
name="canCreate"
type="Boolean"
label="Enable Create Activity"
description="Check this option if you want to create activities"
/>
<property
name="canUpdate"
type="Boolean"
label="Enable Update Activity"
description="Check this option if you want to update activities"
/>
<property
name="canDelete"
type="Boolean"
label="Enable Delete Activity"
description="Check this option if you want to delete activities"
/>
<property
name="canToggleFullscreen"
type="Boolean"
label="Enable Toggle Fullscreen"
description="Check this option if you want to enable toggle fullscreen"
/>
<!-- Extra Activities -->
<property
name="extraActivities"
type="String"
label="Extra Activities"
description="Extra Activities Config"
/>
</targetConfig>
</targetConfigs>
</LightningComponentBundle>
Last updated
Was this helpful?