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 | Default | Type |
|---|---|---|
EndCaption | "End" | string |
Specifies the end caption text for the end (right) list. Used only when EndCaptionTemplate is not provided. | ||
EndCaptionTemplate | null | RenderFragment |
Defines the end caption template, which can be used to render a custom header or caption for the end (right) list. | ||
ItemEndTemplate | null | RenderFragment<ItemContext<TItem>> |
Defines the template used to render items in the end (right) list. | ||
Items | null | List<TItem> |
Provides the complete collection of items managed by the transfer list. | ||
ItemsEnd | null | List<TItem> |
Specifies the items displayed in the end (right) list. | ||
ItemsStart | null | List<TItem> |
Specifies the items displayed in the start (left) list. | ||
ItemStartTemplate | null | RenderFragment<ItemContext<TItem>> |
Defines the template used to render items in the start (left) list. | ||
MaxHeight | "300px" | string |
Sets the maximum height of each list pane. Defaults to 300px. | ||
Mode | Selectable | ListGroupMode |
Specifies how the list groups behave (e.g., selectable, static). Possible values: StaticSelectable | ||
MoveAllToEndIconName | ChevronDoubleRight | IconName? |
Specifies the icon name of the move all to end (right) button. | ||
MoveAllToStartIconName | ChevronDoubleLeft | IconName? |
Specifies the icon name of the move all to start (left) button. | ||
MoveButtonsColor | Primary | Color |
Specifies the color of the move and "Move All" buttons. | ||
MoveButtonsIconSize | null | IconSize? |
Specifies the size of the move icons. | ||
MoveButtonsIconStyle | null | IconStyle? |
Specifies the style of the move icons. | ||
MoveButtonsIconTextColor | null | TextColor |
Specifies the text color of the move icons. | ||
MoveToEndIconName | ChevronRight | IconName? |
Specifies the icon name of the move to end (right) button. | ||
MoveToStartIconName | ChevronLeft | IconName? |
Specifies the icon name of the move to start (left) button. | ||
Scrollable | true | bool |
Enables a vertical scrollbar when the list exceeds the maximum height. | ||
SelectedItemEnd | null | TItem |
Specifies the currently selected item in the end (right) list. | ||
SelectedItemsEnd | null | List<TItem> |
Specifies the currently selected items in the end (right) list for multi-selection mode. | ||
SelectedItemsStart | null | List<TItem> |
Specifies the currently selected items in the start (left) list for multi-selection mode. | ||
SelectedItemStart | null | TItem |
Specifies the currently selected item in the start (left) list. | ||
SelectionMode | Single | ListGroupSelectionMode |
Specifies how many items can be selected at once in each list. Possible values: SingleMultiple | ||
ShowCaptions | false | bool |
Determines whether the captions are visible above the lists. | ||
ShowMoveAll | true | bool |
Determines whether the "Move All" buttons are visible between lists. | ||
StartCaption | "Start" | string |
Specifies the start caption text for the start (left) list. Used only when StartCaptionTemplate is not provided. | ||
StartCaptionTemplate | null | RenderFragment |
Defines the start caption template, which can be used to render a custom header or caption for the start (left) list. | ||
Events
| Event | Type |
|---|---|
CanMoveToEnd | Func<TItem, bool> |
Determines whether a specific item can be moved to the end (right) list. | |
CanMoveToStart | Func<TItem, bool> |
Determines whether a specific item can be moved to the start (left) list. | |
ItemsEndChanged | EventCallback<List<TItem>> |
Event callback triggered when the end list items change. | |
ItemsStartChanged | EventCallback<List<TItem>> |
Event callback triggered when the start list items change. | |
SelectedItemEndChanged | EventCallback<TItem> |
Event callback triggered when the selected item in the end list changes. | |
SelectedItemsEndChanged | EventCallback<List<TItem>> |
Event callback triggered when the selected items in the end list change. | |
SelectedItemsStartChanged | EventCallback<List<TItem>> |
Event callback triggered when the selected items in the start list change. | |
SelectedItemStartChanged | EventCallback<TItem> |
Event callback triggered when the selected item in the start list changes. | |
TextField | Func<TItem, string> |
Function used to extract the display text field from an item. | |
ValueField | Func<TItem, string> |
Function used to extract the unique value field from an item. | |
Methods
| Method | Return | Parameters |
|---|---|---|
MoveAllEnd | Task | — |
Moves all eligible items from the start (left) list to the end (right) list.
| ||
MoveAllStart | Task | — |
Moves all eligible items from the end (right) list to the start (left) list.
| ||
MoveSelectedEnd | Task | — |
Moves the currently selected item(s) from the start (left) list to the end (right) list, based on SelectionMode.
| ||
MoveSelectedStart | Task | — |
Moves the currently selected item(s) from the end (right) list to the start (left) list, based on SelectionMode.
| ||