smartyellow/docx-js

Go to file

Bruce Duncan 816cb54b14 Optimize XML output by properly constructing objects to send to the xml library so that it can produce proper empty elements.

Rework the way attributes are stored in ImportedXmlComponent to match elsewhere (required allowing for a null xmlKeys in the XmlAttributeComponent interface).
Rework the way paragraphs get added to the end of table cells if needed.
The goal in both reworks is to not mess around with the objects output from `prepForXml` if we can avoid it.
Made the output of RunProperties, ParagraphProperties, TableCellProperties, TableRowProperties, and TableProperties all optional based on whether they contain any attributes or children.  Changed code in PageBorders, TableCellMargin, and TableCellBorders that implemented this same thing by overriding `prepForXml` so that it uses the new XmlComponent subclass instead.
Removed commented out code that attempted to fix-up XML output and make proper empty elements.
Fixed all affected tests.
Turn off `no-null-keyword` in the linter as we need to use null to signal to the `xml` library to create an empty element with no attributes (`undefined` will not work in its place).

Fixes #306

2019-04-09 05:27:18 -04:00

Revert back .vscode folder

2018-09-14 02:44:47 +01:00

Add shading

2019-03-21 01:06:07 +00:00

fix minor typos

2019-04-04 15:35:41 -04:00

Update logo to be blinking

2018-09-12 21:19:33 +01:00

Add Error for e2e test

2019-01-15 00:34:40 +00:00

Optimize XML output by properly constructing objects to send to the xml library so that it can produce proper empty elements.

2019-04-09 05:27:18 -04:00

.editorconfig

Add editorconfig

2017-12-20 01:40:52 +00:00

.gitignore

Add nyc support

2018-10-26 20:11:40 +01:00

.npmignore

added docs ignore to npmignore file

2017-04-16 00:04:29 +01:00

.nvmrc

minimum 8

2018-08-31 11:25:05 -04:00

.nycrc

Edit threshold

2018-11-02 03:00:07 +00:00

.prettierrc.yml

Simplify prettier command

2018-02-10 17:56:52 +00:00

.travis.yml

Disable e2e for demo 32 temporarily

2019-03-19 00:07:11 +00:00

LICENSE

Initial commit

2016-03-26 23:43:57 +00:00

package.json

Version bump

2019-03-30 15:45:12 +00:00

README.md

Update README.md

2019-03-12 20:26:39 +00:00

tsconfig.json

Use a typescript webpack config

2019-01-16 13:34:32 +00:00

tslint.json

Optimize XML output by properly constructing objects to send to the xml library so that it can produce proper empty elements.

2019-04-09 05:27:18 -04:00

webpack.config.ts

dont run coverage if publishing

2019-02-08 12:06:50 +00:00

README.md

Easily generate .docx files with JS/TS. Works for Node and on the Browser.

Demo

Browser

Here are examples of docx being used with basic HTML/JS in a browser environment:

Here is an example of docx working in Angular:

https://stackblitz.com/edit/angular-afvxtz

Node

Press endpoint on the RunKit website:

https://runkit.com/dolanmiu/docx-demo1 - Simple paragraph and text
https://runkit.com/dolanmiu/docx-demo2 - Advanced Paragraphs and text
https://runkit.com/dolanmiu/docx-demo3 - Bullet points
https://runkit.com/dolanmiu/docx-demo4 - Simple table
https://runkit.com/dolanmiu/docx-demo5 - Images
https://runkit.com/dolanmiu/docx-demo6 - Margins
https://runkit.com/dolanmiu/docx-demo7 - Landscape
https://runkit.com/dolanmiu/docx-demo8 - Header and Footer
https://runkit.com/dolanmiu/docx-demo10 - My CV generated with docx

More here and here

How to use & Documentation

Please refer to the documentation at https://docx.js.org/ for details on how to use this library, examples and much more!

Examples

Check the examples section in the documentation and the demo folder for examples.

Contributing

Read the contribution guidelines here.

Used by

Made with 💖