Sortable List

使用指针或键盘重排列表,并提供撤销操作。

适用场景

  • 当界面需要以下行为时使用 Sortable List:使用指针或键盘重排列表,并提供撤销操作。

安装

选择安装方式,用法示例将同步更新导入路径。

$ bunx --bun shadcn-vue@2.8.2 add https://orvui.efu.me/r/sortable-stack.json

首次使用时,将安装的 src/components/orvui/styles.css 导入项目样式入口。

示例

预览

In the studio

Make room for what matters.

04 tasks

Drag a handle to reorder. Use Up and Down to move, Home and End to move to the edges.

  • Collect references

    Find the right direction

    01
  • Explore the visual system

    Type, color, and composition

    02
  • Build the first prototype

    Make the interaction tangible

    03
  • Ship something useful

    Polish the details and release

    04

状态与事件

需要由表单、路由或父组件管理时,绑定下列状态并接收对应更新。v-model 是属性与 update 事件的简写;值的类型应与 API 一致。

组件状态绑定
组件Vue 绑定更新事件
SortableListv-modelany[]update:modelValue
SortableListv-model:itemsany[]update:items

可选受控属性未传入时,按组件文档的默认行为工作;不要用固定的 false 或空值代替未传入。异步请求和持久化在应用中处理,再把结果传回组件。

API 参考

SortableList

modelValue?
any[]
—
items?
any[]
model.value
defaultItems?
any[]
() => []
getItemLabel?
(item: any) => string
—
label?
string
"Sortable items"
disabled?
boolean
false
showUndo?
boolean
true
itemClassName?
string
—

事件

update:modelValue
—
@update:modelValue
update:items
—
@update:items
itemsChange
—
@itemsChange
change
—
@change

插槽

default
—

作用域参数: items, move-item, undo

#default
item
—

作用域参数: item, index

#item

SortableListGroup

插槽

default
() => VNodeChild
#default

SortableListItem

id
string
—
label?
string
—

插槽

default
() => VNodeChild
#default

SortableListHandle

disabled?
boolean
false

插槽

default
() => VNodeChild
#default

SortableListItemContent

插槽

default
() => VNodeChild
#default

SortableListUndo

disabled?
boolean
false

插槽

default
() => VNodeChild
#default

无障碍

为交互控件提供明确的无障碍名称。保留文档中的键盘路径、可见焦点与减少动态效果状态;自定义插槽应继续保留所替代部件的语义。

常见问题

如何配置 Sortable List?
通过 modelValue、items、defaultItems、getItemLabel、label、disabled、showUndo、itemClassName 配置 Sortable List;API 表列出其类型与默认值。
如何连接到应用状态?
监听 update:modelValue、update:items、itemsChange、change,将组件连接到应用状态。
可以在服务端渲染吗?
可以在 Vue SSR 应用中正常渲染。服务端与客户端的初始 props 应保持一致;浏览器测量与交互资源在挂载后启动。

更新于