Interface IKanban

Interface for managing Kanban board functionalities and properties.

Namespace: Syncfusion.Blazor.Kanban

Assembly: Syncfusion.Blazor.dll

Syntax

public interface IKanban

Remarks

This interface defines the essential properties and methods for configuring a Kanban board, supporting features like drag-and-drop, keyboard interactions, and more.

Properties

AllowDragAndDrop

Gets or sets a value indicating whether drag and drop actions are enabled in the Kanban.

Declaration

bool AllowDragAndDrop { get; set; }

Property Value

Type	Description
System.Boolean	A boolean indicating the status of drag-and-drop functionality.

Remarks

Set this property to true to enable reordering of cards through drag-and-drop interactions.

AllowKeyboard

Gets or sets a value indicating whether keyboard interaction is allowed in the Kanban board.

Declaration

bool AllowKeyboard { get; set; }

Property Value

Type	Description
System.Boolean	A boolean indicating whether keyboard interactions are enabled.

Remarks

When enabled, users can use keyboard shortcuts and navigation within the Kanban board.

CardSettings

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

Declaration

KanbanCardSettings CardSettings { get; set; }

Property Value

Type	Description
KanbanCardSettings	An instance of KanbanCardSettings containing configuration for card settings.

Remarks

Customize card appearance and settings like templates, headers, and selection modes through this property.

Columns

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

Declaration

List<KanbanColumn> Columns { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<KanbanColumn>	A list of KanbanColumn that specifies properties for each column.

Remarks

Use this property to configure the various attributes of columns within the Kanban board to suit your needs.

ConstraintType

Defines the constraint type used to apply validation based on column or swimlane. Possible values are Column and Swimlane.

Declaration

ConstraintType ConstraintType { get; set; }

Property Value

Type	Description
ConstraintType	An instance of ConstraintType determining the validation constraint source.

Remarks

Select the appropriate constraint type to ensure operations within columns or swimlanes meet desired validation rules.

CssClass

Provides custom CSS class names that define specific user-defined styles and themes for the Kanban element.

Declaration

string CssClass { get; set; }

Property Value

Type	Description
System.String	A string representing CSS class names for custom styling.

Remarks

Apply unique styles to the Kanban component by assigning custom CSS classes through this property.

DialogSettings

Defines the dialog settings such as template and fields.

Declaration

KanbanDialogSettings DialogSettings { get; set; }

Property Value

Type	Description
KanbanDialogSettings	An instance of KanbanDialogSettings specifying dialog configurations.

Remarks

Customize the appearance and behavior of dialog windows used in the Kanban board through this property.

EnableRtl

Gets or sets a value illustrating whether the component is rendered in the right-to-left direction.

Declaration

bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean	A boolean indicating RTL layout support.

Remarks

Enable this option to support right-to-left languages, allowing the Kanban component to render accordingly.

EnableTooltip

Gets or sets a value indicating whether tooltips are enabled in the Kanban board.

Declaration

bool EnableTooltip { get; set; }

Property Value

Type	Description
System.Boolean	A boolean indicating if tooltips are enabled.

Remarks

Tooltips provide additional information about items on the Kanban board when users hover over them.

ExternalDropId

Specifies the IDs of components that act as drop targets for Kanban cards.

Declaration

List<string> ExternalDropId { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>	A list of strings detailing the components eligible for card drops.

Remarks

Indicate external component IDs where Kanban elements can be dropped, facilitating integrated drag-and-drop functionality.

Height

Sets the height of the Kanban component, accepting both string (for pixel or percentage values) and numeric values.

Declaration

string Height { get; set; }

Property Value

Type	Description
System.String	A string representing the height value.

Remarks

Define the component's height using exact measurements or 'auto' for responsive adjustment within its container.

KanbanTemplates

Enables or disables the template in the Kanban board.

Declaration

KanbanTemplates KanbanTemplates { get; set; }

Property Value

Type	Description
KanbanTemplates	An instance of KanbanTemplates that details template configurations.

Remarks

Customize and apply templates within the Kanban board using this property to enhance its appearance and functionality.

KeyField

Specifies the key field of the Kanban board, which influences the layout rendering.

Declaration

string KeyField { get; set; }

Property Value

Type	Description
System.String	A string depicting the key field used for layout organization.

Remarks

The key field is essential in establishing the organizational framework of the Kanban board layout.

Query

Describes the external query executed alongside the Kanban's data processing tasks.

Declaration

Query Query { get; set; }

Property Value

Type	Description
Query	An instance of Query representing the data query.

Remarks

Utilize this property to incorporate additional queries during data processing operations within the Kanban.

SortSettings

Defines the sorting settings, such as sortBy, field, and direction.

Declaration

KanbanSortSettings SortSettings { get; set; }

Property Value

Type	Description
KanbanSortSettings	An instance of KanbanSortSettings that details sorting preferences.

Remarks

Adjust sorting criteria and direction for organizing items within the Kanban board using this property.

StackedHeaders

Configures stacked headers for Kanban columns using text and key fields.

Declaration

List<KanbanStackedHeader> StackedHeaders { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<KanbanStackedHeader>	A list of KanbanStackedHeader that specifies column patterns.

Remarks

Utilize stacked headers to group multiple columns, enhancing organizational clarity and board readability.

SwimlaneSettings

Defines the swimlane settings for the Kanban board, including the key field, text field, template, and more.

Declaration

KanbanSwimlaneSettings SwimlaneSettings { get; set; }

Property Value

Type	Description
KanbanSwimlaneSettings	An instance of KanbanSwimlaneSettings describing swimlane configurations.

Remarks

Configure key fields, templates, and appearance of swimlanes within the Kanban board to suit your requirements.

Width

Sets the width of the Kanban component, accepting both string and numeric values.

Declaration

string Width { get; set; }

Property Value

Type	Description
System.String	A string representing the width in pixels or percentage format.

Remarks

Specify the Kanban's width to a particular dimension or 'auto' for adjusting based on the viewable space.

Methods

CallStateHasChangedAsync()

Invokes an update of the Kanban component's current state to the user interface.

Declaration

Task CallStateHasChangedAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation to refresh the UI state.

Remarks

Call this method to ensure that changes to the data and configuration of the Kanban board are reflected in the UI.

PropertyChanged()

Notifies when properties on the Kanban component have changed.

Declaration

Task PropertyChanged()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation for property change handling.

Remarks

This method is useful for updating the component's display to reflect changes in its properties.