Angular 可排序列表与拖放 | ng-hub-ui-sortable

概览

团队为何搜索这个库

当你需要可配合数组、响应式表单、Signals 和复杂界面构建器的拖放排序时，请选择这个 Angular 可排序库。

安装

npm install ng-hub-ui-sortable

跳转到

适用于

任务排序
FormArray 编辑器
布局构建器
优先级管理

关于 sortable

ng-hub-ui-sortable 帮助 Angular 团队在顺序至关重要的产品中自然地重排数据：任务、优先级、布局构建器或动态表单块。当你需要拖放又不想失去对状态更新的控制时，它尤其有用。

功能指南

核心用法

sortable 列表的基本使用场景。

示例:

简单数组

重新排序普通数组。

Button groups

Cards

Ankara

Ankara description

Moscow

Moscow description

Munich

Munich description

Paris

Paris description

Washington

Washington description

Navigation

Current model

[
  "Ankara",
  "Moscow",
  "Munich",
  "Paris",
  "Washington"
]

代码

Signals

将 sortable 数据绑定到 Angular 的可写 signals。

Angularv18
Reactv19
Vuev3
Sveltev5

Current signal value:

[
  "Angular",
  "React",
  "Vue",
  "Svelte"
]

代码

表单集成

将 sortable 与 Angular 响应式表单结合使用。

示例:

FormArray 集成

通过拖放重新排序 FormArray 控件。

Current FormArray value:

[
  "Ankara",
  "Moscow",
  "Munich",
  "Paris",
  "Washington"
]

代码

高级配置

自定义 SortableJS 的行为和交互。

示例:

自定义选项

配置 handles、过滤器、动画和事件。

Filtered (disabled) items

Element 1
Element 2
Element 3
Element 4
Element 5

[
  "1",
  "2",
  "3",
  "4",
  "5"
]

Events

Updated 0 times

Element 1
Element 2
Element 3
Element 4
Element 5

Autoscroll

Drag near the edges of the list to trigger autoscroll.

Element 1
Element 2
Element 3
Element 4
Element 5
Element 6
Element 7
Element 8
Element 9
Element 10
Element 11
Element 12
Element 13
Element 14
Element 15
Element 16
Element 17
Element 18
Element 19
Element 20
Element 21
Element 22
Element 23
Element 24
Element 25
Element 26
Element 27
Element 28
Element 29
Element 30

代码

多个列表

连接列表、克隆项目并控制转移规则。

Transfer between lists

Element 1
Element 2
Element 3
Element 4
Element 5

[
  "1",
  "2",
  "3",
  "4",
  "5"
]

Element 6
Element 7
Element 8
Element 9
Element 10

[
  "6",
  "7",
  "8",
  "9",
  "10"
]

Clone items

List 1 is a clone factory; list 2 is its target.

Element 1
Element 2
Element 3
Element 4
Element 5

Element 6
Element 7
Element 8
Element 9
Element 10

Constrained groups

1. Cannot accept items

Element 1
Element 2
Element 3
Element 4
Element 5

2. Normal list

Element 6
Element 7
Element 8
Element 9
Element 10

3. Clones children

Element 11
Element 12

4. Only #1 can drop here

Element 13

代码

布局构建器

带有 tabs 和 widgets 的嵌套 sortable 容器。

Build advanced visual layout builders with nested drag and drop in Angular. This powerful example demonstrates nested sortable lists with drag handles and component slots, perfect for creating page builders and dashboard designers.

Create hierarchical structures with drag-and-drop functionality—ideal for layout builders, dashboard organizers, and visual editors. Supports multi-level nesting with full control over handles and constraints.

Demo: Generic, Tabs & Widgets

Generic A

Widget 1

Widget 2

Tabs Container

Tab 1

Tab 2

Generic B

Widget 3

Generic C

Generic D

Widget 4

Generic E

Move log

No events yet.

代码

手动模式

使用 `autoUpdateArray=false` 禁用自动更新，并通过 `moveItemInArray`、`transferArrayItem` 和 `copyArrayItem` 辅助函数自行应用更改。

Manual Control Mode

This example demonstrates manual array control by setting [autoUpdateArray]="false". This gives you complete control over when and how arrays are updated, similar to Angular CDK's approach.

Benefits: Perform validation, make API calls, implement undo/redo, or use immutable patterns before updating your data.

Single List - Manual Reordering

Drag and drop tasks to reorder them. Notice how we manually update the array using the moveItemInArray helper function.

Task List

Design UI mockups
Implement authentication
Write unit tests
Deploy to production

Current State:

[
  {
    "id": 1,
    "title": "Design UI mockups",
    "completed": false
  },
  {
    "id": 2,
    "title": "Implement authentication",
    "completed": false
  },
  {
    "id": 3,
    "title": "Write unit tests",
    "completed": false
  },
  {
    "id": 4,
    "title": "Deploy to production",
    "completed": false
  }
]

Multiple Lists - Kanban Board Style

Drag tasks between different status columns. The transferArrayItem helper makes it easy to move items between arrays while maintaining full control.

To Do 3

Review pull requests
Priority: high
Update documentation
Priority: medium
Refactor legacy code
Priority: low

In Progress 2

Fix bug #123
Priority: high
Add new feature
Priority: medium

Done 1

Initial setup
Priority: high

Operations Log

No operations yet. Start dragging items to see the log!

Code Example

Component Handler

import { moveItemInArray, transferArrayItem } from 'ng-hub-ui-sortable';

onTasksUpdate(event: SortableEvent): void {
  // Manually update the array with full control
  moveItemInArray(this.tasks, event.oldIndex, event.newIndex);
  
  // You can add validation, API calls, etc. here
  console.log('Task reordered!');
}

onListAdd(event: SortableEvent, targetList: any[], listName: string): void {
  const sourceList = this.getListByElement(event.from);
  
  // Transfer item between arrays
  transferArrayItem(sourceList, targetList, event.oldIndex, event.newIndex);
  
  // Perfect place for API calls to persist the change
  this.apiService.updateTaskStatus(item.id, listName);
}

Why Use Manual Control?

Validation

Validate changes before updating your data model. Prevent invalid operations or apply business rules.

API Integration

Make API calls to persist changes immediately. Handle success/error responses appropriately.

Undo/Redo

Implement undo/redo functionality by maintaining operation history before committing changes.

Immutability

Use immutable data patterns with OnPush change detection for optimal performance.

代码

核心特性

最近更改

Version 22.2.1 - 9/16/26, 12:00 AM

changed: Repository, issue and README links follow the move to the hub-env organization. Issues for every Hub UI package are now gathered in hub-env/hub-ui, and the repository and bugs fields of the manifest point at the new addresses. No code, types or styles change.

fixed: The migration guide and both READMEs placed the point where ngx-sortablejs stops compiling at Angular 13. Angular kept converting View Engine libraries with ngcc up to v15, so the real limit is Angular 16, and the guide now opens with the two paths: the maintained @worktile/ngx-sortablejs fork, or this package.

Version 22.2.0 - 9/8/26, 12:00 AM

added: The list can be reordered from the keyboard. SortableJS binds mousedown and touchstart and nothing else, so until now hubSortable simply did not work for anyone who does not drag. Each item, or its handle when one is configured, is now a tab stop, and from there the interaction is the grab / move / drop model of the WAI-ARIA authoring practices: Enter or Space picks the item up, the arrows move it, Home and End send it to either end, Enter or Space drops it and Escape puts it back. Every step is announced through a polite live region. Reordering this way obeys the same rules a drag does: off while disabled is true or sort is false, honouring autoUpdateArray, and emitting the same update and sortEvent with both indexes filled in.

added: keyboardSorting turns that path off for an application that already ships its own, and keyboardMessages translates what is announced. The sentences are functions rather than templates with placeholders, so a language whose word order differs is not forced through an English shape.

added: SortableBindings and SortableBinding are exported. SortableBindings keeps several parallel arrays in step through one drag, and [hubSortable] has always accepted an instance in place of an array, but it was never listed in public-api.ts: nobody outside the package could construct one or type a field holding one. Both READMEs gained the connected-lists section that explains what to do with it.

changed: BREAKING. SortableData is a list type instead of any. It was written any | any[] | WritableSignal<any[]>, and a union containing any is any, so the published type accepted a number, a string or a plain object without a word from the compiler. It is now T[] | WritableSignal<T[]> | SortableFormArrayLike<T>, with T defaulting to unknown. Nothing changes at runtime; see BREAKING_CHANGES.md for what stops compiling and what to write instead.

Version 22.1.4 - 9/6/26, 12:00 AM

changed: The library no longer writes into the consuming application's console. Eight guard rails, the out-of-range check in moveItemInArray, the three in transferArrayItem, the three in copyArrayItem and the directive's container lookup, used to report invalid input with console.warn or console.error. A dependency has no standing to put noise in an application's console, least of all in a production build, and the message was addressed to whoever wrote the call rather than to whoever runs the app. Every guard keeps the behaviour it always had: the call is a no-op and the arrays are left untouched. A container selector that matches nothing likewise leaves the directive inert, now without a message, so audit those selectors (see MIGRATION.md, 5.6) instead of waiting for the console to point at them.

fixed: The directive's JSDoc examples teach the @for block rather than *ngFor. Those snippets ship in the published typings, so they are what a consumer's editor shows on hover over hubSortable, and they contradicted the README's Quick Start, leaving the reader to work out which surface of the same library to believe. Each @for sits on the line that opens the host element on purpose, because TypeScript reads a line-initial @for inside a JSDoc comment as a tag and splits the example in two.

Version 22.1.3 - 9/1/26, 12:00 AM

changed: The homepage in the manifest points at this library's own documentation page rather than at the site root, and eleven keywords were added covering the vocabulary someone actually searches with when they do not already know this package's name: dnd, drag-drop, reorder, reorderable, sortable-list, list, formarray, component, reusable, ui-library. Metadata only — no code, no types, no styles change, and nothing a consumer imports is affected.

Version 22.1.2 - 8/8/26, 12:00 AM

fixed: Documentation links now point at the canonical localized URLs. The README linked to https://hubui.dev/<path> with no locale prefix and no trailing slash, and both forms are 301-redirected, so every reader arriving from npm or GitHub landed on a redirect instead of the canonical page.

Version 22.1.1 - 7/28/26, 12:00 AM

added: Documented the pointer-only accessibility limitation of SortableJS drag-and-drop and the recommended keyboard alternative (move up/down controls on the same array).

Version 22.1.0 - 6/29/26, 12:00 AM

added: `provideSortable()` standalone provider function to register global SortableJS options without `SortableModule`.

added: Public type exports for the directive payloads (`SortableData`, `SortableEventName`, `SortableMoveEventPayload`).

deprecated: `SortableModule` and `SortableModule.forRoot()` — import the standalone `SortableDirective` and use `provideSortable()` instead.

changed: Aligned package scaffolding and documentation with the rest of the ng-hub-ui ecosystem.

Version 22.0.0 - 6/17/26, 12:00 AM

changed: Rebranded the package and standardized its metadata and README to match the ng-hub-ui family. The version was cut in the repository but never published to npm: the registry goes straight from 21.3.0 to 22.1.0, which is where the rebranding reached consumers.

Version 21.3.0 - 3/31/26, 12:00 AM

added: Improved binding support for writable signals and FormArrays, plus comprehensive test coverage for the directive.

Version 21.2.0 - 2/10/26, 12:00 AM

added: The SortableJS types are re-exported from the library root — `Sortable`, `SortableEvent`, `Options`, `MoveEvent`, `GroupOptions`, `PullResult` and `PutResult` — so typing a handler no longer means importing from two packages.

changed: `sortablejs` moved from peer dependencies to dependencies, so it installs with this package instead of being one more thing to remember.

Version 21.1.1 - 2/10/26, 12:00 AM

fixed: `update` and `add` emit once per drop in manual mode. SortableJS calls its own handlers more than once when the DOM is rearranged inside them, and those extra emissions used to reach the consumer.

fixed: The DOM and the bound array no longer disagree in manual mode: the directive reverts SortableJS's move so Angular renders from the array it was actually given.

fixed: Native SortableJS CustomEvents are suppressed at the container, so a template listener no longer fires twice for a single drop.

Version 21.1.0 - 2/9/26, 12:00 AM

added: Manual control mode via the `autoUpdateArray` input (default `true`); set it to `false` and the directive stops mutating the bound array and only reports what happened, which is what validation, persistence, undo and immutable state all need.

added: Array helper functions `moveItemInArray`, `transferArrayItem` and `copyArrayItem`, so manual mode does not mean rewriting index arithmetic in every application.

added: An events guide and a manual-control example covering a single list and a Kanban board.

Version 21.0.1 - 12/12/25, 12:00 AM

added: A README inside the package. The npm page had been blank since the first release.

Version 21.0.0 - 12/12/25, 12:00 AM

added: Writable signal support in the sortable bindings, alongside arrays and FormArrays, with hardened detection so neither shape trips TypeScript.

Version 20.0.0 - 12/10/25, 12:00 AM

added: First version published as `ng-hub-ui-sortable`, with the groundwork for Angular 20 compatibility. Everything the registry serves under this name starts here.

常见问题

如何让 Angular 里的列表支持拖拽排序？

安装 ng-hub-ui-sortable，在容器元素上加 [hubSortable] 并绑定列表背后的数组。拖动条目会就地重排该数组，模板自然跟着更新，不需要你写任何事件处理。同一个输入也接受 WritableSignal 或 FormArray，各自通过自己的 API 重排。

可以在两个列表之间拖动条目吗？

可以。给两个容器设置相同的 group 名称，通过 [group] 输入或完整的 SortableJS 选项对象都行，条目就会从一个数组转到另一个。add 与 remove 输出会告诉你条目离开了哪个列表、又被哪个列表接收，两者都带 oldIndex 和 newIndex。

排序支持键盘操作吗？

支持，而且默认开启。回车或空格抓起当前获得焦点的条目，方向键移动它，Home 与 End 送到首尾，Esc 取消，每一步都会在指令自己维护的 aria-live 区域里播报。SortableJS 本身只监听 mousedown 和 touchstart，所以这部分是加在它之上的；[keyboardSorting]="false" 可以关掉。

它和 Angular CDK 的拖放有什么不同？

它封装的是 SortableJS 而不是 CDK：没有 cdkDropList 与 cdkDrag 这一对，容器上一个属性就是全部配置，绑定的数组由它替你更新。它也不附带 CSS，拖动中的样式来自你通过 ghostClass、chosenClass 和 dragClass 传入的类名。如果更想要 CDK 那种显式写法，设置 [autoUpdateArray]="false"，用导出的 moveItemInArray、transferArrayItem 和 copyArrayItem 自己重排。

概览