docx-js/docs/usage/headers-and-footers.md

Headers and Footers

Example

Creating Headers and footers is simple. Access the Header and Footer by doing so like this:

doc.Header;
doc.Footer;

You can call the same methods as you would with a File:

doc.Header.createParagraph("Header text");
doc.Footer.createParagraph("Footer text");

Even add images:

doc.Header.createImage([BUFFER_OF_YOUR_IMAGE]);
doc.Footer.createImage([BUFFER_OF_YOUR_IMAGE]);

Refer to demo8.ts for more information.

Multiple Headers and Footers

Also all the supported section properties are implemented according to: http://officeopenxml.com/WPsection.php

Example

    const header = this.document.createHeader();
    const footer = this.document.createFooter();

    // Add new section with another header and footer
    doc.addSection({
      headers: {
        default: header
      },
      footers: {
        default: footer
      },
      pageNumberStart: 1,
      pageNumberFormatType: docx.PageNumberFormat.DECIMAL,
    });