> 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/grids/gm-grid-dashboard.md).

# GM - Grid Dashboard

(gmpkg:userGridKPIListLWC)

## **Documentation**

**GM - Grid Dashboard** component displays a list of KPI tiles, one per [GM - User Grid](https://docs.gridmate.io/package-reference/components-library/grids/gm-user-grid.md). Each tile shows the grid label, the number of records matching the grid filter on a semi-circle gauge, and a **View \<grid label>** button that opens the User Grid record.

**Use case:** Display on the home page the number of open opportunities and the number of contacts to follow up, based on the User Grids used by the sales team.

## **Specification**

<table data-full-width="true"><thead><tr><th width="157.58502197265625">Property</th><th width="131.33333333333331">Type</th><th width="604.8924357096355">Description</th></tr></thead><tbody><tr><td>KPI Config</td><td>String</td><td><p>JSON array of KPI tiles. Each tile supports the following keys:</p><ul><li><strong>type:</strong> Tile type. Should be set to '<strong>userGrid</strong>'. Other types are ignored.</li><li><strong>gridApiName:</strong> Developer name of the User Grid.</li><li><strong>max:</strong> The record count displayed as a full gauge. The default value is 100.</li><li><strong>min:</strong> Minimum value of the gauge. It is not used to draw the gauge in the current version. The default value is 0.</li><li><strong>tier1Color</strong>, <strong>tier2Color</strong>, <strong>tier3Color:</strong> Colors of the gauge gradient, from left to right. In the current version, the gauge always uses the default colors #05716B, #FFB75D and #C23934.</li></ul></td></tr></tbody></table>

Below is an example with two User Grids:

```json
[
    {
        "type": "userGrid",
        "gridApiName": "All_Contacts_uf1g1",
        "tier1Color": "#05716B",
        "tier2Color": "#FFB75D",
        "tier3Color": "#C23934",
        "max": 1500,
        "min": 0
    },
    {
        "type": "userGrid",
        "gridApiName": "Opportunities_ze5bl",
        "tier1Color": "#05716B",
        "tier2Color": "#FFB75D",
        "tier3Color": "#C23934",
        "max": 500,
        "min": 0
    }
]
```

## **API Reference**

{% tabs fullWidth="true" %}
{% tab title="userGridKPIListLWC.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 - Grid Dashboard</masterLabel>
    <description>GM - Grid Dashboard</description>
    <targets>
        <target>lightning__AppPage</target>
        <target>lightning__HomePage</target>
    </targets>
    <targetConfigs>
        <targetConfig targets="lightning__AppPage,lightning__HomePage">
            <property name="jsonKpiConfig" type="String" label="KPI Config" description="JSON KPI List Configuration" />
        </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/grids/gm-grid-dashboard.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.
