BlazorSortable 6.0.2

There is a newer version of this package available.
See the version list below for details.

dotnet add package BlazorSortable --version 6.0.2

NuGet\Install-Package BlazorSortable -Version 6.0.2

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="BlazorSortable" Version="6.0.2" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="BlazorSortable" Version="6.0.2" />
                    

                            Directory.Packages.props

<PackageReference Include="BlazorSortable" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add BlazorSortable --version 6.0.2

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: BlazorSortable, 6.0.2"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package BlazorSortable@6.0.2

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=BlazorSortable&version=6.0.2
                    

                            Install as a Cake Addin

#tool nuget:?package=BlazorSortable&version=6.0.2
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

BlazorSortable

A Blazor component that wraps SortableJS, a library for drag-and-drop sorting.

Inspired by BlazorSortable and represents an improved and extended implementation.

Installation

Via NuGet Package Manager

Via .NET CLI

dotnet add package BlazorSortable

Via PackageReference

Add to your .csproj file:

<ItemGroup>
  <PackageReference Include="BlazorSortable" Version="6.*" />
</ItemGroup>

Setup

Add the SortableJS script to the host page of your app, before the closing </body> tag:
- wwwroot/index.html (for Blazor WebAssembly Standalone App)
- Components/App.razor (for Blazor Web App)
Use one of the following methods:
1. Via CDN:
```
<script src="https://cdn.jsdelivr.net/npm/sortablejs@latest/Sortable.min.js"></script>
```
1. Locally:
```
<script src="lib/sortablejs/Sortable.min.js"></script>
```
You can optionally add a cache-busting query string (one of several cache-busting approaches):
```
<script src="lib/sortablejs/Sortable.min.js?v=1.15.7"></script>
```
For local installation:
1. Download the latest version of SortableJS (GitHub)
2. Create the folder structure in wwwroot: lib/sortablejs/
3. Place the Sortable.min.js file in the created folder

(Optional) Add base styles to the <head> element of the same host page:

<link rel="stylesheet" href="_content/BlazorSortable/css/blazor-sortable.css" />

You can also add a cache-busting query string (one of several cache-busting approaches):
<link rel="stylesheet" href="_content/BlazorSortable/css/blazor-sortable.css?v=6.0.2" />
Or automatically use the current assembly version as the cache-busting value from a Razor file:
<link rel="stylesheet" href="_content/BlazorSortable/css/blazor-sortable.css?v=@(typeof(BlazorSortable.Sortable<>).Assembly.GetName().Version)" />
For Blazor WebAssembly Standalone App, place this inside the <HeadContent> section of App.razor and make sure Program.cs contains:
builder.RootComponents.Add<HeadOutlet>("head::after");

Add services in the Program.cs of the app where the component runs (InteractiveWebAssembly components require registration in the client app):
```
using BlazorSortable;

// ...

builder.Services.AddSortable();
```
Add the using directive in _Imports.razor:
```
@using BlazorSortable
```

Usage Example

<div class="sortable-sample">
    <Sortable Items="@(["Write docs", "Add tests", "Publish package"])"
              Group="tasks"
              Class="sortable-column">
        <div class="sortable-item">
            @context
        </div>
    </Sortable>

    <Sortable Items="@(["Create project"])"
              Group="tasks"
              Class="sortable-column">
        <div class="sortable-item">
            @context
        </div>
    </Sortable>

    <Sortable TItem="object"
              Group="delete"
              Put="SortablePutMode.Groups"
              PutGroups="@(["tasks"])"
              Class="sortable-delete" />
</div>

<style>
    .sortable-sample {
        display: flex;
        gap: 16px;
    }

    .sortable-column,
    .sortable-delete {
        width: 180px;
        min-height: 96px;
        padding: 12px;
        border: 2px dashed #d0d7de;
        border-radius: 6px;
    }

    .sortable-column {
        display: flex;
        flex-direction: column;
        gap: 8px;
    }

    .sortable-delete {
        border-color: #dc3545;
        overflow: hidden;
    }

    .sortable-item {
        padding: 10px 12px;
        border: 1px solid #d0d7de;
        border-radius: 6px;
        background: white;
        cursor: grab;
        user-select: none;
    }
</style>

Component Parameters

Sortable

Note: Support for MultiDrag and Swap plugins will be added in future releases.

Parameter	Type	Default	Description
`TItem`	`notnull`	-	Type of items displayed, sorted, or accepted by the component
`Items`	`IList<TItem>?`	`null`	Items to display and sort. If `null`, the component works as a drop zone
`ChildContent`	`RenderFragment<TItem>?`	`null`	Template for displaying each item. Can be a component, HTML elements, or any Razor markup. Ignored when `Items` is `null`
`Context`	`string`	`context`	Razor template context name used by `ChildContent` to refer to the current item
`KeySelector`	`Func<TItem, object>?`	`null`	Function for generating the key used in `@key`. If not set, the item itself is used
`Class`	`string?`	`null`	CSS class for the container
`Style`	`string?`	`null`	Inline CSS styles for the container
`Attributes`	`IReadOnlyDictionary<string, object>?`	`null`	Additional custom attributes that will be rendered by the component
`Id`	`string`	`Random GUID`	Unique identifier of the component. Used internally for coordination between Sortable components. Must be globally unique
`Group`	`string`	`Random GUID`	Name of the group for interacting with other Sortable components
`Pull`	`SortablePullMode?`	`null`	Mode for pulling items from this Sortable component
`PullGroups`	`string[]?`	`null`	Required when `Pull="SortablePullMode.Groups"`. Specifies the target groups into which items from this Sortable component can be dragged
`CloneFunction`	`Func<TItem, TItem>?`	`null`	Required when `Pull="SortablePullMode.Clone"`. A factory method used to create a non-null clone of the dragged item
`PullFunction`	`Predicate<SortableTransferContext<TItem>>?`	`null`	Required when `Pull="SortablePullMode.Function"`. Function to determine whether an item can be pulled to the target Sortable component. Works only when the component runs on WebAssembly.
`Put`	`SortablePutMode?`	`null`	Mode for accepting items into this Sortable component
`PutGroups`	`string[]?`	`null`	Required when `Put="SortablePutMode.Groups"`. Specifies the source groups from which this Sortable component can accept items
`PutFunction`	`Predicate<SortableTransferContext<object>>?`	`null`	Required when `Put="SortablePutMode.Function"`. Function to determine whether an item can be accepted by this Sortable component. Works only when the component runs on WebAssembly.
`ConvertFunction`	`Func<SortableTransferContext<object>, TItem?>?`	`null`	Function to convert items from another Sortable component to the target item type. Return `null` to reject the item
`Sort`	`bool`	`true`	Enables or disables sorting within this Sortable component
`Delay`	`int`	`0`	Time in milliseconds to define when sorting should start. Unfortunately, due to browser restrictions, delaying is not possible on IE or Edge with native drag and drop
`DelayOnTouchOnly`	`bool`	`false`	Whether the delay should be applied only when the user is using touch, e.g. on a mobile device. No delay will be applied in any other case
`TouchStartThreshold`	`int`	`0`	Minimum pointer movement that must occur before delayed sorting is cancelled. Values between `3` and `5` are good
`Disabled`	`bool`	`false`	Disables the Sortable component when set to true
`Animation`	`int`	`150`	Animation duration in milliseconds
`Handle`	`string?`	`null`	CSS selector for elements that can be dragged, e.g. `.my-handle`
`Filter`	`string?`	`null`	CSS selector for elements that cannot be dragged, e.g. `.ignore-elements`
`DraggableSelector`	`Predicate<TItem>?`	`null`	Function to determine whether an item can be dragged
`DraggableClass`	`string`	`"sortable-draggable"`	CSS class applied to items that can be dragged
`GhostClass`	`string`	`"sortable-ghost"`	CSS class for the placeholder during drag
`ChosenClass`	`string`	`"sortable-chosen"`	CSS class for the chosen element
`DragClass`	`string`	`"sortable-drag"`	CSS class for the dragged element
`SwapThreshold`	`double`	`1`	Percentage of the target that the swap zone will take up, as a float between `0` and `1`
`InvertSwap`	`bool`	`false`	Set to true to set the swap zone to the sides of the target, for the effect of sorting "in between" items
`InvertedSwapThreshold`	`double`	`1`	Percentage of the target that the inverted swap zone will take up, as a float between `0` and `1`
`ForceFallback`	`bool`	`true`	If set to true, the fallback for non-HTML5 browsers will be used, even if an HTML5 browser is used
`FallbackClass`	`string`	`"sortable-fallback"`	CSS class for the element in fallback mode
`FallbackOnBody`	`bool`	`false`	Appends the cloned DOM element to the document body
`FallbackTolerance`	`int`	`0`	Emulates the native drag threshold. Specify in pixels how far the mouse should move before it is considered a drag. Values between `3` and `5` are good
`Scroll`	`bool`	`true`	Enables scrolling of the container during dragging
`OnUpdate`	`Action<SortableEventArgs<TItem>>?`	`null`	Raised when the order of items is changed
`OnAdd`	`Action<SortableEventArgs<TItem>>?`	`null`	Raised when an item is accepted by the component
`OnRemove`	`Action<SortableEventArgs<TItem>>?`	`null`	Raised when an item is removed from the component

SortablePullMode

Value	Description
`True`	Allows pulling items
`False`	Prohibits pulling items
`Groups`	Allows pulling items only into specified target groups (requires `PullGroups` parameter)
`Clone`	Creates a clone of the item when dragging (requires `CloneFunction` parameter)
`Function`	Uses a custom function to determine whether items can be pulled (requires `PullFunction` parameter)

SortablePutMode

Value	Description
`True`	Allows accepting items
`False`	Prohibits accepting items
`Groups`	Allows accepting items only from specified source groups (requires `PutGroups` parameter)
`Function`	Uses a custom function to determine whether items can be accepted (requires `PutFunction` parameter)

Events

All events receive a SortableEventArgs<TItem> parameter.
Functions like PullFunction, PutFunction and ConvertFunction use a SortableTransferContext<T> parameter.

SortableEventArgs

The SortableEventArgs<TItem> class provides information about sorting operations.

Property	Type	Description
`Item`	`TItem`	The item participating in the operation
`From`	`ISortableInfo`	Source sortable component
`OldIndex`	`int`	The previous index of the item in the source sortable
`To`	`ISortableInfo`	Target sortable component
`NewIndex`	`int`	The new index of the item in the target sortable
`IsClone`	`bool`	Flag indicating whether the item is a clone

SortableTransferContext

The SortableTransferContext<TItem> class represents the context of transferring an item between sortable components.

Property	Type	Description
`Item`	`TItem`	The item being transferred between sortable components
`From`	`ISortableInfo`	The source sortable component
`To`	`ISortableInfo`	The target sortable component

ISortableInfo

The ISortableInfo interface provides information about a sortable component.

Property	Type	Description
`Id`	`string`	Unique identifier of the component
`Group`	`string`	Group name for interaction with other Sortable components

Notes

Order of events when dragging between components:
1. OnAdd is triggered first - during this event, the item is still present in the source component.
2. OnRemove is triggered after.
Events use Action<T>? instead of EventCallback<T>:
EventCallback<T> uses the component event pipeline, which calls StateHasChanged() on the receiving ComponentBase after the handler runs. This causes conflicts between the DOM and the data model for this component.
Type mismatch / failed conversion:
If item types don't match or the ConvertFunction returns null, the item is not accepted by the target component and remains in its original position.
Dragging issues on scrolled page:
If the dragged element appears misaligned when the page is scrolled, set
```
ForceFallback="false"
```
or
```
FallbackOnBody="true"
```
Server-side interactivity limitation:
PullFunction and PutFunction require synchronous JS-to-.NET calls used by SortableJS, which are only available when the component runs on WebAssembly. These options are not supported with server-side interactivity and will throw a PlatformNotSupportedException.

Note: Prerendering is supported, but these options require WebAssembly at runtime.

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- Microsoft.AspNetCore.Components.Web (>= 8.0.0)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on BlazorSortable:

Repository	Stars
ErsatzTV/legacy Open-source platform that transforms your personal media library into live, custom TV channels.	2.8K

Version	Downloads	Last Updated
7.0.0	161	5/4/2026
6.0.2	128	5/4/2026
6.0.1	420	4/29/2026
6.0.0	693	3/27/2026
5.1.7	329	12/7/2025