docxml

library5.15.1jsnpmunverified

docxml is a TypeScript library for building and parsing .docx files (OXML format) from scratch or from templates. The current stable version is 5.15.1, released actively with several updates per year. Key differentiators include support for both Node.js and Deno, JSX syntax for declarative document composition, template rendering with parameterized DOTX files, and coverage of features like tables, images, headers/footers, change tracking, comments, and reference fields. It provides a fully typed API and supports both programmatic and XML-driven document creation.

serialization

npm install docxml

github ↗package ↗

INSTALL

IMPORT

SIG · DOCXML

docxml

serializationjavascriptv5.15.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Docx

✓ import Docx from 'docxml'

✗ const Docx = require('docxml')

Default export; in Node.js CJS requires destructuring: const { default: Docx } = require('docxml')

Paragraph

✓ import { Paragraph } from 'docxml'

✗ const Paragraph = require('docxml/Paragraph')

Named export; available from the main package

Text

✓ import { Text } from 'docxml'

Named export for text content

Docx

✓ import { default as Docx } from 'docxml'

✗ import Docx from 'docxml/src/index.ts'

For Deno, import from 'https://deno.land/x/docxml/mod.ts' or via import map

Creates a simple DOCX file with a centered paragraph and saves it to disk.

import Docx, { Paragraph, Text } from 'docxml'; async function main() { const doc = await Docx.fromJsx( <Paragraph alignment="center"> <Text>Hello World</Text> </Paragraph> ); await doc.toFile('hello.docx'); } main().catch(console.error);

Debug

Known issues

breakingIn v5.0.0, the API changed from object-based to async component-based. Old `docx` create function removed.

fix

Use `Docx.fromJsx()` or `Docx.fromNothing()` to create documents.

affects: >=5.0.0

deprecatedThe `Document` class is deprecated in favor of `Docx` namespace.

fix

Replace `new Document()` with `Docx.fromJsx()` or `Docx.fromNothing()`.

affects: >=5.0.0

gotchaJSX requires a transpiler (e.g., Babel or TypeScript) and the `/** @jsx Docx.jsx */` pragma or equivalent configuration.

fix

Add `/** @jsx Docx.jsx */` at the top of JSX files, or configure your transpiler to use `Docx.jsx` as the JSX factory.

affects: >=5.0.0

gotchaIn Node.js CommonJS, the default import must be destructured as `const { default: Docx } = require('docxml')` because the package exports ESM first.

fix

Use `const { default: Docx } = require('docxml')` or switch to ESM imports.

affects: >=5.0.0

gotchaSaving a file with `toFile()` may fail if the output directory doesn't exist. The library does not create directories automatically.

fix

Ensure the output directory exists before calling `toFile()`, or use `toBuffer()` and write the buffer yourself.

affects: >=1.0.0

Errors

Common errors & fixes

Error: self-referencing import map not allowed

Using a Deno import map that references the package itself incorrectly.

fix

Use the correct import map URL (e.g., from deno.land/x/docxml) or an npm specifier if using Node.

TypeError: Docx.fromJsx is not a function

Using CommonJS `require('docxml')` without destructuring the default export.

fix

Use `const { default: Docx } = require('docxml')` or switch to ESM imports.

ReferenceError: React is not defined

Using JSX without the correct JSX pragma (e.g., `/** @jsx Docx.jsx */`).

fix

Add `/** @jsx Docx.jsx */` at the top of the JSX file, or configure your transpiler to use `Docx.jsx`.

Error: DOCX file not saved: ENOENT: no such file or directory, open '...'

Output directory does not exist.

fix

Create the directory before calling `toFile()`, or use `toBuffer()` and write manually after ensuring the path exists.

Upgrade

Version history

5.15.1latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

8 hits · last 30 days

node

Resources

githubhttps://github.com/wvbe/docxml ↗

packagehttps://www.npmjs.com/package/docxml ↗