为 DOCX 导出自定义有序列表编号

import { Editor } from '@tiptap/core'
import { ConvertKit, type NumberingFormatDefinition } from '@tiptap-pro/extension-convert-kit'
import { ExportDocx, LevelFormat } from '@tiptap-pro/extension-export-docx'

// 1. 定义你的注册表：单一事实来源，供下面两侧共用。
const MY_FORMATS: NumberingFormatDefinition[] = [
  {
    id: 'decimal-paren',
    levels: [
      { baseStyle: LevelFormat.DECIMAL, textTemplate: '%1)' },
      { baseStyle: LevelFormat.LOWER_LETTER, textTemplate: '%2)' },
      { baseStyle: LevelFormat.LOWER_ROMAN, textTemplate: '%3)' },
    ],
  },
  {
    id: 'outline',
    levels: [
      { baseStyle: LevelFormat.DECIMAL, textTemplate: '%1.' },
      { baseStyle: LevelFormat.DECIMAL, textTemplate: '%1.%2.' },
      { baseStyle: LevelFormat.DECIMAL, textTemplate: '%1.%2.%3.' },
    ],
  },
]

// 2. 通过 ConvertKit 选择启用。传入 `formats` 会生成编辑器预览 CSS，
//    并自动注入；同时用相同的注册表注册 ExportDocx，以便
//    .docx 包含匹配的定义。
const editor = new Editor({
  extensions: [
    ConvertKit.configure({
      // 默认关闭，因此不使用自定义编号的使用者可以保持干净的
      // orderedList schema。传入一个选项对象（或 `true`）即可启用。
      orderedListNumbering: { formats: MY_FORMATS },
    }),
    ExportDocx.configure({
      numberingFormats: MY_FORMATS,
      onCompleteExport: (blob) => {
        /* 下载 blob */
      },
    }),
  ],
})

// 3. 在当前选区以所选格式开始一个编号列表
//    （或者，当已经在列表中时，使用 setOrderedListNumberingFormat 更改其格式）。
editor.chain().focus().toggleOrderedListWithFormat('outline').run()

ConvertKit.configure({ orderedListNumbering: true })

ConvertKit.configure({
  orderedListNumbering: {
    // 新建有序列表时开始使用的格式 id。默认为 `null`（普通的 `1. 2. 3.`）。
    defaultFormat: 'outline',
    // 传给 ExportDocx 的相同定义。提供后，
    // 会据此生成并自动注入编辑器预览 CSS，
    // 因此屏幕上的标记会与导出结果一致，无需额外接线。
    formats: MY_FORMATS,
  },
})

editor.chain().focus().setOrderedListNumberingFormat('decimal-paren').run()
editor.chain().focus().setOrderedListNumberingFormat(null).run()

// 从段落开始：创建一个有序列表并设置其格式。
editor.chain().focus().toggleOrderedListWithFormat('outline').run()

// 省略格式可按配置的 `defaultFormat` 开始列表。
editor.chain().focus().toggleOrderedListWithFormat().run()

const activeFormatId = editor.storage.orderedListNumbering.activeNumberingFormat
// 一个格式 id，或者在选区不在有序列表中时为 `null`

interface NumberingFormatDefinition {
  id: string
  levels: NumberingLevelDefinition[]
}

interface NumberingLevelDefinition {
  baseStyle: NumberingBaseStyle
  textTemplate: string
  startAt?: number
  alignment?: 'left' | 'center' | 'right'
  numberIndent?: number | string
  textIndent?: number | string
  markerFont?: NumberingMarkerFont
}

interface NumberingMarkerFont {
  font?: string | { name: string }
  size?: number | string
  bold?: boolean
  italics?: boolean
  color?: string
  underline?: unknown
}

generateNumberingFormatCss(formats, {
  scope: '.tiptap.ProseMirror', // 默认
  maxDepth: 9, // 默认
})