> 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-user-calendar.md).

# GM - User Calendar

(gmpkg:userCalendarLWC)

## **Documentation**

GridMate provides the **GM – User Calendar**, a highly configurable calendar component that enables users to manage standard and custom objects within a unified calendar view. It supports advanced filtering, color conditioning, and dynamic event rendering based on user interactions.

**Use case:** Give end-users a calendar that combines several standard and custom objects in a single view. See [**End User Calendar**](https://docs.gridmate.io/product-tour/calendars-and-timelines/end-user-calendar.md).

## **Specification**

<table data-full-width="true"><thead><tr><th width="339.123291015625">Property</th><th width="206.81689453125">Type</th><th width="305.83056640625">Description</th></tr></thead><tbody><tr><td>UserCalendar Id or Developer Name</td><td>String</td><td>GM - UserCalendar Id or Developer Name to use</td></tr><tr><td>Calendar Height</td><td>Integer</td><td>Set the calendar height. Use 9999 for dynamic height</td></tr></tbody></table>

## **API Reference**

{% tabs %}
{% tab title="userCalendarLWC.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 - User Calendar</masterLabel>
    <targets>
        <target>lightning__RecordPage</target>
        <target>lightning__AppPage</target>
        <target>lightning__HomePage</target>
        <target>lightningCommunity__Page</target>
        <target>lightningCommunity__Default</target>
    </targets>
    <targetConfigs>
        <targetConfig
            targets="lightning__RecordPage,lightning__AppPage,lightning__HomePage,lightningCommunity__Default"
        >
            <property
                name="userCalendarId"
                type="String"
                label="UserCalendar Id or Developer Name"
                description="GM - UserCalendar Id or Developer Name to use"
            />

            <property
                name="height"
                type="Integer"
                label="Calendar Height"
                description="Set the calendar height. Use 9999 for dynamic height"
            />
        </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-user-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.
