Class SfKanban<TValue>

The Kanban component is an efficient way to visually depict various stages of a process using cards with transparent workflows.

Inheritance
System.Object
Syncfusion.Blazor.SfBaseComponent
SfDataBoundComponent
SfKanban<TValue>
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Kanban
Assembly: Syncfusion.Blazor.dll
Syntax
public sealed class SfKanban<TValue> : SfDataBoundComponent, IKanban
Type Parameters
Name Description
TValue

Constructors

SfKanban()

Declaration
public SfKanban()

Properties

AllowDragAndDrop

Enables or disables the drag and drop actions in the Kanban.

Declaration
public bool AllowDragAndDrop { get; set; }
Property Value
Type Description
System.Boolean

AllowKeyboard

When this property is set to true, it allows the keyboard interaction in the Kanban board.

Declaration
public bool AllowKeyboard { get; set; }
Property Value
Type Description
System.Boolean

CardSettings

Defines the Kanban board related settings such as header field, content field, template, show or hide header, and single or multiple selection.

Declaration
public KanbanCardSettings CardSettings { get; set; }
Property Value
Type Description
KanbanCardSettings

Columns

Defines the Kanban board columns and their properties such as header text, key field, template, allow toggle, expand or collapse state, min or max count, and show or hide item count.

Declaration
public List<KanbanColumn> Columns { get; set; }
Property Value
Type Description
System.Collections.Generic.List<KanbanColumn>

ConstraintType

Defines the constraint type used to apply validation based on column or swimlane. The possible values are: Column Swimlane.

Declaration
public ConstraintType ConstraintType { get; set; }
Property Value
Type Description
ConstraintType

CssClass

It is used to customize the Kanban, which accepts custom CSS class names that define specific user-defined styles and themes to be applied on the Kanban element.

Declaration
public string CssClass { get; set; }
Property Value
Type Description
System.String

DataSource

Accepts the list items either through local or remote service and binds it to the component. It can be passed either as List or else can create an instance of the SfDataManager in case of processing remote data and can be assigned to the DataSource property.

Declaration
public IEnumerable<TValue> DataSource { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<TValue>

DataSourceChanged

Invokes when data source changes.

Declaration
public EventCallback<IEnumerable<TValue>> DataSourceChanged { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Collections.Generic.IEnumerable<TValue>>

DialogSettings

Defines the dialog settings such as template and fields.

Declaration
public KanbanDialogSettings DialogSettings { get; set; }
Property Value
Type Description
KanbanDialogSettings

EnableRtl

Enable or disable rendering component in the right to left direction.

Declaration
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

EnableTooltip

Enables or disables the tooltip in the Kanban board. The property relates to the tooltipTemplate property.

Declaration
public bool EnableTooltip { get; set; }
Property Value
Type Description
System.Boolean

ExternalDropId

Defines the ID of drop component on which drop should occur.

Declaration
public List<string> ExternalDropId { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

Height

Sets the Height of the Kanban component, accepting both string and number values. The string type includes either pixel or percentage values. When height is set with specific pixel value, then the Kanban will be rendered to that specified space. In case, if auto value is set, then the height of the Kanban gets auto-adjusted within the given container.

Declaration
public string Height { get; set; }
Property Value
Type Description
System.String

ID

Specifies the unique identifier.

Declaration
public string ID { get; set; }
Property Value
Type Description
System.String

KeyField

Defines the key field of the Kanban board. The Kanban renders its layout based on this key field.

Declaration
public string KeyField { get; set; }
Property Value
Type Description
System.String

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration
public string Locale { get; set; }
Property Value
Type Description
System.String

Query

Defines the external Query that will be executed along with the data processing.

Declaration
public Query Query { get; set; }
Property Value
Type Description
Query

SortSettings

Defines the sort settings such as field and direction.

Declaration
public KanbanSortSettings SortSettings { get; set; }
Property Value
Type Description
KanbanSortSettings

StackedHeaders

Defines the stacked header for Kanban columns with text and key fields.

Declaration
public List<KanbanStackedHeader> StackedHeaders { get; set; }
Property Value
Type Description
System.Collections.Generic.List<KanbanStackedHeader>

SwimlaneSettings

Defines the swimlane settings to the Kanban board such as key field, text field, template, allow drag-and-drop, show or hide an empty row, show or hide items count, and more.

Declaration
public KanbanSwimlaneSettings SwimlaneSettings { get; set; }
Property Value
Type Description
KanbanSwimlaneSettings

Width

Sets the Width of the Kanban component, accepting both string and number values. The string value can be either pixel or percentage format. When set to auto, the Kanban width gets auto-adjusted and displays its content related to the viewable screen size.

Declaration
public string Width { get; set; }
Property Value
Type Description
System.String

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

GetSelectedCards()

Gets the list of selected cards from the board.

Declaration
public Task<List<DOM>> GetSelectedCards()
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<DOM>>

Returns the select card details.

GetSwimlaneData(String)

Returns the swimlane column data based on the swimlane keyField input.

Declaration
public List<TValue> GetSwimlaneData(string keyField)
Parameters
Type Name Description
System.String keyField

Specifies the key field.
Returns
Type Description
System.Collections.Generic.List<TValue>

Returns the list of swimlane column data.

HideColumn(String)

Hides the column from the Kanban board based on the provided key in the columns.

Declaration
public Task HideColumn(string key)
Parameters
Type Name Description
System.String key

Specifies the key.
Returns
Type Description
System.Threading.Tasks.Task

A System.Threading.Tasks.Task representing any asynchronous operation.

OnAfterRenderAsync(Boolean)

Method invoked after each time the component has been rendered.

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type Name Description
System.Boolean firstRender

Set to true if this is the first time OnAfterRender(Boolean) has been invoked.
Returns
Type Description
System.Threading.Tasks.Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides

OnInitializedAsync()

Method invoked when the component is ready to start.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
System.Threading.Tasks.Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides

ShowColumn(String)

To show or hide the column based on the provided key in the columns.

Declaration
public Task ShowColumn(string key)
Parameters
Type Name Description
System.String key

Specifies the key.
Returns
Type Description
System.Threading.Tasks.Task

A System.Threading.Tasks.Task representing any asynchronous operation.

Explicit Interface Implementations

IKanban.KanbanTemplates

Enables or disables template in the Kanban board. The property relates to the tooltipTemplate property.

Declaration
KanbanTemplates IKanban.KanbanTemplates { get; set; }
Returns
Type Description
KanbanTemplates

Implements