This is a Deno module for making .docx documents from scratch or from
an existing .docx or .dotx template.
You could use docxml to:
- Create an MS Word file without ever opening MS Word
- Create a parameterized template file and render it to
.docxwith your data parameters - Write JSON, XML or other data structures to
.docx - Parse content from an existing
.docxfile - Extract style information from a
.docxor.dotxfile
This documentation for this lib is available at various locations:
👉 Documentation site
👉 GitHub source
👉 Deno mirror
👉 npm mirror
docxml can be used in Deno using import * from 'jsr:@fontoxml/docxml' or using an import map.
// Deno without an import map
import Docxml, { Paragraph } from 'jsr:@fontoxml/docxml';docxml is designed to be used in vanilla JavaScript using class component instances, or using JSX if you're on Deno:
const para = new Paragraph(
{ alignment: 'center' },
new Text({}, 'I want a cookie')
);/** @jsx Docx.jsx */
const para = (
<Paragraph alignment="center">
<Text>I want a cookie</Text>
</Paragraph>
);docxml is also designed to be used from scratch/entirely programmatically, or using a more ergonomic API
to transform from an XML document. Both modes work equally well with vanilla JS or JSX.
await Docx.fromJsx(
<Paragraph alignment="center">
<Text>I want a cookie</Text>
</Paragraph>
).toFile('example-1.docx');await Docx.fromNothing()
.withXmlRule('self::text()', ({ node }) => <Text>{node.nodeValue}</Text>)
.withXmlRule('self::p', ({ traverse, node }) => (
<Paragraph alignment={node.getAttribute('align')}>
{traverse()}
</Paragraph>
))
.withXml(`<p align="center">I want a cookie</p>`, {})
.toFile('example-2.docx');To great or small extent, the following features work in the current version of docxml. Some items are not ticked off
yet -- they are not available, but hopefully soon.
👉 See code examples of some or the more intricate features
API features:
- 100% typed
- Asynchronous components
- Component composition
Custom styles:
- Font size and color
- Bold, italic, underline styles, strike-through
- Subscript, superscript, small caps
- Paragraph spacing and indentation
- Left/right/center/justified alignment
- Nu 793B mbering
- Aligning text on tabs
- Font family
- Embed TTF in the DOCX file
References:
- Cross references
- Table of contents
Tables:
- Colspans and rowspans
- Cell borders
- Table borders
- Conditional formatting
Images:
- From any
UInt8Arraysource - Alternative and title text
- Width and height
Sections:
- Width and height
- Orientation
- Page headers & footers
Comments:
- Point comment
- Range comment
- Comment reply
Change tracking:
- Text additions and deletions
- Style changes
- Table row additions and deletions
Obviously docxml is a TypeScript project, which is already very different from how you would normally interact with a .docx file. More meaningfully however, docxml is meant to make writing Word document files easier than going straight to OOXML. For example:
- All sizes are of type
Length, which means it doesn't matter wether you input them as points, centimeters, inches, 1/2, 1/8th or 1/20th points, English Metric Units, and so on. - The JSX pragma will try to correct components that would lead to invalid XML structures, by splitting the parents of invalidly placed components recursively until the new position is valid. Moreover, string content in unexpected places is automatically wrapped in
<Text>when using JSX. This makes the configuration of a new DOCX a little more forgiving. - Using the
<Image>or<Comment>components will automatically create all required relationships etc. - Some of the words have changed, generally speaking
docxmlis more verbose than the DOCX verbiage. - Generally speaking
docxmlprefers formal (JS) references over references-by-identifier. In those cases the identifiers are randomly generated for you when the.docxfile is written. - Especially in tables and images, a lot of formatting details are automatically applied. In a lot of cases there is no API yet to change them.
This project uses unit tests and linting for quality control. To lint, both Deno's own linting as well as ESLint are used. Please run both of the following commands to ensure that a GitHub Action does not fail later.
# Once
npm install
# Run all unit tests
deno task test
# Run all linting
deno task lint