Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wvbe/docxml

TypeScript (component) library for building and parsing a DOCX file
https://github.com/wvbe/docxml

deno docx ooxml typescript word

Last synced: 5 days ago
JSON representation

TypeScript (component) library for building and parsing a DOCX file

Awesome Lists containing this project

README 

        
# DOCX Markup Language



This is a [NodeJS](https://nodejs.org/)/[Deno](https://deno.land) module for making `.docx` files from scratch or from

an existing DOCX/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 DOCX with your data parameters

- Convert JSON, XML or other data structures to DOCX

- Parse content from an existing DOCX file

- Extract style definitions from a DOTX/DOCX file



This documentation for this lib is available at various locations:



[👉 Documentation site](https://wvbe.github.io/docxml)


[👉 GitHub source](http://github.com/wvbe/docxml)


[👉 Deno mirror](http://deno.land/x/docxml)


[👉 npm mirror](http://npmjs.org/package/docxml)



#### For Deno or for NodeJS



[👉 Main article](./docs/setup/deno-or-node.md)



`docxml` can be used in [NodeJS](https://nodejs.org/) and [Deno](https://deno.land) according to the traditions in those

ecosystems. For Node users, simply `npm install docxml` and then `require()` or `import` as you wish. For Deno users,

`import "deno.land/x/docxml/mod.ts"` or use an import map if you wish.



```js

// NodeJS using CommonJS:

const { default: Docxml, Paragraph } = require('docxml');



// NodeJS using ES6 modules, or Deno with an import map

import Docxml, { Paragraph } from 'docxml';



// Deno without an import map

import Docxml, { Paragraph } from 'https://deno.land/x/docxml/mod.ts';

```



#### For JSX or for vanilla



[👉 Main article](./docs/setup/jsx-or-not.md)



`docxml` is designed to be used in vanilla JavaScript using class component instances, or using JSX if you're on Deno or

want to use NodeJS and a transpiler like Babel:



```ts

const para = new Paragraph({ alignment: 'center' }, new Text({}, 'I want a cookie'));

```



```ts

/** @jsx Docx.jsx */

const para = (

	

		I want a cookie

	

);

```



#### For XML or for anything



`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.



```ts

await Docx.fromJsx(

	

		I want a cookie

	,

).toFile('example-1.docx');

```



```ts

await Docx.fromNothing()

	.withXmlRule('self::text()', ({ node }) => {node.nodeValue})

	.withXmlRule('self::p', ({ traverse, node }) => (

		{traverse()}

	))

	.withXml(`
I want a cookie
`, {})

	.toFile('example-2.docx');

```



#### Features



To great or small extend, 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](https://github.com/wvbe/docxml/wiki/Examples)



**API features:**



- [x] 100% typed

- [x] Asynchronous components

- [x] Component composition



**Custom styles:**



- [x] Font size and color

- [x] Bold, italic, underline styles, strike-through

- [x] Subscript, superscript, small caps

- [x] Paragraph spacing and indentation

- [x] Left/right/center/justified alignment

- [x] Numbering

- [ ] Aligning text on tabs

- [x] Font family

- [ ] Embed TTF in the DOCX file



**References:**



- [x] Cross references

- [ ] Table of contents



**Tables:**



- [x] Colspans and rowspans

- [x] Cell borders

- [x] [Table borders](http://officeopenxml.com/WPtableBorders.php)

- [x] [Conditional formatting](http://officeopenxml.com/WPtblLook.php)



**Images:**



- [x] From any `UInt8Array` source

- [x] Alternative and title text

- [x] Width and height



**Sections:**



- [x] Width and height

- [x] Orientation

- [x] Page headers & footers



**Comments:**



- [x] Point comment

- [x] Range comment

- [ ] Comment reply



**Change tracking:**



- [x] Text additions and deletions

- [x] Style changes

- [x] Table row additions and deletions



#### Differences with actual MS Word DOCX



Obviously `docxml` is a TypeScript project, which is already very different from how you would normally interact

with a DOCX document. More meaningfully however, `docxml` is meant to make writing DOCX _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 `` when using JSX. This makes the configuration of a new DOCX a little more

  forgiving.

- Using the `` or `` components will automatically create all required relationships etc.

- Some of the words have changed, generally speaking `docxml` is more verbose than the DOCX verbiage.

- Generally speaking `docxml` prefers formal (JS) references over references-by-identifier. In those cases the

  identifiers are randomly generated for you when the `.docx` file 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.



#### For contributors



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.



```sh

# Once

npm install



# Run all unit tests

deno task test



# Run all linting

deno task lint

```