docxjs
Docx rendering library
Demo - https://volodymyrbaydalka.github.io/docxjs/
Goal
Goal of this project is to render/convert DOCX document into HTML document with keeping HTML semantic as much as possible.
That means library is limited by HTML capabilities (for example Google Docs renders *.docx document on canvas as an image).
Installation
npm install docx-preview
Usage
<script src="https://unpkg.com/jszip/dist/jszip.min.js"></script>
<script src="docx-preview.min.js"></script>
<script>
var docData = <document Blob>;
docx.renderAsync(docData, document.getElementById("container"))
.then(x => console.log("docx: finished"));
</script>
<body>
...
<div id="container"></div>
...
</body>
API
renderAsync(
document: Blob | ArrayBuffer | Uint8Array,
bodyContainer: HTMLElement,
styleContainer: HTMLElement,
options: {
className: string = "docx",
inWrapper: boolean = true,
ignoreWidth: boolean = false,
ignoreHeight: boolean = false,
ignoreFonts: boolean = false,
breakPages: boolean = true,
ignoreLastRenderedPageBreak: boolean = true,
experimental: boolean = false,
trimXmlDeclaration: boolean = true,
useBase64URL: boolean = false,
renderChanges: false,
renderHeaders: true,
renderFooters: true,
renderFootnotes: true,
renderEndnotes: true,
renderComments: false,
debug: boolean = false,
}): Promise<WordDocument>
praseAsync(
document: Blob | ArrayBuffer | Uint8Array,
options: Options
): Promise<WordDocument>
renderDocument(
wordDocument: WordDocument,
bodyContainer: HTMLElement,
styleContainer: HTMLElement,
options: Options
): Promise<void>
Thumbnails, TOC and etc.
Thumbnails is added only for example and it's not part of library. Library renders DOCX into HTML, so it can't be efficiently used for thumbnails.
Table of contents is built using the TOC fields and there is no efficient way to get table of contents at this point, since fields is not supported yet (http://officeopenxml.com/WPtableOfContents.php)
Breaks
Currently library does break pages:
- if user/manual page break
<w:br w:type="page"/>
is inserted - when user insert page break - if application page break
<w:lastRenderedPageBreak/>
is inserted - could be inserted by editor application like MS word (ignoreLastRenderedPageBreak
should be set to false) - if page settings for paragraph is changed - ex: user change settings from portrait to landscape page
Realtime page breaking is not implemented because it's requires re-calculation of sizes on each insertion and that could affect performance a lot.
If page breaking is crutual for you, I would recommend:
- try to insert manual break point as much as you could
- try use editors like MS Word, that inserts
<w:lastRenderedPageBreak/>
break points
NOTE: by default ignoreLastRenderedPageBreak
is set to true
. You may need to set it to false
, to make library break by <w:lastRenderedPageBreak/>
break points
Status and stability
So far I can't come up with final approach of parsing documents and final structure of API. Only renderAsync function is stable and definition shouldn't be changed in future. Inner implementation of parsing and rendering may be changed at any point of time.