DOCXKIT_HEADER_FOOTER_INVALID_CONTENT: Invalid header or footer output

A header/footer plugin returned an element other than a Paragraph or Table.

What to do

1. Return Paragraph or Table instances for header and footer content.
2. Wrap inline runs inside a Paragraph.

Problem example

import { TextRun } from 'docx'

// Invalid output from a plugin used in a header/footer:
const render = () => new TextRun('Header')

Corrected example

import { Paragraph, TextRun } from 'docx'

// Valid output from a plugin used in a header/footer:
const render = () => new Paragraph({ children: [new TextRun('Header')] })

Common causes

• A plugin returned a bare TextRun or another unsupported child element.

Diagnostic fields

• code: HEADER_FOOTER_INVALID_CONTENT
• diagnosticCode: DOCXKIT_HEADER_FOOTER_INVALID_CONTENT
• name: DocxKitError
• docs: https://docx-kit.ntnyq.dev/errors/docxkit_header_footer_invalid_content/

Example message

Header and footer plugins must render paragraphs or tables

Source and related guides

• Source
• Related guide
• Catching errors
• All error codes