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

# Components Library

Browse every Lightning component in the GridMate package, grouped by type with a short description.

{% hint style="info" %}
**Mobile:** the grid components are built for desktop. For the Salesforce mobile app, use [GM - Mobile Grid](https://docs.gridmate.io/package-reference/components-library/grids/gm-mobile-grid.md), a phone-only grid displaying records as cards.
{% endhint %}

The **Components Library** is the reference for every Lightning component shipped with the GridMate package. Each page documents the component properties as they appear in the Lightning App Builder (or Flow Builder) and the exact design / metadata source.

## Grids

| Component                                                                                                                                  | Description                                                         |
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- |
| [GM - RelatedList Grid](https://docs.gridmate.io/package-reference/components-library/grids/gm-relatedlist-grid.md)                        | Display and edit the records of a related list on a record page.    |
| [GM - FieldSet Grid](https://docs.gridmate.io/package-reference/components-library/grids/gm-fieldset-grid.md)                              | Display and edit records using a field set to define the columns.   |
| [GM - ListView Grid](https://docs.gridmate.io/package-reference/components-library/grids/gm-listview-grid.md)                              | Display and edit the records of a list view.                        |
| [GM - User Grid](https://docs.gridmate.io/package-reference/components-library/grids/gm-user-grid.md)                                      | Display a grid configured by the end user from the grid wizard.     |
| [GM - Mobile Grid](https://docs.gridmate.io/package-reference/components-library/grids/gm-mobile-grid.md)                                  | Touch-first grid for the Salesforce mobile app, records as cards.   |
| [GM - Grid Dashboard](https://docs.gridmate.io/package-reference/components-library/grids/gm-grid-dashboard.md)                            | List of KPI tiles, one per User Grid, showing the record count.     |
| [GM - Parent RelatedList Grid](https://docs.gridmate.io/package-reference/components-library/grids/gm-parent-relatedlist-grid.md)          | Display a related list of a parent record on the child record page. |
| [GM - Apex Data Grid](https://docs.gridmate.io/package-reference/components-library/grids/gm-apex-data-grid.md)                            | Display the rows returned by your own Apex class.                   |
| [GM - Dynamic FieldSet Grid](https://docs.gridmate.io/package-reference/components-library/dynamic-components/gm-dynamic-fieldset-grid.md) | FieldSet grid refreshed from the row selected in a master grid.     |
| [GM - User Grid Split View](https://docs.gridmate.io/package-reference/components-library/grids/gm-user-grid-split-view.md)                | Browse and open User Grids from a split view list.                  |

## Kanban & Pivot

| Component                                                                                                                        | Description                                                      |
| -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| [GM - FieldSet Kanban](https://docs.gridmate.io/package-reference/components-library/kanban-and-pivot/gm-fieldset-kanban.md)     | Kanban view of records using a field set for the card fields.    |
| [GM - ListView Kanban](https://docs.gridmate.io/package-reference/components-library/kanban-and-pivot/gm-kanban-data-grid.md)    | Kanban view of the records of a list view.                       |
| [GM - FieldSet Pivot](https://docs.gridmate.io/package-reference/components-library/kanban-and-pivot/gm-fieldset-pivot.md)       | Pivot table of records using a field set.                        |
| [GM - Kanban Board](https://docs.gridmate.io/package-reference/components-library/kanban-and-pivot/gm-kanban-board.md)           | Kanban board with configurable stages.                           |
| [GM - User Kanban Board](https://docs.gridmate.io/package-reference/components-library/kanban-and-pivot/gm-user-kanban-board.md) | Kanban board configured in a record and reused on several pages. |

## Calendars & Scheduling

| Component                                                                                                                             | Description                                         |
| ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
| [GM - Compact Calendar](https://docs.gridmate.io/package-reference/components-library/calendars-and-timelines/gm-compact-calendar.md) | Compact calendar for record and app pages.          |
| [GM - Multi Calendar](https://docs.gridmate.io/package-reference/components-library/calendars-and-timelines/gm-calendar.md)           | Calendar displaying several objects at once.        |
| [GM - Single Calendar](https://docs.gridmate.io/package-reference/components-library/calendars-and-timelines/gm-single-calendar.md)   | Calendar displaying the records of a single object. |
| [GM - User Calendar](https://docs.gridmate.io/package-reference/components-library/calendars-and-timelines/gm-user-calendar.md)       | Calendar configured by the end user.                |
| [GM - Gantt Chart](https://docs.gridmate.io/package-reference/components-library/calendars-and-timelines/gm-gantt-chart.md)           | Gantt chart to plan and track records over time.    |

## Files, Maps & Reports

| Component                                                                                                                    | Description                                                     |
| ---------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
| [GM - File Explorer](https://docs.gridmate.io/package-reference/components-library/files/gm-file-explorer.md)                | Browse and manage files and folders.                            |
| [GM - Cloud File Viewer (Beta)](https://docs.gridmate.io/package-reference/components-library/files/gm-cloud-file-viewer.md) | Preview an external Files Connect file on the File record page. |
| [GM - Map List](https://docs.gridmate.io/package-reference/components-library/maps/gm-map-list.md)                           | Display a list of records on a map.                             |
| [GM - Map Record](https://docs.gridmate.io/package-reference/components-library/maps/gm-map-record.md)                       | Display the current record location on a map.                   |
| [GM - Report Table](https://docs.gridmate.io/package-reference/components-library/grids/gm-report-table.md)                  | Display a Salesforce report as a table.                         |

## Record Components

| Component                                                                                                                              | Description                                                   |
| -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| [GM - Record Card](https://docs.gridmate.io/package-reference/components-library/records/gm-record-card.md)                            | Display a record as a card.                                   |
| [GM - Dynamic Record Card](https://docs.gridmate.io/package-reference/components-library/dynamic-components/gm-dynamic-record-card.md) | Record card refreshed from the row selected in a master grid. |
| [GM - Record Layout](https://docs.gridmate.io/package-reference/components-library/records/gm-record-layout.md)                        | Display and edit a record using a JSON layout with sections.  |
| [GM - Record Layout (LWC)](https://docs.gridmate.io/package-reference/components-library/records/gm-record-layout-lwc.md)              | LWC version of the record layout.                             |
| [GM - Enhanced Record Layout](https://docs.gridmate.io/package-reference/components-library/records/gm-enhanced-record-layout.md)      | Enhanced record layout component.                             |
| [GM - Field Path](https://docs.gridmate.io/package-reference/components-library/records/gm-field-path.md)                              | Display a path based on any picklist field.                   |
| [GM - Object Timeline](https://docs.gridmate.io/package-reference/components-library/calendars-and-timelines/gm-object-timeline.md)    | Display the related records of a record on a timeline.        |

## Containers (Tabs, Accordion & Cards)

| Component                                                                                                                             | Description                                           |
| ------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| [GM - RelatedList Tabs](https://docs.gridmate.io/package-reference/components-library/related-lists/gm-relatedlist-tabs.md)           | Display related list grids in tabs.                   |
| [GM - RelatedList Accordion](https://docs.gridmate.io/package-reference/components-library/related-lists/gm-relatedlist-accordion.md) | Display related list grids in an accordion.           |
| [GM - RelatedList Cards](https://docs.gridmate.io/package-reference/components-library/related-lists/gm-relatedlist-cards.md)         | Display related records as cards.                     |
| [GM - Dynamic Tabs](https://docs.gridmate.io/package-reference/components-library/dynamic-components/gm-dynamic-tabs.md)              | Tab set configured in JSON, hosting any components.   |
| [GM - Dynamic Accordion](https://docs.gridmate.io/package-reference/components-library/dynamic-components/gm-dynamic-accordion.md)    | Accordion configured in JSON, hosting any components. |

## Flow

| Component                                                                                                            | Description                                                          |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
| [GM - Flow View Grid](https://docs.gridmate.io/package-reference/components-library/flow-grids/gm-flow-view-grid.md) | View and select a collection of records in a flow screen.            |
| [GM - Flow Edit Grid](https://docs.gridmate.io/package-reference/components-library/flow-grids/gm-flow-edit-grid.md) | Edit a collection of records in a flow screen.                       |
| [GM - Flow Card Grid](https://docs.gridmate.io/package-reference/components-library/flow-grids/gm-flow-card-grid.md) | Select records from a list of responsive cards in a flow screen.     |
| [GM - Flow Layout](https://docs.gridmate.io/package-reference/components-library/records/gm-flow-layout.md)          | Edit a related record using a layout configuration in a flow screen. |

## Utilities

| Component                                                                                                                                  | Description                                                                |
| ------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- |
| [GM - Record App Switcher](https://docs.gridmate.io/package-reference/components-library/records/gm-record-app-switcher.md)                | Utility bar item to switch Lightning App while keeping the current record. |
| [GM - Interaction Logger](https://docs.gridmate.io/package-reference/components-library/utilities-and-monitoring/gm-interaction-logger.md) | Track user interactions for the Adoption Dashboard.                        |


---

# 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.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.
