> 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/gm-user-kanban-board.md).

# GM - User Kanban Board

(gmpkg:userKanbanLWC)

## **Documentation**

**GM - User Kanban Board** component displays a Kanban board whose configuration is stored in a **GM - User Kanban Board** record instead of the App Builder properties. The board offers the same features as the [GM - Kanban Board](/package-reference/components-library/gm-kanban-board.md) (stages, cards, aggregates, actions, card coloring...), and the same configuration can be reused on several pages. Users with edit access to the configuration record see a **Config. Wiz** button in the board toolbar to open the configuration wizard. This is the same pattern as the [GM - User Grid](/package-reference/components-library/gm-user-grid.md) for grids.

{% hint style="info" %}
Assign the **GridMate Kanban User** permission set to the users who create or configure the GM - User Kanban Board records.
{% endhint %}

**Use case:** Display a Kanban board of opportunities by stage, configured once in a GM - User Kanban Board record and reused on the sales app page and the home page. See [GM - Kanban Board](/product-tour/kanban/kanban-board.md).

## **Specification**

<table data-full-width="true"><thead><tr><th width="244">Property</th><th width="131.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>UserKanban Id or Developer Name *</td><td>String</td><td>Id or developer name of the GM - User Kanban Board record to use. Keep this empty only if the component is placed on the GM - User Kanban Board record page.</td></tr><tr><td>Board Height</td><td>Integer</td><td>Set the board height in px. If the value is set 9999, the board will use the remaining space on the page.</td></tr></tbody></table>

## **API Reference**

{% tabs fullWidth="true" %}
{% tab title="userKanbanLWC.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 Kanban Board</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="userKanbanId"
                type="String"
                label="UserKanban Id or Developer Name"
                description="GM - UserKanban Id or Developer Name to use"
            />

            <property
                name="height"
                type="Integer"
                label="Board Height"
                description="Set the board 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/gm-user-kanban-board.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.