Tiptap 中文文档

使用页眉和页脚扩展您的 DOC 导出功能

Available in Start planBetav0.3.0

Consider Using DOCX Instead

The DOC format is the traditional format for Microsoft Word 97-2003. For modern use, we recommend exporting as DOCX. Use DOC only when compatibility with older systems is required.

The @tiptap-pro/extension-export-doc extension natively supports customizing headers and footers when exporting documents. You can configure different headers and footers for the first page, odd pages, and even pages.

Header Configuration

The headers object allows you to customize the exported DOC document headers:

PropertyTypeDescription
evenAndOddHeadersbooleanWhether to use different headers for odd and even pages
differentFirstPagebooleanWhether the first page uses a different header. When true, the first page uses the first value instead of default.
defaultstringDefault header, applied to all pages or odd pages when evenAndOddHeaders is enabled. Supports plain text strings or serialized Tiptap JSONContent for rich formatting.
firststringHeader for the first page, effective only if differentFirstPage is true. Supports plain text strings or serialized Tiptap JSONContent.
evenstringHeader for even pages when evenAndOddHeaders is enabled. Supports plain text strings or serialized Tiptap JSONContent.

Plain text generates simple, unstyled headers. Using serialized Tiptap JSONContent (via JSON.stringify()) preserves rich formatting like bold, italic, and links.

The footers object allows you to customize the exported DOC document footers:

PropertyTypeDescription
evenAndOddFootersbooleanWhether to use different footers for odd and even pages
differentFirstPagebooleanWhether the first page uses a different footer. When true, the first page uses the first value instead of default.
defaultstringDefault footer, applied to all pages or odd pages when evenAndOddFooters is enabled. Supports plain text strings or serialized Tiptap JSONContent.
firststringFooter for the first page, effective only if differentFirstPage is true. Supports plain text strings or serialized Tiptap JSONContent.
evenstringFooter for even pages when evenAndOddFooters is enabled. Supports plain text strings or serialized Tiptap JSONContent.

Plain text generates simple, unstyled footers. Using serialized Tiptap JSONContent (via JSON.stringify()) preserves rich formatting like bold, italic, and links.

Complete Example 

import { ExportDoc } from '@tiptap-pro/extension-export-doc'

const editor = new Editor({
  extensions: [
    // other extensions...
    ExportDoc.configure({
      token: 'YOUR_TOKEN',
      appId: 'YOUR_APP_ID',
      headers: {
        evenAndOddHeaders: true,
        default: 'My Document - Confidential',
        first: 'Welcome to My Document',
        even: 'My Document - Even Pages',
      },
      footers: {
        evenAndOddFooters: true,
        default: 'Company Name - All Rights Reserved',
        first: 'Draft Version 1.0',
        even: 'Company Name - Even Page Footer',
      },
    }),
    // other extensions...
  ],
})

// Export with headers and footers
editor
  .chain()
  .exportDoc({
    onCompleteExport(result) {
      const url = URL.createObjectURL(result)
      const a = document.createElement('a')

      a.href = url
      a.download = 'document-with-headers.doc'
      a.click()

      URL.revokeObjectURL(url)
    },
  })
  .run()

Simple Headers and Footers

If you don't need different headers for odd and even pages, you can just provide a default value:

ExportDoc.configure({
  token: 'YOUR_TOKEN',
  appId: 'YOUR_APP_ID',
  headers: {
    default: 'My Document Title',
  },
  footers: {
    default: 'Footer - Company Name',
  },
})