GM - kanban Board

Documentation

GridMate’s Kanban Board component is a highly customizable tool designed to enhance workflow management. It allows users to track progress and perform quick updates without navigating away from the page. This component is ideal for managing tasks in a visual format, making it easier to interact with data in one place.

Use case: Display opportunity kanban board based on the opportunity object. see GM - Kanban Board

Currently, the Kanban board supports only quick action and calling a flow.

Specification

Property	Type	Description
Custom Label	String	Set the label of the kanban.
Custom Icon	String	Customize the kanban icon. All lightning icons are supported.
Object Name	String	The name of the object to display (e.g., Opportunity).
Target Object Name	String	The name of the object to display if the kanban is shown on a record page.
Stage Field	String	The stage field to use for the kanban.
Stage Values	String	JSON string defining the subset of stage values to use within the kanban.
Title Field	String	The title field to use for each kanban card's title.
Object Fields	String	A comma-separated list of detail fields for the cards.
Row Limit	Integer	The maximum number of rows to fetch from the specified object.
Filter	String	JSON string defining filter criteria. Ex. {'StageName':'Needs Analysis'}.
Sort	String	The field list to sort the data.
Order	String	Ascending or descending order for sorting.
Enable Create Object	Boolean	Check to enable the creation of new objects from the kanban.
Enable Update Object	Boolean	Check to enable updates to existing objects.
Enable Mass Update	Boolean	Check to allow bulk updates to existing objects.
Enable Delete Object	Boolean	Check to allow deletion of objects from the kanban.
Enable Mass Delete	Boolean	Check to allow bulk deletion of objects.
Aggregate	String	JSON string to define aggregate fields. Ex. {'Amount':'sum'} to sum amounts of opportunities.
Actions	String	JSON string to initialize the list of available actions.
Show Actions as Buttons	Boolean	Use buttons for actions instead of icons.
Custom Visible Actions	Integer	Number of visible custom actions.
Record Actions	String	JSON string to initialize the list of available record actions.
Stage States	String	JSON Stage States configuration to control the behavior when the user move a card.
Popover Fields	String	Popover Fields to display
Popover Columns #	String	# Of Popover Columns
Card Coloring	String	JSON conditions for card coloring based on defined metrics.
Show Border	Boolean	Check this option to add a border to the kanban.
Density	String	Component density: comfy or compact.
Board Height	Integer	Set the board height in pixels.

API Reference

<?xml version="1.0" encoding="UTF-8"?>
<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
    <apiVersion>64.0</apiVersion>
    <isExposed>true</isExposed>
    <masterLabel>GM - Kanban Board</masterLabel>
    <description>GM - Kanban Board</description>
    <targets>
        <target>lightning__AppPage</target>
        <target>lightning__RecordPage</target>
        <target>lightning__HomePage</target>
    </targets>
    <targetConfigs>
        <targetConfig targets="lightning__AppPage,lightning__RecordPage,lightning__HomePage">
            <property
                name="displayLabel"
                type="String"
                label="Custom Label"
                description="Set the label of the kanban"
            />
            <property
                name="customIcon"
                type="String"
                label="Custom Icon"
                description="Customize the kanban icon. All lightning icons are supported. You can get the icon name from https://lightningdesignsystem.com/icons/"
            />

            <property
                name="objectApiName"
                type="String"
                label="Object Name"
                description="The name of the object to display. Ex. Opportunity."
            />
            <property
                name="sobjectName"
                type="String"
                label="Target Object Name"
                description="The name of the object to display if the kanban is displayed on a record page. Ex. Opportunity."
            />
            <property
                name="stageField"
                type="String"
                label="Stage Field"
                description="The stage field to use for the kanban"
            />
            <property
                name="stageValues"
                type="String"
                label="Stage Values"
                description="JSON stage values. The subset of values to use."
            />
            <property
                name="titleField"
                type="String"
                label="Title Field"
                description="The title field to use for the card title"
            />
            <property
                name="jsonObjectFields"
                type="String"
                label="Object Fields"
                description="',' separated list of detail fields"
            />

            <property
                name="rowLimit"
                type="Integer"
                label="Row Limit"
                description="The maximum number of row to fetch"
            />
            <property
                name="filterBy"
                type="String"
                label="Filter"
                description="Json string to define filter criteria. Don’t forget __c for custom fields. Ex. {'StageName':'Needs Analysis'} to see only 'Needs Analysis' Opportunities"
            />
            <property
                name="sortBy"
                type="String"
                label="Sort"
                description="The field list to sort the data. Don’t forget __c for custom fields. Ex. Amount to sort opportunities by amount"
            />
            <property name="orderBy" type="String" label="Order" description="Asc or Desc order for sorting" />

            <property
                name="canCreate"
                type="Boolean"
                label="Enable Create Object"
                description="Check this option if you want to create object"
            />

            <property
                name="canEdit"
                type="Boolean"
                label="Enable Update Object"
                description="Check this option if you want to update object"
            />

            <property
                name="canMassUpdate"
                type="Boolean"
                label="Enable Mass Update"
                description="Check this option if you want to mass update"
            />

            <property
                name="canDelete"
                type="Boolean"
                label="Enable Delete Object"
                description="Check this option if you want to delete object"
            />

            <property
                name="canMassDelete"
                type="Boolean"
                label="Enable Mass Delete"
                description="Check this option if you want to mass delete"
            />

            <property
                name="jsonAggregate"
                type="String"
                label="Aggregate"
                description="Json string to define aggregate fields. Ex. {'Amount':'sum'} to sum the amount of opportunities"
            />

            <property
                name="jsonActions"
                type="String"
                label="Actions"
                description="Json string to initialize the list of available actions"
            />
            <property
                name="buttonActions"
                type="Boolean"
                label="Show Actions as Buttons"
                description="Use buttons for actions instead of icons"
            />
            <property
                name="visibleActions"
                type="Integer"
                label="Custom Visible Actions"
                description="# of visible custom actions"
            />
            <property
                name="jsonRecordActions"
                type="String"
                label="Record Actions"
                description="Json string to initialize the list of available record actions"
            />
            <property
                name="jsonStageStates"
                type="String"
                label="Stage States"
                description="JSON Stage States configuration to control the behavior when the user move a card."
            />
            <property
                name="jsonPopoverFields"
                type="String"
                label="Popover Fields"
                description="Popover Fields to display"
            />
            <property
                name="popoverColumns"
                type="Integer"
                label="Popover Columns #"
                description="# Of Popover Columns"
            />

            <property
                name="jsonCardColoring"
                type="String"
                label="Card Coloring"
                description="JSON conditions for cards coloring"
            />

            <property name="showBorder" type="Boolean" label="Show Border" description="Show Border" />
            <property name="density" type="String" label="Density" description="Component density : comfy | compact" />
            <property name="height" type="Integer" label="Board Height" description="Set the board height in px" />
        </targetConfig>
    </targetConfigs>
</LightningComponentBundle>