如何在Sanity 3.41.1+Next.js14.2.3中开启文档列表拖拽排序

问题原因 #

你当前的自定义结构代码中，通过.child()覆盖了documentTypeList的默认文档视图行为，这会破坏Sanity内置的拖拽排序逻辑——默认的拖拽排序依赖列表项对sort意图的正确处理，以及文档类型本身的排序字段配置。仅返回canHandleIntent(() => true)无法针对性处理排序相关的意图，因此功能失效。

解决方案 #

1. 为文档类型配置排序字段 #

首先确保data文档类型中包含排序字段，并配置默认排序规则：

// schemas/documents/data.js
export default {
  name: 'data',
  type: 'document',
  title: '数据',
  fields: [
    // 你的其他业务字段
    {
      name: 'order',
      type: 'number',
      title: '排序顺序',
      hidden: true // 隐藏字段，由拖拽操作自动更新值
    }
  ],
  orderings: [
    {
      title: '自定义排序',
      name: 'customOrder',
      by: [{ field: 'order', direction: 'asc' }]
    }
  ]
}

2. 调整自定义结构代码 #

不要通过.child()覆盖默认文档视图，改用.views()自定义视图（如果需要），并明确处理排序意图：

import { StructureBuilder } from "sanity/structure";

export const dataStructure = (S: StructureBuilder, id: string, title: string) =>
  S.listItem({
    id,
    title,
    child: () =>
      S.documentTypeList("data")
        .title("数据列表")
        // 指定默认排序规则
        .defaultOrdering([{ field: 'order', direction: 'asc' }])
        // 明确处理排序和编辑意图
        .canHandleIntent((intentName) => intentName === 'sort' || intentName === 'edit')
        // 如果需要自定义文档视图，用views方法而不是child
        .views([S.view.form()])
  });

如果不需要自定义视图，直接去掉.views()和原有的.child()部分，documentTypeList会使用默认行为，拖拽排序自动生效。

3. 验证Structure Tool配置 #

确保在Sanity配置文件中正确引入自定义结构，且未禁用排序功能：

import { defineConfig } from 'sanity';
import { structureTool } from 'sanity/structure';
import { dataStructure } from './structures/dataStructure';

export default defineConfig({
  projectId: '你的项目ID',
  dataset: '你的数据集',
  plugins: [
    structureTool({
      structure: (S) =>
        S.list()
          .title('内容管理')
          .items([
            dataStructure(S, 'data-list', '数据列表'),
            // 其他列表项
          ])
    })
  ]
});

4. 检查用户权限 #

确认当前登录用户拥有修改data文档order字段的权限，否则拖拽排序后的结果无法保存。

内容的提问来源于stack exchange，提问作者Krunal T.