Implementing Syncfusion WinUI Kanban (SfKanban)

This skill provides comprehensive guidance for implementing the Syncfusion® WinUI Kanban (SfKanban) control, a powerful visual workflow management system that displays tasks as cards organized across columns representing different workflow stages.

When to Use This Skill

Use this skill immediately when:

• User wants to create a Kanban board for task or project management
• Building workflow visualization systems (to-do, in-progress, done)
• Implementing agile project tracking boards
• Need work-in-progress (WIP) limits per workflow stage
• Creating task boards with drag-and-drop functionality
• Organizing tasks by teams, projects, or custom criteria using swim lanes
• Managing software development workflows or issue tracking systems
• Need to visualize task status across multiple stages

Component Overview

The Syncfusion WinUI Kanban (SfKanban) provides an efficient way to visualize workflows at each stage of completion. It offers:

Core Features:

• Cards: Visual representation of tasks with title, description, tags, images, and priority indicators
• Columns: Organize work into workflow stages (e.g., Open, In Progress, Done)
• Swim Lanes: Group cards by projects, teams, users, or custom categories
• Work-in-Progress (WIP) Limits: Set minimum/maximum task limits per column to prevent overload
• Drag and Drop: Intuitive card movement between columns and swim lanes
• Workflows: Define allowed card transitions between specific states
• Sorting: Organize cards within columns by priority, date, or custom fields
• Events: Rich event model for card interactions (tap, drag, drop)
• Customization: Extensive template support for cards, headers, and swim lanes
• Theming: Built-in light and dark themes with system integration
• Localization & RTL: Support for multiple languages and right-to-left rendering

Documentation and Navigation Guide

Getting Started

📄 Read: references/getting-started.md

Use when user needs:

• Initial setup and installation via NuGet
• Creating basic Kanban board
• Understanding ItemsSource binding
• Using default KanbanModel vs custom data models
• Setting up auto-generated or manual columns
• Applying themes, localization, and RTL support

Cards Configuration

📄 Read: references/cards.md

Use when user needs:

• Understanding card structure and properties
• Customizing card appearance with CardTemplate
• Working with card indicators and tags
• Implementing conditional card templates (CardTemplateSelector)
• Enabling and customizing card tooltips
• Troubleshooting card display issues

Columns Management

📄 Read: references/columns.md

Use when user needs:

• Configuring column widths (minimum, maximum, exact)
• Auto-generating vs manually defining columns
• Mapping categories to columns
• Customizing column headers
• Expanding/collapsing columns programmatically
• Enabling/disabling drag-and-drop per column
• Setting up multi-category columns
• Configuring WIP (Work-in-Progress) limits with visual indicators
• Customizing drag/drop placeholder appearance

Swim Lanes Organization

📄 Read: references/swimlanes.md

Use when user needs:

• Grouping cards by teams, projects, or users
• Enabling and configuring swim lanes
• Mapping swim lane properties (SwimlaneKey)
• Customizing swim lane header appearance
• Creating hierarchical card organization
• Implementing team-based or project-based views

Workflows and Transitions

📄 Read: references/workflows.md

Use when user needs:

• Defining allowed card transitions between columns
• Restricting card movement between specific states
• Implementing workflow validation rules
• Preventing drag-and-drop to specific columns
• Creating state machine-like workflows
• Managing complex workflow transitions

Card Sorting

📄 Read: references/sorting.md

Use when user needs:

• Sorting cards within columns by priority, date, or custom fields
• Implementing custom field sorting (ascending/descending)
• Setting up index-based sorting for precise positioning
• Dynamically updating sort order after drag-and-drop
• Refreshing column display after sorting changes
• Understanding sorting with custom data models

Events and Interactions

📄 Read: references/events.md

Use when user needs:

• Handling card tap events (CardTapped)
• Responding to drag events (CardDragStarting, CardDragOver)
• Processing card drop events (CardDrop)
• Implementing MVVM commands (CardTappedCommand)
• Accessing event arguments and card data
• Preventing or customizing drag-and-drop behavior
• Implementing business logic on card interactions

Quick Start Example

Basic Kanban Setup

<Window xmlns:kanban="using:Syncfusion.UI.Xaml.Kanban">
    <kanban:SfKanban x:Name="kanban" 
                     ItemsSource="{Binding TaskDetails}">
        <kanban:SfKanban.DataContext>
            <local:ViewModel/>
        </kanban:SfKanban.DataContext>
    </kanban:SfKanban>
</Window>

ViewModel with KanbanModel

using Syncfusion.UI.Xaml.Kanban;

public class ViewModel
{
    public ObservableCollection<KanbanModel> TaskDetails { get; set; }

    public ViewModel()
    {
        TaskDetails = new ObservableCollection<KanbanModel>
        {
            new KanbanModel
            {
                Title = "UWP Issue",
                Id = "651",
                Description = "Fix crosshair label template issue",
                Category = "Open",
                IndicatorColorKey = "High",
                Tags = new List<string> { "Bug Fixing" }
            },
            new KanbanModel
            {
                Title = "Kanban Feature",
                Id = "25678",
                Description = "Implement drag and drop support",
                Category = "In Progress",
                IndicatorColorKey = "Normal",
                Tags = new List<string> { "New Feature" }
            }
        };
    }
}

Manual Column Definition

<kanban:SfKanban AutoGenerateColumns="False" 
                 ItemsSource="{Binding TaskDetails}">
    <kanban:KanbanColumn HeaderText="To Do" Categories="Open" />
    <kanban:KanbanColumn HeaderText="In Progress" Categories="In Progress" />
    <kanban:KanbanColumn HeaderText="Done" Categories="Done" />
</kanban:SfKanban>

Common Patterns

Pattern 1: Auto-Generated Columns

When: User wants quick setup with columns generated from data

// Columns automatically generated from Category property values
kanban.AutoGenerateColumns = true;
kanban.ItemsSource = viewModel.TaskDetails;

Result: Columns created automatically based on unique Category values in data

Pattern 2: WIP Limits with Visual Indicators

When: User needs to limit tasks per stage and show visual feedback

<kanban:KanbanColumn HeaderText="In Progress" 
                     Categories="In Progress"
                     MinimumCount="2" 
                     MaximumCount="5" />

Result:

• Error bar shows red when count exceeds MaximumCount
• Error bar shows yellow when count is below MinimumCount
• Helps prevent workflow bottlenecks

Pattern 3: Custom Card Template

When: User needs custom card appearance beyond default

<kanban:SfKanban.CardTemplate>
    <DataTemplate>
        <Border Background="#F3CFCE" 
                BorderThickness="1" 
                CornerRadius="3">
            <StackPanel Margin="10">
                <TextBlock Text="{Binding Title}" 
                          FontWeight="Bold" 
                          FontSize="14" />
                <TextBlock Text="{Binding Description}" 
                          FontSize="12" 
                          TextWrapping="Wrap" />
            </StackPanel>
        </Border>
    </DataTemplate>
</kanban:SfKanban.CardTemplate>

DataContext: KanbanModel instance

Pattern 4: Swim Lanes by Team

When: User wants to organize cards by teams or projects

<kanban:SfKanban SwimlaneKey="Assignee" 
                 ItemsSource="{Binding TaskDetails}">
    <!-- Cards grouped by Assignee property -->
</kanban:SfKanban>

Result: Horizontal swim lane rows, one per unique Assignee value

Pattern 5: Workflow Restrictions

When: User wants to enforce specific card transition rules

<kanban:SfKanban.Workflows>
    <kanban:KanbanWorkflow Category="Open">
        <kanban:KanbanWorkflow.AllowedTransitions>
            <x:String>In Progress</x:String>
        </kanban:KanbanWorkflow.AllowedTransitions>
    </kanban:KanbanWorkflow>
    <kanban:KanbanWorkflow Category="In Progress">
        <kanban:KanbanWorkflow.AllowedTransitions>
            <x:String>Done</x:String>
            <x:String>Won't Fix</x:String>
        </kanban:KanbanWorkflow.AllowedTransitions>
    </kanban:KanbanWorkflow>
</kanban:SfKanban.Workflows>

Result:

• Cards in "Open" can only move to "In Progress"
• Cards in "In Progress" can only move to "Done" or "Won't Fix"
• Prevents invalid state transitions

Pattern 6: Custom Data Model

When: User has existing data model, not using KanbanModel

// Custom model
public class TaskDetails
{
    public string Title { get; set; }
    public string Description { get; set; }
    public string Status { get; set; }
}

// XAML
<kanban:SfKanban ItemsSource="{Binding Tasks}"
                 ColumnMappingPath="Status">
    <kanban:SfKanban.CardTemplate>
        <!-- Define custom template -->
    </kanban:SfKanban.CardTemplate>
</kanban:SfKanban>

Important: Must define CardTemplate when using custom model

Key Properties

SfKanban Properties

KanbanColumn Properties

KanbanModel Properties

Common Use Cases

1. Software Development Task Board

Scenario: Track bugs and features through development stages

<kanban:SfKanban ItemsSource="{Binding Issues}">
    <kanban:KanbanColumn HeaderText="Backlog" Categories="Open,New" />
    <kanban:KanbanColumn HeaderText="In Development" 
                         Categories="In Progress" 
                         MaximumCount="3" />
    <kanban:KanbanColumn HeaderText="Testing" 
                         Categories="Testing" 
                         MaximumCount="5" />
    <kanban:KanbanColumn HeaderText="Done" 
                         Categories="Closed,Resolved" />
</kanban:SfKanban>

2. Team-Based Project Management

Scenario: Organize tasks by team members with swim lanes

<kanban:SfKanban SwimlaneKey="Assignee" 
                 ItemsSource="{Binding ProjectTasks}">
    <kanban:SfKanban.SwimlaneHeaderTemplate>
        <DataTemplate>
            <StackPanel Orientation="Horizontal">
                <Image Source="{Binding Image}" Width="30" Height="30"/>
                <TextBlock Text="{Binding Title}" Margin="10,0"/>
            </StackPanel>
        </DataTemplate>
    </kanban:SfKanban.SwimlaneHeaderTemplate>
</kanban:SfKanban>

3. Priority-Based Sorting

Scenario: Sort cards by priority within each column

<kanban:SfKanban SortingMappingPath="Priority"
                 SortingOrder="Descending"
                 ItemsSource="{Binding Tasks}"
                 CardDrop="OnCardDrop">
    <!-- Columns -->
</kanban:SfKanban>

private void OnCardDrop(object sender, KanbanCardDropEventArgs e)
{
    kanban.RefreshKanbanColumn(e.TargetColumn.AllowedTransitionCategory.ToString());
}

4. Interactive Card Actions

Scenario: Handle card taps to show details dialog

kanban.CardTapped += (s, e) => {
    var card = e.SelectedCard.Content as KanbanModel;
    var dialog = new TaskDetailsDialog(card);
    await dialog.ShowAsync();
};

Troubleshooting

Issue: Columns Not Showing

Symptoms: Kanban board is empty, no columns visible

Solutions:

1. Verify AutoGenerateColumns is true OR Columns are manually defined
2. Check ItemsSource is bound correctly
3. Ensure Category property has values in data
4. If using ColumnMappingPath, verify property exists in model

Issue: Cards Not Displaying

Symptoms: Columns show but cards are missing

Solutions:

1. Check ItemsSource has data
2. Verify Category values match column Categories
3. If using custom model, ensure CardTemplate is defined
4. Check DataContext is set correctly

Issue: Drag-and-Drop Not Working

Symptoms: Cannot move cards between columns

Solutions:

1. Verify AllowDrag=true on source column (default is true)
2. Ensure Workflows don't restrict the transition
3. Check if columns have correct Categories mapping

Issue: WIP Limits Not Working

Symptoms: Visual indicators not showing for WIP limits

Solutions:

1. Verify MinimumCount and/or MaximumCount are set on columns
2. Check card count actually exceeds/is below limits
3. Ensure theme resources are loaded correctly

Issue: Swim Lanes Not Grouping

Symptoms: All cards in single row, no swim lanes

Solutions:

1. Verify SwimlaneKey property is set
2. Check mapped property exists in data model
3. Ensure property has varying values in data
4. If using KanbanModel, default is "Assignee"

Issue: Sorting Not Applied

Symptoms: Cards not sorted after drag-and-drop

Solutions:

1. Call RefreshKanbanColumn() in CardDrop event
2. Verify SortingMappingPath is set to valid property
3. Check property type is sortable (string, int, DateTime, etc.)
4. Ensure SortingOrder is specified (Ascending/Descending)

Best Practices

1. Use KanbanModel for Quick Start: Built-in model with default card UI saves development time
2. Custom Models Require Templates: Always define CardTemplate when using custom data models
3. Set WIP Limits: Implement MinimumCount/MaximumCount to prevent workflow bottlenecks
4. Handle CardDrop for Sorting: Call RefreshKanbanColumn() after drop when using sorting
5. Use Workflows for Validation: Prevent invalid state transitions with Workflows property
6. Optimize Column Width: Set MinimumColumnWidth/MaximumColumnWidth for responsive layouts
7. Leverage Swim Lanes: Group cards by logical categories (teams, projects, priorities)
8. Customize Indicators: Define IndicatorColorPalette for clear visual prioritization
9. Enable Tooltips: Set IsToolTipEnabled=true for additional card information
10. Test Themes: Verify appearance in both light and dark modes

Edge Cases and Gotchas

Multiple Categories per Column:

• Use comma-separated values: Categories="Open,New,Backlog"
• All matching cards appear in single column

Custom Model Requirements:

• MUST define CardTemplate (default template requires KanbanModel)
• MUST set ColumnMappingPath if not using "Category" property name
• DataContext for template is your custom model instance

Workflow Restrictions:

• Empty AllowedTransitions = no drops allowed
• Not defining workflow for a category = allows all transitions
• Workflow Category must match exact Category value in data

Sorting with Drag-Drop:

• Sorting doesn't auto-apply after drop
• Must manually call RefreshKanbanColumn() in CardDrop event
• Index-based sorting requires custom implementation in event handlers

Swim Lane Grouping:

• Default swim lane key is "Assignee" for KanbanModel
• Custom models must set SwimlaneKey explicitly
• Null or empty values create single "ungrouped" swim lane

For detailed API reference, visit: Syncfusion WinUI Kanban Documentation