> For the complete documentation index, see [llms.txt](https://docs.avonnicomponents.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.avonnicomponents.com/experience-cloud/experience-components/ax-kanban.md).

# AX - Kanban

## Overview

**AX - Kanban** is an Experience Cloud component that displays Salesforce records as draggable cards organized into workflow columns on Experience Sites pages.

Use it to let portal users visualize and manage workflows—like support case statuses, project phases, or approval stages. Users drag cards between columns to update record values, while you control which fields appear on cards and which picklist values define the columns. Configure everything in Experience Builder without code.

Perfect for customer support portals showing case progress, partner portals managing deal stages, project collaboration spaces, or anywhere portal users need visual workflow management.

<figure><img src="https://2929066058-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDL6JQuZArjJeQvX2ot4y%2Fuploads%2Fgit-blob-2e909924e0c22ec84825e3cd941bb7d008454d4f%2F2024-04-22_20-46-23.png?alt=media" alt=""><figcaption></figcaption></figure>

## Getting Started

Use this simple tutorial to learn the basics of the Kanban component and start building your use cases.

{% @arcade/embed url="<https://app.arcade.software/share/SKeLCf1CoTnJZHTYhLOF>" flowId="SKeLCf1CoTnJZHTYhLOF" %}

## Configuration

### Data Source

This essential step in configuring your Avonni Kanban component establishes the connection between your Kanban board and the relevant data within your Salesforce environment.

<figure><img src="https://2929066058-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDL6JQuZArjJeQvX2ot4y%2Fuploads%2Fgit-blob-7193379306749bbf199a6a6481838daf9694ec95%2F2024-04-22_20-35-17.png?alt=media" alt=""><figcaption></figcaption></figure>

Here's how it works:

* **Object Selection:** Begin by choosing the specific Salesforce object (e.g., Accounts, Opportunities, custom objects, etc.) that contains the data you want your Kanban board to display.
* **Optional Filtering:** If you wish to display only a subset of data from the selected object, use the filtering feature to set specific conditions. For instance, you might filter to show only "Open" opportunities or accounts within a certain region.
* **Grouping (Optional):** Group your data to effectively organize your Kanban board. For example, grouping opportunities by "Stage" can create columns for "Prospecting," "Negotiation," etc.
* **Sorting:** Select an "Order By" field and direction (ascending or descending) to determine the order in which the Kanban cards should appear.
* **Additional Fields:** If you need to include fields in your Kanban that aren't directly used for display or interactions, add them in the "Additional Fields" section. This is particularly useful for fields you want to be searchable within Kanban's search bar.
* **Group Summaries:** Add one or more summary calculations to each column header — see [Column Summaries](#column-summaries) below.

#### **Key Points**

* Choosing the right data source ensures your Kanban displays the information most relevant to your users.
* Filtering and grouping streamline the board, making it easier to visualize and manage specific work items.

### Data Mapping <a href="#data-mappings-configuration" id="data-mappings-configuration"></a>

The "Data Mappings" section establishes a precise connection between your Salesforce data and the visual elements of your Kanban board. Here's why this is crucial:

* **Accurate Display:** Data mappings ensure that information pulled from Salesforce fields is displayed correctly on Kanban cards and within the board's columns. For example, you might map the Salesforce "Opportunity Name" field to the title of each Kanban card.
* **Functionality:** Mappings also control how users interact with the Kanban board. For instance, mapping a "Status" field to the Kanban columns allows users to drag and drop cards to update the status directly within the board.

When the record update behind a drag fails — a validation rule, a missing permission — the card returns to the column it came from, an **Error Updating Record** toast shows the error, and the board keeps the number of cards it had already loaded, so the user does not lose their place in a long column.

#### **How it Works**

1. **Select a Salesforce field** from your configured data source.
2. **Map it to a Kanban attribute** such as card title, description, column name, etc.
3. **Repeat this process** for all the essential fields you want to include on the Kanban board

**Search Fields** is mapped here too: it lists the object fields the board's search box searches across. It requires **Show Search** in **Search Engine Attributes** — without it there is no search box to search with.

### Board & Card Settings

**Variant** sets the column-header style: `Base` (the default) for plain headers, or `Path` to render them as a progress path. **Hide Column Header** hides the column headers, **Highlight On Click** highlights the clicked card, and **Read Only** disables drag-and-drop and inline edits.

The header is configured with a **Header Title** and **Header Caption** — each with its own **Header Title Text Style** / **Header Caption Text Style** setting (`Heading 1` to `Heading 4`, `Paragraph 1` / `Paragraph 2`) — a **Header Icon Name** and **Header Icon Size**, and **Header Is Joined** to sit flush with the board below.

**Group By Attributes** control how records are grouped into columns — **Collapsed**, **Hide Undefined Group**, **Show Empty Sub Groups**, and the **Undefined Group Label**. **Column Order Direction** sets the column order: `Default`, `Ascending Order`, `Descending Order`, or `Custom` (which reveals a **Columns Custom Order** list you arrange by hand).

**Avatar Attributes**, **Image Attributes**, and **Field Layout Attributes** style each card's avatar, image, and the layout of its fields. **Filter Menu Attributes** and **Search Engine Attributes** configure the board's filter menu and search bar.

Every filter in that menu also carries an operator, picked from a menu at the top of the filter. Text, picklist, multi-select picklist and lookup filters offer `Equals` (the default), `Not Equals`, `Empty` and `Not Empty`. Number, date and time filters offer `Between` (the default), `Not Between`, `Equals`, `Not Equals`, `Less Than`, `Less or Equal`, `Greater Than`, `Greater or Equal`, `Empty` and `Not Empty`. `Empty` and `Not Empty` take no value, so the filter's inputs are hidden while either is selected. Checkbox filters have no operator menu.

### Column Summaries

Summaries are configured in the **Data Source**, alongside the grouping that produces the columns — **Group Summaries** for the column headers, and **Sub Group Summaries** for the sub-group headers when the board is sub-grouped. Both become available once the matching group field is set, and both take a list, so one column header can carry several figures.

Each summary entry has:

* **Field** — the record field to aggregate. Required.
* **Aggregate Function** — `Sum` (the default), `Average`, `Count`, `Distinct Count`, `Min / Earliest`, or `Max / Latest`.
* **Treat Blank Values As Zero** — counts blank values as 0 instead of skipping them. Requires an **Aggregate Function** of `Average` or `Count`: it widens the average's denominator and makes blanks count.
* **Prefix** and **Suffix** — optional text shown before and after the value, for example a `Total` prefix or a `deals` suffix.
* **Display As** — `Number` (the default), `Currency`, `Percent`, or `Date`. `Date` is offered only for `Min / Earliest` and `Max / Latest`.
* **Type Attributes** — formatting for the chosen **Display As**: currency code and display style for `Currency`; minimum/maximum integer, fraction and significant digits for `Number`, `Currency` and `Percent`; and day, month, year, weekday and era formats for `Date`.

{% hint style="warning" %}
The property panel's **Summarize Attributes** section is deprecated and no longer rendered. Boards configured with it keep working, but new summaries — and anything needing an aggregate other than a sum, a prefix/suffix, or currency, percent or date formatting — belong in **Group Summaries** on the data source.
{% endhint %}

## Interactions

This section lets you customize how users interact with your Kanban cards, making the board more dynamic and responsive.

### **Link to**

* Define what happens when a user clicks on a specific link within a Kanban card.
* **Common Uses:** Navigate to a record detail page, open an external website, or trigger a Salesforce Flow.

### **On Click**

* Determine actions that occur when a user clicks anywhere on a Kanban card.
* **Common Uses:** Expand the card for more details, open a modal window, or initiate a process.

<table><thead><tr><th width="228">Interaction Type</th><th>Description</th></tr></thead><tbody><tr><td><a href="https://docs.avonnicomponents.com/experience-cloud/properties-panel/interactions/show-toast.md"><strong>Show Toast</strong></a></td><td>Displays a brief pop-up notification on the screen, providing quick feedback or information after the card is clicked.</td></tr><tr><td><a href="https://docs.avonnicomponents.com/experience-cloud/properties-panel/interactions/navigate.md"><strong>Navigate</strong></a></td><td>Redirects the user to a different page in your site or URL, guiding them to the record behind the card.</td></tr><tr><td><a href="https://docs.avonnicomponents.com/experience-cloud/properties-panel/interactions/open-alert-modal.md"><strong>Open Alert Modal</strong></a></td><td>Opens a modal window with an alert message, presenting important information or warnings about the selected record.</td></tr><tr><td><a href="https://docs.avonnicomponents.com/experience-cloud/properties-panel/interactions/open-confirm.md"><strong>Open Confirm</strong></a></td><td>Triggers a confirmation dialog box, used for actions that require additional user confirmation before they run.</td></tr><tr><td><a href="https://docs.avonnicomponents.com/experience-cloud/properties-panel/interactions/open-flow-dialog.md"><strong>Open Flow Dialog</strong></a></td><td>Opens a dialog that runs a Salesforce Flow, initiating workflows or processes for the selected record.</td></tr><tr><td><a href="https://docs.avonnicomponents.com/experience-cloud/properties-panel/interactions/open-flow-panel.md"><strong>Open Flow Panel</strong></a></td><td>Runs a Salesforce Flow in a side panel beside the board instead of a dialog, so the cards stay visible.</td></tr><tr><td><a href="https://docs.avonnicomponents.com/experience-cloud/properties-panel/interactions/execute-flow.md"><strong>Execute Flow</strong></a></td><td>Runs an autolaunched Salesforce Flow in the background, with no dialog or panel. Useful for automation the user does not need to step through.</td></tr><tr><td><a href="https://docs.avonnicomponents.com/experience-cloud/properties-panel/interactions/download.md"><strong>Download</strong></a></td><td>Downloads a file, from a Salesforce file, a public link, or a URL.</td></tr></tbody></table>

## Styling

{% tabs %}
{% tab title="Margin" %}
Controls the outer spacing around the Kanban board.
{% endtab %}

{% tab title="Padding" %}
Controls the inner spacing of the Kanban board.
{% endtab %}

{% tab title="Size" %}

* **Width:** Controls the overall horizontal width of the Kanban board.
* **Height:** Controls the overall vertical height of the Kanban board.
* **Overflow:** Dictates how content is handled if it exceeds the board's dimensions.
  {% endtab %}

{% tab title="Border" %}

* **Size:** Thickness of the border around the entire Kanban board.
* **Style:** Appearance of the border (e.g., solid, dashed).
* **Color:** Color of the border.
* **Radius:** How rounded the corners of the board are.
  {% endtab %}

{% tab title="Header" %}

* **Background Color:** Sets the background color of the Kanban's header section.
* **Padding (Top, Right, Bottom, Left):** Controls internal spacing within the header.
* **Margin Bottom:** Creates space between the header and the columns below.
  {% endtab %}

{% tab title="Header Border" %}

* **Border Color, Size, Style, Radius:** Customize the border drawn around the header.
* **Bottom Border Color / Size / Style (Is Joined):** Apply only when **Header Is Joined** is on, styling the seam between the header and the board.
  {% endtab %}

{% tab title="Header Title / Caption" %}

* **Color, Font Size, Font Weight, Font Style:** Set separately for the header title and the header caption.
  {% endtab %}

{% tab title="Header Avatar" %}

* **Background Color / Foreground Color:** Set the colors of the header avatar element.
* **Border Radius:** Controls how rounded the avatar element is.
  {% endtab %}

{% tab title="Column Header" %}

* **Path Background Color:** Color of the background area where the column progress path is displayed (**Variant** `Path`).
  {% endtab %}

{% tab title="Column Header Summary" %}

* **Text Color, Font Size, Font Weight:** Appearance of the summarized value in the column header.
* **Prefix/Suffix Text Color, Prefix/Suffix Font Size:** Style the **Prefix** and **Suffix** labels separately from the value itself.
* **Height, Line Height:** Size of the summary row within the column header.
  {% endtab %}

{% tab title="Column Sizing" %}

* **Min Width / Max Width:** Set the minimum and maximum width allowed for columns, affecting how they resize.
  {% endtab %}

{% tab title="Card Color" %}

* **Background, Background Hover, Background Focus, Background Highlight:** Card background in its normal, hovered, focused and highlighted states.
* **Border, Border Focus, Border Highlight:** Card border in the matching states.
  {% endtab %}

{% tab title="Card Title / Description / Info" %}
Each of the three card text areas has its own group with the same controls:

* **Text Color, Font Size, Font Weight, Font Style:** Appearance of that text.
* **Line Clamp:** Limits the number of lines displayed before the text truncates.
  {% endtab %}

{% tab title="Flow Dialog & Panel" %}
Styles the dialog or side panel opened by an **Open Flow Dialog** or **Open Flow Panel** interaction — the header and footer backgrounds and borders, the label typography, the panel's own background and border, and the close-icon colors.
{% endtab %}
{% endtabs %}

## Use Cases

### Example 1: Partner Opportunity Kanban

{% @arcade/embed url="<https://app.arcade.software/share/JQJEWO5OUQQf4fSb0GfD>" flowId="JQJEWO5OUQQf4fSb0GfD" %}

Give your partners a clear, interactive view of their sales pipeline, right inside your Experience Cloud portal. With a drag-and-drop Kanban board, partner users can visualize, manage, and advance their opportunities without ever leaving the portal.

***

#### **What You'll Achieve**

* **Empowered partner visibility:** Give partner users a real-time, visual overview of their opportunity pipeline organized by stage
* **Intuitive pipeline management:** Enable drag-and-drop functionality so partners can update opportunity stages effortlessly
* **At-a-glance deal insight:** Surface key details like account name, deal amount, and close date directly on each card

***

#### **How to Set It Up**

{% stepper %}
{% step %}

#### **Add the Kanban component**

* Drag the AX Kanban component into your Experience Cloud Builder canvas
  {% endstep %}

{% step %}

#### **Configure the data source**

* Set the Object API Name to `Opportunity`
  {% endstep %}

{% step %}

#### **Set up data mappings**

* Set the Key Field to `Id`
* Set the Group Field Name to `StageName`
* Set the Group Field Record Type to `Master`
* Add a Group Summaries entry: set **Field** to `Amount`, **Aggregate Function** to **Sum** and **Display As** to **Currency**
  {% endstep %}

{% step %}

#### **Customize the cards**

* Set the Title to `Name`
* Set the Description to `Account.Name`
* Set the Start Date to `CreatedDate`
* Set the Due Date to `CloseDate`
* Add `Amount` as a displayed field
  {% endstep %}

{% step %}

#### **Customize the header**

* Set the Header Title to `Opportunity Kanban`
* Set the Header Icon to `standard:opportunity`
  {% endstep %}

{% step %}

#### **Preview your board**

* Review the layout in Experience Cloud Builder to confirm your configuration looks and behaves as expected
  {% endstep %}
  {% endstepper %}

***

#### **Links**

{% content-ref url="/pages/uknWhmyRuIyQ4MKeqKBa" %}
[AX - Tabs](https://docs.avonnicomponents.com/experience-cloud/experience-components/ax-tabs.md)
{% endcontent-ref %}

### Example 2: Case Status Kanban

{% @arcade/embed url="<https://app.arcade.software/share/XXPy9vrTjP5P3hbCqwTg>" flowId="XXPy9vrTjP5P3hbCqwTg" %}

Give your customers visibility into their support journey with a dedicated Kanban board inside your support portal. By displaying cases organized by status, customers can track progress at a glance, reducing the need to follow up for updates and creating a smoother, more transparent support experience.

***

#### **What You'll Achieve**

* **Customer-facing transparency:** Let customers monitor the status of every submitted case in a clear, organized board view
* **Reduced inbound status calls:** Proactively show progress so customers spend less time chasing updates
* **Improved support satisfaction:** Deliver a polished, intuitive experience that builds trust and confidence in your support team

***

#### **How to Set It Up**

{% stepper %}
{% step %}

#### **Add the Kanban component**

* Drag the AX Kanban component into your Experience Cloud Builder canvas
  {% endstep %}

{% step %}

#### **Configure the data source**

* Set the Object API Name to `Case`
  {% endstep %}

{% step %}

#### **Set up data mappings**

* Set the Key Field to `Id`
* Set the Group Field Name to `Status`
  {% endstep %}

{% step %}

#### **Customize the cards**

* Set the Title to `Number`
* Set the Description to `Contact.Name`
* Set the Start Date to `CreatedDate`
  {% endstep %}

{% step %}

#### **Customize the header**

* Set the Variant to `Path`
* Set the Header Title to `Cases Kanban`
* Set the Header Icon to `standard:case`
  {% endstep %}

{% step %}

#### **Preview your board**

* Review the layout in Experience Cloud Builder to confirm your configuration looks and behaves as expected
  {% endstep %}
  {% endstepper %}


---

# 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.avonnicomponents.com/experience-cloud/experience-components/ax-kanban.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.
