Blazorise Transfer List API

Explore the Blazorise Transfer List API reference for parameters, events, methods, and related types.

For examples and usage guidance, see the Transfer List documentation.

API

Parameters

Parameter Description TypeDefault
EndCaption

Specifies the end caption text for the end (right) list. Used only when EndCaptionTemplate is not provided.

string"End"
EndCaptionTemplate

Defines the end caption template, which can be used to render a custom header or caption for the end (right) list.

RenderFragmentnull
ItemEndTemplate

Defines the template used to render items in the end (right) list.

RenderFragment<ItemContext<TItem>>null
Items

Provides the complete collection of items managed by the transfer list.

List<TItem>null
ItemsEnd

Specifies the items displayed in the end (right) list.

List<TItem>null
ItemsStart

Specifies the items displayed in the start (left) list.

List<TItem>null
ItemStartTemplate

Defines the template used to render items in the start (left) list.

RenderFragment<ItemContext<TItem>>null
MaxHeight

Sets the maximum height of each list pane. Defaults to 300px.

string"300px"
Mode

Specifies how the list groups behave (e.g., selectable, static).

Possible values:Static, Selectable

ListGroupModeSelectable
MoveAllToEndIconName

Specifies the icon name of the move all to end (right) button.

IconName?69
MoveAllToStartIconName

Specifies the icon name of the move all to start (left) button.

IconName?68
MoveButtonsColor

Specifies the color of the move and "Move All" buttons.

ColorPrimary
MoveButtonsIconSize

Specifies the size of the move icons.

IconSize?null
MoveButtonsIconStyle

Specifies the style of the move icons.

IconStyle?null
MoveButtonsIconTextColor

Specifies the text color of the move icons.

TextColornull
MoveToEndIconName

Specifies the icon name of the move to end (right) button.

IconName?73
MoveToStartIconName

Specifies the icon name of the move to start (left) button.

IconName?72
Scrollable

Enables a vertical scrollbar when the list exceeds the maximum height.

booltrue
SelectedItemEnd

Specifies the currently selected item in the end (right) list.

TItemnull
SelectedItemsEnd

Specifies the currently selected items in the end (right) list for multi-selection mode.

List<TItem>null
SelectedItemsStart

Specifies the currently selected items in the start (left) list for multi-selection mode.

List<TItem>null
SelectedItemStart

Specifies the currently selected item in the start (left) list.

TItemnull
SelectionMode

Specifies how many items can be selected at once in each list.

Possible values:Single, Multiple

ListGroupSelectionModeSingle
ShowCaptions

Determines whether the captions are visible above the lists.

boolfalse
ShowMoveAll

Determines whether the "Move All" buttons are visible between lists.

booltrue
StartCaption

Specifies the start caption text for the start (left) list. Used only when StartCaptionTemplate is not provided.

string"Start"
StartCaptionTemplate

Defines the start caption template, which can be used to render a custom header or caption for the start (left) list.

RenderFragmentnull

Events

Event Description Type
CanMoveToEnd

Determines whether a specific item can be moved to the end (right) list.

Func<TItem, bool>
CanMoveToStart

Determines whether a specific item can be moved to the start (left) list.

Func<TItem, bool>
ItemsEndChanged

Event callback triggered when the end list items change.

EventCallback<List<TItem>>
ItemsStartChanged

Event callback triggered when the start list items change.

EventCallback<List<TItem>>
SelectedItemEndChanged

Event callback triggered when the selected item in the end list changes.

EventCallback<TItem>
SelectedItemsEndChanged

Event callback triggered when the selected items in the end list change.

EventCallback<List<TItem>>
SelectedItemsStartChanged

Event callback triggered when the selected items in the start list change.

EventCallback<List<TItem>>
SelectedItemStartChanged

Event callback triggered when the selected item in the start list changes.

EventCallback<TItem>
TextField

Function used to extract the display text field from an item.

Func<TItem, string>
ValueField

Function used to extract the unique value field from an item.

Func<TItem, string>

Methods

Method DescriptionReturnParameters
MoveAllEnd Moves all eligible items from the start (left) list to the end (right) list. Task
MoveAllStart Moves all eligible items from the end (right) list to the start (left) list. Task
MoveSelectedEnd Moves the currently selected item(s) from the start (left) list to the end (right) list, based on SelectionMode. Task
MoveSelectedStart Moves the currently selected item(s) from the end (right) list to the start (left) list, based on SelectionMode. Task
On this page