> For the complete documentation index, see [llms.txt](https://docs.gridmate.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gridmate.io/package-reference/components-library/calendars-and-timelines/gm-compact-calendar.md).

# GM - Compact Calendar

(gmpkg:compactCalendarLWC)

## **Documentation**

**GM - Compact Calendar** component is used to display the **Event** and **Task** or any object as activity on the Calendar.

**Use case:** Display the **Event** and **Task** object as activities on the Calendar using the compact calendar. See [**GM - Compact Calendar.**](https://docs.gridmate.io/product-tour/calendars-and-timelines/compact-calendar.md)

## **Specification**

<table data-full-width="true"><thead><tr><th width="170">Property</th><th width="132.33333333333331">Type</th><th width="545.7048746744792">Description</th></tr></thead><tbody><tr><td>Title</td><td>String</td><td>The title of the <strong>Compact Calendar</strong>.</td></tr><tr><td>Custom Icon</td><td>String</td><td>Customize the calendar icon. All lightning icons are supported. You can get the icon name from <a href="https://lightningdesignsystem.com/icons/">https://lightningdesignsystem.com/icons<strong>/</strong></a></td></tr><tr><td>Json Config</td><td>String</td><td>The JSON configuration describes the calendar setup, including the object API name, date fields, and popover fields. <code>backgroundColor</code> accepts a fixed colour or a JSON string of coloring rules; a rule's <code>color</code> may be <code>$record.FieldApiName</code>.</td></tr><tr><td>Show Border</td><td>Boolean</td><td>Check this option to display a border around the calendar. The default value is false.</td></tr></tbody></table>

## **API Reference**

{% tabs fullWidth="true" %}
{% tab title="compactCalendarLWC.js-meta.xml" %}

```xml
<?xml version="1.0" encoding="UTF-8"?>
<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
    <apiVersion>65.0</apiVersion>
    <isExposed>true</isExposed>
    <masterLabel>GM - Compact Calendar</masterLabel>
    <targets>
        <target>lightning__RecordPage</target>
        <target>lightning__AppPage</target>
        <target>lightning__HomePage</target>
    </targets>
    <targetConfigs>
        <targetConfig targets="lightning__RecordPage,lightning__AppPage,lightning__HomePage">
            <property name="title" type="String" label="Title" description="Calendar Title" />
            <property name="customIcon" type="String" label="Custom Icon" description="Calendar Custom Icon" />
            <property name="jsonConfig" type="String" label="Json Config" description="Json Calendar Configuration" />
            <property name="showBorder" type="Boolean" label="Show Border" description="Show Border" />
        </targetConfig>
    </targetConfigs>
</LightningComponentBundle>
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.gridmate.io/package-reference/components-library/calendars-and-timelines/gm-compact-calendar.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
