Tiptap 中文文档

DOCX 导出中的分页符

Available in Start planBeta

PageBreak 扩展允许用户在编辑器中插入显式分页符。与 DOCX 导出扩展结合使用时，这些分页符将包含在导出的文档中。

工作原理

  • 编辑器中的 pageBreak 节点会在 DOCX 输出中转换为 <w:br w:type="page"/>
  • 这会生成标准的 Word 分页符，并从新的一页开始
  • 无需额外配置；如果已注册 PageBreak 扩展，导出会自动工作

设置 PageBreak 与 DOCX 导出

同时注册 PageBreak 扩展和 DOCX 导出扩展。编辑器内容中的分页符将在导出时自动转换。

import { Editor } from '@tiptap/core'
import { ConvertKit } from '@tiptap-pro/extension-convert-kit'
import { ExportDocx } from '@tiptap-pro/extension-export-docx'
import { PageBreak } from '@tiptap-pro/extension-pagebreak'

const editor = new Editor({
  extensions: [
    ConvertKit,
    PageBreak,
    ExportDocx.configure({
      onCompleteExport: (result) => {
        const blob = new Blob([result], {
          type: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
        })
        const url = URL.createObjectURL(blob)
        const a = document.createElement('a')
        a.href = url
        a.download = 'export.docx'
        a.click()
        URL.revokeObjectURL(url)
      },
    }),
  ],
})

独立使用

对于自定义导出流程或服务器端使用，您可以直接使用 convertPageBreak 函数：

import { convertPageBreak } from '@tiptap-pro/extension-export-docx'

该函数将 pageBreak 节点转换为包含分页符元素的对应 DOCX 段落，可在构建自定义节点转换流程时使用。

了解更多

Previously页眉和页脚