Document

The Document object is the starting point of your .docx journey, this is the literal Word Document. You add all your content such as Paragraphs to this Document, and at the end export it however you like.

To create a new document, it is very easy:

const doc = new docx.Document();

Document properties

You can add properties to the Word document by specifying options, for example:

const doc = new docx.Document({
    creator: "Dolan Miu",
    description: "My extremely interesting document",
    title: "My Document",
});

Full list of options:

Change background color of Document

Set the hex value in the document like so:

const doc = new docx.Document({
    background: {
        color: "C45911",
    },
});

Instead of a fixed hex color, you can reference a theme color, optionally darkened or lightened:

You can mix and match whatever properties you want, or provide no properties.

Features

The features option toggles document-wide behaviors:

• trackRevisions — opens the document with the 'Track Changes' feature enabled, so any edits made in Word are recorded as revisions.
• updateFields — instructs Word to update all fields when the document is opened. This is required for a Table of Contents to be populated, since fields are calculated by the word processor rather than at export time. Word will show a prompt asking the user to allow the update.

const doc = new docx.Document({
    features: {
        updateFields: true,
    },
    sections: [],
});

Hyphenation

The hyphenation option controls automatic hyphenation across the document:

const doc = new docx.Document({
    hyphenation: {
        autoHyphenation: true,
        consecutiveHyphenLimit: 2,
        doNotHyphenateCaps: true,
    },
    sections: [],
});

Units for positioning

Various parts of the API require positioning arguments. The units are "20ths of a point" from the OOXML specification. See Lars Corneliussen's blog post for more information and how to convert units.

Compatibility

Compatibility Settings are optional settings used to preserve visual fidelity of documents created in earlier word processing applications. Some of these settings provide ability for specific behaviors, described in detail below; and others simply instruct applications to mimic the behavior of an existing word processing application.

const doc = new docx.Document({
    compatibility: {
        version: 15,
        doNotExpandShiftReturn: true,
    },
});

Compatibility Options