docx-preview-sync
v0.4.20
Published
The docx document **synchronously** rendering library
Downloads
12
Readme
docx-preview-sync
The docx document synchronously rendering library
Introduction
This library is inspired by the docx-preview library. Thanks to the author VolodymyrBaydalka for his hard work. I forked the project and modified it to support break pages as much as possible. To achieve this goal, I changed the rendering library from asynchronous to synchronous, so that the rendering process can be completed in a synchronous manner, then I can detect all HTML elements that need to be broken and split them into different pages.
Based on the synchronous rendering process, This library will cause lower performance.
This library is still in the development stage, so it is not recommended to use it in production.
Online Demo
https://millet0328.github.io/docx-preview-sync/
Usage
Package managers
Install library in your Node.js powered apps with the npm package:
npm install docx-preview-syncimport { renderSync } from 'docx-preview-sync';
// fectch document Blob,maybe from input with type = file
let docData: Blob = document.querySelector('input').files[0];
// synchronously rendering function
let wordDocument = await renderSync(docData, document.getElementById("container"));
// if you need to get the word document object
console.log("docx document object", wordDocument);Static HTML without a build step
<!--dependencies-->
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/jszip.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/lodash.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/konva.min.js"></script>
<script src="./js/docx-preview.min.js"></script>
<body>
...
<div id="container"></div>
...
</body>
<script>
// fectch document Blob,maybe from input width type = file
let docData = document.querySelector('input').files[0];
// synchronously rendering function
docx.renderSync(docData, document.getElementById("container"))
.then(wordDocument => {
// if you need to get the Word document object
console.log("docx document object", wordDocument);
});
</script>API
renderSync
Render HTML5 Elements Synchronously.
renderSync = praseAsync + renderDocument(sync:true)
// renders document into specified element synchronously
renderSync(
document: Blob | ArrayBuffer | Uint8Array, // could be any type that supported by JSZip.loadAsync
bodyContainer: HTMLElement, //element to render document content,
styleContainer: HTMLElement, //element to render document styles, numbeings, fonts. If null, bodyContainer will be used.
options: {
breakPages: boolean = true, //enables page breaking on page breaks
className: string = "docx", //class name/prefix for default and document style classes
ignoreFonts: boolean = false, //disables fonts rendering
ignoreHeight: boolean = false, //disables rendering height of page
ignoreImageWrap: boolean = false, //disables image text wrap setting
ignoreLastRenderedPageBreak: boolean = true, //disables page breaking on lastRenderedPageBreak elements
ignoreTableWrap: boolean = true, //disables table's text wrap setting
ignoreWidth: boolean = false, //disables rendering width of page
inWrapper: boolean = true, //enables rendering of wrapper around document content
renderChanges: false, //enables experimental rendering of document changes (inserions/deletions)
renderEndnotes: true, //enables endnotes rendering
renderFooters: true, //enables footers rendering
renderFootnotes: true, //enables footnotes rendering
renderHeaders: true, //enables headers rendering
trimXmlDeclaration: boolean = true, //if true, xml declaration will be removed from xml documents before parsing
useBase64URL: boolean = false, //if true, images, fonts, etc. will be converted to base 64 URL, otherwise URL.createObjectURL is used
debug: boolean = false, //enables additional logging
experimental: boolean = false, //enables experimental features (tab stops calculation)
}): Promise<WordDocument>renderAsync
Render HTML5 Elements Asynchronously
renderSync = praseAsync + renderDocument(sync:false)
// renders document into specified element synchronously
renderAsync(
document: Blob | ArrayBuffer | Uint8Array, // could be any type that supported by JSZip.loadAsync
bodyContainer: HTMLElement, //element to render document content,
styleContainer: HTMLElement, //element to render document styles, numbeings, fonts. If null, bodyContainer will be used.
options: {
breakPages: boolean = true, //enables page breaking on page breaks
className: string = "docx", //class name/prefix for default and document style classes
ignoreFonts: boolean = false, //disables fonts rendering
ignoreHeight: boolean = false, //disables rendering height of page
ignoreImageWrap: boolean = false, //disables image text wrap setting
ignoreLastRenderedPageBreak: boolean = true, //disables page breaking on lastRenderedPageBreak elements
ignoreTableWrap: boolean = true, //disables table's text wrap setting
ignoreWidth: boolean = false, //disables rendering width of page
inWrapper: boolean = true, //enables rendering of wrapper around document content
renderChanges: false, //enables experimental rendering of document changes (inserions/deletions)
renderEndnotes: true, //enables endnotes rendering
renderFooters: true, //enables footers rendering
renderFootnotes: true, //enables footnotes rendering
renderHeaders: true, //enables headers rendering
trimXmlDeclaration: boolean = true, //if true, xml declaration will be removed from xml documents before parsing
useBase64URL: boolean = false, //if true, images, fonts, etc. will be converted to base 64 URL, otherwise URL.createObjectURL is used
debug: boolean = false, //enables additional logging
experimental: boolean = false, //enables experimental features (tab stops calculation)
}): Promise<WordDocument>parseAsync
Document Parser Asynchronously
parse document and return internal document object. this could be used to modify document object before rendering
// ==== experimental / internal API ====
parseAsync(document: Blob | ArrayBuffer | Uint8Array, options: Options): Promise<WordDocument>renderDocument
render internal document object into specified container.
sync is a boolean parameter which enables synchronous rendering or asynchronous.
// ==== experimental / internal API ====
renderDocument(
wordDocument: WordDocument,
bodyContainer: HTMLElement,
styleContainer: HTMLElement,
sync: boolean,
options: Options,
): Promise<void>Goals
- Render/convert DOCX document into HTML document with keeping HTML semantic as much as possible.
- Support break pages strictly
- Parse all elements from Office Open XML specification
This library is limited by HTML capabilities.If you need to render document on canvas,try the onlyOffice library.
Partially Supported Namespaces
- [x] DocumentFormat.OpenXml.Wordprocessing
- [x] DocumentFormat.OpenXml.Math
Not Supported Namespaces
- [ ] DocumentFormat.OpenXml.Drawing
- [ ] DocumentFormat.OpenXml.Drawing.Charts
- [ ] DocumentFormat.OpenXml.InkML
- [ ] DocumentFormat.OpenXml.Vml
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 (ignoreLastRenderedPageBreakshould 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 to use editors like MS Word, that inserts
<w:lastRenderedPageBreak/>break points