docx 7.0.0 → 7.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (493) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +120 -123
  3. package/build/convenience-functions.d.ts +4 -4
  4. package/build/convenience-functions.spec.d.ts +1 -1
  5. package/build/export/formatter.d.ts +4 -4
  6. package/build/export/formatter.spec.d.ts +1 -1
  7. package/build/export/index.d.ts +1 -1
  8. package/build/export/packer/image-replacer.d.ts +5 -5
  9. package/build/export/packer/image-replacer.spec.d.ts +1 -1
  10. package/build/export/packer/next-compiler.d.ts +10 -10
  11. package/build/export/packer/next-compiler.spec.d.ts +1 -1
  12. package/build/export/packer/numbering-replacer.d.ts +4 -4
  13. package/build/export/packer/packer.d.ts +8 -8
  14. package/build/export/packer/packer.spec.d.ts +1 -1
  15. package/build/file/app-properties/app-properties-attributes.d.ts +10 -10
  16. package/build/file/app-properties/app-properties.d.ts +4 -4
  17. package/build/file/border/border.d.ts +39 -39
  18. package/build/file/border/border.spec.d.ts +1 -1
  19. package/build/file/border/index.d.ts +1 -1
  20. package/build/file/content-types/content-types-attributes.d.ts +8 -8
  21. package/build/file/content-types/content-types.d.ts +6 -6
  22. package/build/file/content-types/content-types.spec.d.ts +1 -1
  23. package/build/file/content-types/default/default-attributes.d.ts +10 -10
  24. package/build/file/content-types/default/default.d.ts +4 -4
  25. package/build/file/content-types/override/override-attributes.d.ts +10 -10
  26. package/build/file/content-types/override/override.d.ts +4 -4
  27. package/build/file/core-properties/index.d.ts +1 -1
  28. package/build/file/core-properties/properties.d.ts +36 -36
  29. package/build/file/core-properties/properties.spec.d.ts +1 -1
  30. package/build/file/custom-properties/custom-properties-attributes.d.ts +10 -10
  31. package/build/file/custom-properties/custom-properties.d.ts +9 -9
  32. package/build/file/custom-properties/custom-properties.spec.d.ts +1 -1
  33. package/build/file/custom-properties/custom-property-attributes.d.ts +12 -12
  34. package/build/file/custom-properties/custom-property.d.ts +11 -11
  35. package/build/file/custom-properties/index.d.ts +2 -2
  36. package/build/file/document/body/body.d.ts +10 -10
  37. package/build/file/document/body/body.spec.d.ts +1 -1
  38. package/build/file/document/body/index.d.ts +2 -2
  39. package/build/file/document/body/section-properties/index.d.ts +2 -2
  40. package/build/file/document/body/section-properties/properties/column.d.ts +14 -14
  41. package/build/file/document/body/section-properties/properties/columns.d.ts +20 -20
  42. package/build/file/document/body/section-properties/properties/columns.spec.d.ts +1 -1
  43. package/build/file/document/body/section-properties/properties/doc-grid.d.ts +12 -12
  44. package/build/file/document/body/section-properties/properties/header-footer-reference.d.ts +17 -17
  45. package/build/file/document/body/section-properties/properties/header-footer-reference.spec.d.ts +1 -1
  46. package/build/file/document/body/section-properties/properties/index.d.ts +11 -11
  47. package/build/file/document/body/section-properties/properties/line-number.d.ts +23 -23
  48. package/build/file/document/body/section-properties/properties/page-borders.d.ts +30 -30
  49. package/build/file/document/body/section-properties/properties/page-borders.spec.d.ts +1 -1
  50. package/build/file/document/body/section-properties/properties/page-margin.d.ts +24 -24
  51. package/build/file/document/body/section-properties/properties/page-number.d.ts +24 -24
  52. package/build/file/document/body/section-properties/properties/page-size.d.ts +20 -20
  53. package/build/file/document/body/section-properties/properties/page-size.spec.d.ts +1 -1
  54. package/build/file/document/body/section-properties/properties/section-type.d.ts +18 -18
  55. package/build/file/document/body/section-properties/properties/section-type.spec.d.ts +1 -1
  56. package/build/file/document/body/section-properties/section-properties.d.ts +51 -51
  57. package/build/file/document/body/section-properties/section-properties.spec.d.ts +1 -1
  58. package/build/file/document/document-attributes.d.ts +53 -53
  59. package/build/file/document/document-background/document-background.d.ts +23 -23
  60. package/build/file/document/document-background/document-background.spec.d.ts +1 -1
  61. package/build/file/document/document-background/index.d.ts +1 -1
  62. package/build/file/document/document.d.ts +15 -15
  63. package/build/file/document/document.spec.d.ts +1 -1
  64. package/build/file/document/index.d.ts +4 -4
  65. package/build/file/document-wrapper.d.ts +16 -16
  66. package/build/file/document-wrapper.spec.d.ts +1 -1
  67. package/build/file/drawing/anchor/anchor-attributes.d.ts +24 -24
  68. package/build/file/drawing/anchor/anchor.d.ts +6 -6
  69. package/build/file/drawing/anchor/anchor.spec.d.ts +1 -1
  70. package/build/file/drawing/anchor/index.d.ts +2 -2
  71. package/build/file/drawing/doc-properties/doc-properties-attributes.d.ts +12 -12
  72. package/build/file/drawing/doc-properties/doc-properties.d.ts +4 -4
  73. package/build/file/drawing/drawing.d.ts +16 -16
  74. package/build/file/drawing/drawing.spec.d.ts +1 -1
  75. package/build/file/drawing/effect-extent/effect-extent-attributes.d.ts +14 -14
  76. package/build/file/drawing/effect-extent/effect-extent.d.ts +4 -4
  77. package/build/file/drawing/extent/extent-attributes.d.ts +10 -10
  78. package/build/file/drawing/extent/extent.d.ts +5 -5
  79. package/build/file/drawing/floating/align.d.ts +5 -5
  80. package/build/file/drawing/floating/align.spec.d.ts +1 -1
  81. package/build/file/drawing/floating/floating-position.d.ts +49 -49
  82. package/build/file/drawing/floating/horizontal-position.d.ts +5 -5
  83. package/build/file/drawing/floating/horizontal-position.spec.d.ts +1 -1
  84. package/build/file/drawing/floating/index.d.ts +4 -4
  85. package/build/file/drawing/floating/position-offset.d.ts +4 -4
  86. package/build/file/drawing/floating/position-offset.spec.d.ts +1 -1
  87. package/build/file/drawing/floating/simple-pos.d.ts +4 -4
  88. package/build/file/drawing/floating/simple-pos.spec.d.ts +1 -1
  89. package/build/file/drawing/floating/vertical-position.d.ts +5 -5
  90. package/build/file/drawing/floating/vertical-position.spec.d.ts +1 -1
  91. package/build/file/drawing/graphic-frame/graphic-frame-locks/graphic-frame-lock-attributes.d.ts +10 -10
  92. package/build/file/drawing/graphic-frame/graphic-frame-locks/graphic-frame-locks.d.ts +4 -4
  93. package/build/file/drawing/graphic-frame/graphic-frame-properties.d.ts +4 -4
  94. package/build/file/drawing/index.d.ts +3 -3
  95. package/build/file/drawing/inline/graphic/graphic-data/graphic-data-attribute.d.ts +8 -8
  96. package/build/file/drawing/inline/graphic/graphic-data/graphic-data.d.ts +6 -6
  97. package/build/file/drawing/inline/graphic/graphic-data/index.d.ts +1 -1
  98. package/build/file/drawing/inline/graphic/graphic-data/pic/blip/blip-fill.d.ts +5 -5
  99. package/build/file/drawing/inline/graphic/graphic-data/pic/blip/blip.d.ts +5 -5
  100. package/build/file/drawing/inline/graphic/graphic-data/pic/blip/source-rectangle.d.ts +4 -4
  101. package/build/file/drawing/inline/graphic/graphic-data/pic/blip/stretch.d.ts +4 -4
  102. package/build/file/drawing/inline/graphic/graphic-data/pic/index.d.ts +1 -1
  103. package/build/file/drawing/inline/graphic/graphic-data/pic/non-visual-pic-properties/child-non-visual-pic-properties/child-non-visual-pic-properties.d.ts +4 -4
  104. package/build/file/drawing/inline/graphic/graphic-data/pic/non-visual-pic-properties/child-non-visual-pic-properties/pic-locks/pic-locks-attributes.d.ts +10 -10
  105. package/build/file/drawing/inline/graphic/graphic-data/pic/non-visual-pic-properties/child-non-visual-pic-properties/pic-locks/pic-locks.d.ts +4 -4
  106. package/build/file/drawing/inline/graphic/graphic-data/pic/non-visual-pic-properties/non-visual-pic-properties.d.ts +4 -4
  107. package/build/file/drawing/inline/graphic/graphic-data/pic/non-visual-pic-properties/non-visual-properties/non-visual-properties-attributes.d.ts +12 -12
  108. package/build/file/drawing/inline/graphic/graphic-data/pic/non-visual-pic-properties/non-visual-properties/non-visual-properties.d.ts +4 -4
  109. package/build/file/drawing/inline/graphic/graphic-data/pic/pic-attributes.d.ts +8 -8
  110. package/build/file/drawing/inline/graphic/graphic-data/pic/pic.d.ts +5 -5
  111. package/build/file/drawing/inline/graphic/graphic-data/pic/shape-properties/form/extents/extents-attributes.d.ts +10 -10
  112. package/build/file/drawing/inline/graphic/graphic-data/pic/shape-properties/form/extents/extents.d.ts +5 -5
  113. package/build/file/drawing/inline/graphic/graphic-data/pic/shape-properties/form/form.d.ts +17 -17
  114. package/build/file/drawing/inline/graphic/graphic-data/pic/shape-properties/form/index.d.ts +1 -1
  115. package/build/file/drawing/inline/graphic/graphic-data/pic/shape-properties/form/offset/off-attributes.d.ts +10 -10
  116. package/build/file/drawing/inline/graphic/graphic-data/pic/shape-properties/form/offset/off.d.ts +4 -4
  117. package/build/file/drawing/inline/graphic/graphic-data/pic/shape-properties/form.spec.d.ts +1 -1
  118. package/build/file/drawing/inline/graphic/graphic-data/pic/shape-properties/outline/no-fill.d.ts +4 -4
  119. package/build/file/drawing/inline/graphic/graphic-data/pic/shape-properties/outline/no-fill.spec.d.ts +1 -1
  120. package/build/file/drawing/inline/graphic/graphic-data/pic/shape-properties/outline/outline.d.ts +4 -4
  121. package/build/file/drawing/inline/graphic/graphic-data/pic/shape-properties/outline/outline.spec.d.ts +1 -1
  122. package/build/file/drawing/inline/graphic/graphic-data/pic/shape-properties/preset-geometry/adjustment-values/adjustment-values.d.ts +4 -4
  123. package/build/file/drawing/inline/graphic/graphic-data/pic/shape-properties/preset-geometry/preset-geometry-attributes.d.ts +8 -8
  124. package/build/file/drawing/inline/graphic/graphic-data/pic/shape-properties/preset-geometry/preset-geometry.d.ts +4 -4
  125. package/build/file/drawing/inline/graphic/graphic-data/pic/shape-properties/shape-properties-attributes.d.ts +8 -8
  126. package/build/file/drawing/inline/graphic/graphic-data/pic/shape-properties/shape-properties.d.ts +6 -6
  127. package/build/file/drawing/inline/graphic/graphic.d.ts +6 -6
  128. package/build/file/drawing/inline/graphic/index.d.ts +1 -1
  129. package/build/file/drawing/inline/index.d.ts +1 -1
  130. package/build/file/drawing/inline/inline-attributes.d.ts +10 -10
  131. package/build/file/drawing/inline/inline.d.ts +7 -7
  132. package/build/file/drawing/text-wrap/index.d.ts +5 -5
  133. package/build/file/drawing/text-wrap/text-wrapping.d.ts +18 -18
  134. package/build/file/drawing/text-wrap/wrap-none.d.ts +4 -4
  135. package/build/file/drawing/text-wrap/wrap-square.d.ts +6 -6
  136. package/build/file/drawing/text-wrap/wrap-tight.d.ts +5 -5
  137. package/build/file/drawing/text-wrap/wrap-top-and-bottom.d.ts +5 -5
  138. package/build/file/file-properties.d.ts +5 -5
  139. package/build/file/file.d.ts +69 -69
  140. package/build/file/file.spec.d.ts +1 -1
  141. package/build/file/footer/footer-attributes.d.ts +50 -50
  142. package/build/file/footer/footer.d.ts +9 -9
  143. package/build/file/footer/footer.spec.d.ts +1 -1
  144. package/build/file/footer/index.d.ts +1 -1
  145. package/build/file/footer-wrapper.d.ts +23 -23
  146. package/build/file/footer-wrapper.spec.d.ts +1 -1
  147. package/build/file/footnotes/footnote/footnote-attributes.d.ts +10 -10
  148. package/build/file/footnotes/footnote/footnote.d.ts +14 -14
  149. package/build/file/footnotes/footnote/footnote.spec.d.ts +1 -1
  150. package/build/file/footnotes/footnote/index.d.ts +1 -1
  151. package/build/file/footnotes/footnote/run/continuation-seperator-run.d.ts +4 -4
  152. package/build/file/footnotes/footnote/run/continuation-seperator.d.ts +4 -4
  153. package/build/file/footnotes/footnote/run/footnote-ref-run.d.ts +4 -4
  154. package/build/file/footnotes/footnote/run/footnote-ref.d.ts +4 -4
  155. package/build/file/footnotes/footnote/run/index.d.ts +1 -1
  156. package/build/file/footnotes/footnote/run/reference-run.d.ts +15 -15
  157. package/build/file/footnotes/footnote/run/seperator-run.d.ts +4 -4
  158. package/build/file/footnotes/footnote/run/seperator.d.ts +4 -4
  159. package/build/file/footnotes/footnotes-attributes.d.ts +40 -40
  160. package/build/file/footnotes/footnotes.d.ts +6 -6
  161. package/build/file/footnotes/index.d.ts +2 -2
  162. package/build/file/footnotes-wrapper.d.ts +10 -10
  163. package/build/file/footnotes-wrapper.spec.d.ts +1 -1
  164. package/build/file/header/header-attributes.d.ts +72 -72
  165. package/build/file/header/header.d.ts +9 -9
  166. package/build/file/header/header.spec.d.ts +1 -1
  167. package/build/file/header/index.d.ts +1 -1
  168. package/build/file/header-wrapper.d.ts +23 -23
  169. package/build/file/header-wrapper.spec.d.ts +1 -1
  170. package/build/file/header.d.ts +13 -13
  171. package/build/file/index.d.ts +21 -21
  172. package/build/file/media/data.d.ts +22 -22
  173. package/build/file/media/index.d.ts +2 -2
  174. package/build/file/media/media.d.ts +19 -19
  175. package/build/file/media/media.spec.d.ts +1 -1
  176. package/build/file/numbering/abstract-numbering.d.ts +6 -6
  177. package/build/file/numbering/abstract-numbering.spec.d.ts +1 -1
  178. package/build/file/numbering/concrete-numbering.spec.d.ts +1 -1
  179. package/build/file/numbering/index.d.ts +4 -4
  180. package/build/file/numbering/level.d.ts +47 -47
  181. package/build/file/numbering/multi-level-type.d.ts +4 -4
  182. package/build/file/numbering/num.d.ts +20 -20
  183. package/build/file/numbering/numbering.d.ts +19 -19
  184. package/build/file/numbering/numbering.spec.d.ts +1 -1
  185. package/build/file/paragraph/formatting/alignment.d.ts +21 -21
  186. package/build/file/paragraph/formatting/alignment.spec.d.ts +1 -1
  187. package/build/file/paragraph/formatting/border.d.ts +14 -14
  188. package/build/file/paragraph/formatting/border.spec.d.ts +1 -1
  189. package/build/file/paragraph/formatting/break.d.ts +11 -11
  190. package/build/file/paragraph/formatting/break.spec.d.ts +1 -1
  191. package/build/file/paragraph/formatting/indent.d.ts +12 -12
  192. package/build/file/paragraph/formatting/index.d.ts +8 -8
  193. package/build/file/paragraph/formatting/spacing.d.ts +17 -17
  194. package/build/file/paragraph/formatting/spacing.spec.d.ts +1 -1
  195. package/build/file/paragraph/formatting/style.d.ts +13 -13
  196. package/build/file/paragraph/formatting/style.spec.d.ts +1 -1
  197. package/build/file/paragraph/formatting/tab-stop.d.ts +39 -39
  198. package/build/file/paragraph/formatting/tab-stop.spec.d.ts +1 -1
  199. package/build/file/paragraph/formatting/unordered-list.d.ts +4 -4
  200. package/build/file/paragraph/formatting/unordered-list.spec.d.ts +1 -1
  201. package/build/file/paragraph/frame/frame-properties.d.ts +84 -84
  202. package/build/file/paragraph/frame/frame-properties.spec.d.ts +1 -1
  203. package/build/file/paragraph/frame/index.d.ts +1 -1
  204. package/build/file/paragraph/index.d.ts +7 -7
  205. package/build/file/paragraph/links/bookmark-attributes.d.ts +17 -17
  206. package/build/file/paragraph/links/bookmark.d.ts +17 -17
  207. package/build/file/paragraph/links/bookmark.spec.d.ts +1 -1
  208. package/build/file/paragraph/links/hyperlink-attributes.d.ts +13 -13
  209. package/build/file/paragraph/links/hyperlink.d.ts +26 -26
  210. package/build/file/paragraph/links/hyperlink.spec.d.ts +1 -1
  211. package/build/file/paragraph/links/index.d.ts +4 -4
  212. package/build/file/paragraph/links/outline-level.d.ts +5 -5
  213. package/build/file/paragraph/links/outline-level.spec.d.ts +1 -1
  214. package/build/file/paragraph/links/pageref-field-instruction.d.ts +5 -5
  215. package/build/file/paragraph/links/pageref-field-instruction.spec.d.ts +1 -1
  216. package/build/file/paragraph/links/pageref-properties.d.ts +4 -4
  217. package/build/file/paragraph/links/pageref.d.ts +5 -5
  218. package/build/file/paragraph/links/pageref.spec.d.ts +1 -1
  219. package/build/file/paragraph/math/brackets/index.d.ts +4 -4
  220. package/build/file/paragraph/math/brackets/math-angled-brackets.d.ts +7 -7
  221. package/build/file/paragraph/math/brackets/math-angled-brackets.spec.d.ts +1 -1
  222. package/build/file/paragraph/math/brackets/math-beginning-character.d.ts +4 -4
  223. package/build/file/paragraph/math/brackets/math-beginning-character.spec.d.ts +1 -1
  224. package/build/file/paragraph/math/brackets/math-bracket-properties.d.ts +7 -7
  225. package/build/file/paragraph/math/brackets/math-bracket-properties.spec.d.ts +1 -1
  226. package/build/file/paragraph/math/brackets/math-curly-brackets.d.ts +7 -7
  227. package/build/file/paragraph/math/brackets/math-curly-brackets.spec.d.ts +1 -1
  228. package/build/file/paragraph/math/brackets/math-ending-char.d.ts +4 -4
  229. package/build/file/paragraph/math/brackets/math-ending-character.spec.d.ts +1 -1
  230. package/build/file/paragraph/math/brackets/math-round-brackets.d.ts +7 -7
  231. package/build/file/paragraph/math/brackets/math-round-brackets.spec.d.ts +1 -1
  232. package/build/file/paragraph/math/brackets/math-square-brackets.d.ts +7 -7
  233. package/build/file/paragraph/math/brackets/math-square-brackets.spec.d.ts +1 -1
  234. package/build/file/paragraph/math/fraction/index.d.ts +3 -3
  235. package/build/file/paragraph/math/fraction/math-denominator.d.ts +5 -5
  236. package/build/file/paragraph/math/fraction/math-denominator.spec.d.ts +1 -1
  237. package/build/file/paragraph/math/fraction/math-fraction.d.ts +9 -9
  238. package/build/file/paragraph/math/fraction/math-fraction.spec.d.ts +1 -1
  239. package/build/file/paragraph/math/fraction/math-numerator.d.ts +5 -5
  240. package/build/file/paragraph/math/fraction/math-numerator.spec.d.ts +1 -1
  241. package/build/file/paragraph/math/function/index.d.ts +3 -3
  242. package/build/file/paragraph/math/function/math-function-name.d.ts +5 -5
  243. package/build/file/paragraph/math/function/math-function-name.spec.d.ts +1 -1
  244. package/build/file/paragraph/math/function/math-function-properties.d.ts +4 -4
  245. package/build/file/paragraph/math/function/math-function-properties.spec.d.ts +1 -1
  246. package/build/file/paragraph/math/function/math-function.d.ts +9 -9
  247. package/build/file/paragraph/math/function/math-function.spec.d.ts +1 -1
  248. package/build/file/paragraph/math/index.d.ts +9 -9
  249. package/build/file/paragraph/math/math-component.d.ts +9 -9
  250. package/build/file/paragraph/math/math-run.d.ts +4 -4
  251. package/build/file/paragraph/math/math-run.spec.d.ts +1 -1
  252. package/build/file/paragraph/math/math-text.d.ts +4 -4
  253. package/build/file/paragraph/math/math-text.spec.d.ts +1 -1
  254. package/build/file/paragraph/math/math.d.ts +8 -8
  255. package/build/file/paragraph/math/math.spec.d.ts +1 -1
  256. package/build/file/paragraph/math/n-ary/index.d.ts +7 -7
  257. package/build/file/paragraph/math/n-ary/math-accent-character.d.ts +4 -4
  258. package/build/file/paragraph/math/n-ary/math-accent-character.spec.d.ts +1 -1
  259. package/build/file/paragraph/math/n-ary/math-base.d.ts +5 -5
  260. package/build/file/paragraph/math/n-ary/math-base.spec.d.ts +1 -1
  261. package/build/file/paragraph/math/n-ary/math-limit-location.d.ts +4 -4
  262. package/build/file/paragraph/math/n-ary/math-limit-location.spec.d.ts +1 -1
  263. package/build/file/paragraph/math/n-ary/math-naray-properties.d.ts +4 -4
  264. package/build/file/paragraph/math/n-ary/math-naray-properties.spec.d.ts +1 -1
  265. package/build/file/paragraph/math/n-ary/math-sub-script-hide.d.ts +4 -4
  266. package/build/file/paragraph/math/n-ary/math-sub-script-hide.spec.d.ts +1 -1
  267. package/build/file/paragraph/math/n-ary/math-sub-script.d.ts +5 -5
  268. package/build/file/paragraph/math/n-ary/math-sub-script.spec.d.ts +1 -1
  269. package/build/file/paragraph/math/n-ary/math-sum.d.ts +10 -10
  270. package/build/file/paragraph/math/n-ary/math-sum.spec.d.ts +1 -1
  271. package/build/file/paragraph/math/n-ary/math-super-script-hide.d.ts +4 -4
  272. package/build/file/paragraph/math/n-ary/math-super-script-hide.spec.d.ts +1 -1
  273. package/build/file/paragraph/math/n-ary/math-super-script.d.ts +5 -5
  274. package/build/file/paragraph/math/n-ary/math-super-script.spec.d.ts +1 -1
  275. package/build/file/paragraph/math/radical/index.d.ts +3 -3
  276. package/build/file/paragraph/math/radical/math-degree-hide.d.ts +4 -4
  277. package/build/file/paragraph/math/radical/math-degree-hide.spec.d.ts +1 -1
  278. package/build/file/paragraph/math/radical/math-degree.d.ts +5 -5
  279. package/build/file/paragraph/math/radical/math-degree.spec.d.ts +1 -1
  280. package/build/file/paragraph/math/radical/math-radical-properties.d.ts +4 -4
  281. package/build/file/paragraph/math/radical/math-radical-properties.spec.d.ts +1 -1
  282. package/build/file/paragraph/math/radical/math-radical.d.ts +9 -9
  283. package/build/file/paragraph/math/radical/math-radical.spec.d.ts +1 -1
  284. package/build/file/paragraph/math/script/index.d.ts +4 -4
  285. package/build/file/paragraph/math/script/pre-sub-super-script/index.d.ts +2 -2
  286. package/build/file/paragraph/math/script/pre-sub-super-script/math-pre-sub-super-script-function-properties.d.ts +4 -4
  287. package/build/file/paragraph/math/script/pre-sub-super-script/math-pre-sub-super-script-function-properties.spec.d.ts +1 -1
  288. package/build/file/paragraph/math/script/pre-sub-super-script/math-pre-sub-super-script-function.d.ts +10 -10
  289. package/build/file/paragraph/math/script/pre-sub-super-script/math-pre-sub-super-script-function.spec.d.ts +1 -1
  290. package/build/file/paragraph/math/script/sub-script/index.d.ts +2 -2
  291. package/build/file/paragraph/math/script/sub-script/math-sub-script-function-properties.d.ts +4 -4
  292. package/build/file/paragraph/math/script/sub-script/math-sub-script-function-properties.spec.d.ts +1 -1
  293. package/build/file/paragraph/math/script/sub-script/math-sub-script-function.d.ts +9 -9
  294. package/build/file/paragraph/math/script/sub-script/math-sub-script-function.spec.d.ts +1 -1
  295. package/build/file/paragraph/math/script/sub-super-script/index.d.ts +2 -2
  296. package/build/file/paragraph/math/script/sub-super-script/math-sub-super-script-function-properties.d.ts +4 -4
  297. package/build/file/paragraph/math/script/sub-super-script/math-sub-super-script-function-properties.spec.d.ts +1 -1
  298. package/build/file/paragraph/math/script/sub-super-script/math-sub-super-script-function.d.ts +10 -10
  299. package/build/file/paragraph/math/script/sub-super-script/math-sub-super-script-function.spec.d.ts +1 -1
  300. package/build/file/paragraph/math/script/super-script/index.d.ts +2 -2
  301. package/build/file/paragraph/math/script/super-script/math-super-script-function-properties.d.ts +4 -4
  302. package/build/file/paragraph/math/script/super-script/math-super-script-function-properties.spec.d.ts +1 -1
  303. package/build/file/paragraph/math/script/super-script/math-super-script-function.d.ts +9 -9
  304. package/build/file/paragraph/math/script/super-script/math-super-script-function.spec.d.ts +1 -1
  305. package/build/file/paragraph/paragraph.d.ts +19 -19
  306. package/build/file/paragraph/paragraph.spec.d.ts +1 -1
  307. package/build/file/paragraph/properties.d.ts +54 -53
  308. package/build/file/paragraph/properties.spec.d.ts +1 -1
  309. package/build/file/paragraph/run/break.d.ts +4 -4
  310. package/build/file/paragraph/run/break.spec.d.ts +1 -1
  311. package/build/file/paragraph/run/emphasis-mark.d.ts +13 -13
  312. package/build/file/paragraph/run/emphasis-mark.spec.d.ts +1 -1
  313. package/build/file/paragraph/run/field.d.ts +10 -10
  314. package/build/file/paragraph/run/formatting.d.ts +13 -13
  315. package/build/file/paragraph/run/formatting.spec.d.ts +1 -1
  316. package/build/file/paragraph/run/image-run.d.ts +17 -17
  317. package/build/file/paragraph/run/image-run.spec.d.ts +1 -1
  318. package/build/file/paragraph/run/index.d.ts +11 -11
  319. package/build/file/paragraph/run/page-number.d.ts +10 -10
  320. package/build/file/paragraph/run/page-number.spec.d.ts +1 -1
  321. package/build/file/paragraph/run/properties.d.ts +47 -47
  322. package/build/file/paragraph/run/run-components/symbol.d.ts +4 -4
  323. package/build/file/paragraph/run/run-components/symbol.spec.d.ts +1 -1
  324. package/build/file/paragraph/run/run-components/text.d.ts +4 -4
  325. package/build/file/paragraph/run/run-components/text.spec.d.ts +1 -1
  326. package/build/file/paragraph/run/run-fonts.d.ts +12 -12
  327. package/build/file/paragraph/run/run-fonts.spec.d.ts +1 -1
  328. package/build/file/paragraph/run/run.d.ts +19 -19
  329. package/build/file/paragraph/run/run.spec.d.ts +1 -1
  330. package/build/file/paragraph/run/script.d.ts +10 -10
  331. package/build/file/paragraph/run/script.spec.d.ts +1 -1
  332. package/build/file/paragraph/run/sequential-identifier-instruction.d.ts +4 -4
  333. package/build/file/paragraph/run/sequential-identifier.d.ts +4 -4
  334. package/build/file/paragraph/run/sequential-identifier.spec.d.ts +1 -1
  335. package/build/file/paragraph/run/simple-field.d.ts +7 -7
  336. package/build/file/paragraph/run/simple-field.spec.d.ts +1 -1
  337. package/build/file/paragraph/run/symbol-run.d.ts +8 -8
  338. package/build/file/paragraph/run/symbol-run.spec.d.ts +1 -1
  339. package/build/file/paragraph/run/tab.d.ts +4 -4
  340. package/build/file/paragraph/run/tab.spec.d.ts +1 -1
  341. package/build/file/paragraph/run/text-run.d.ts +4 -4
  342. package/build/file/paragraph/run/text-run.spec.d.ts +1 -1
  343. package/build/file/paragraph/run/underline.d.ts +23 -23
  344. package/build/file/paragraph/run/underline.spec.d.ts +1 -1
  345. package/build/file/relationships/attributes.d.ts +8 -8
  346. package/build/file/relationships/index.d.ts +1 -1
  347. package/build/file/relationships/relationship/relationship-attributes.d.ts +14 -14
  348. package/build/file/relationships/relationship/relationship.d.ts +8 -8
  349. package/build/file/relationships/relationships.d.ts +8 -8
  350. package/build/file/relationships/relationships.spec.d.ts +1 -1
  351. package/build/file/settings/compatibility-setting/compatibility-setting.d.ts +15 -15
  352. package/build/file/settings/compatibility-setting/compatibility-setting.spec.d.ts +1 -1
  353. package/build/file/settings/compatibility.d.ts +8 -8
  354. package/build/file/settings/compatibility.spec.d.ts +1 -1
  355. package/build/file/settings/index.d.ts +1 -1
  356. package/build/file/settings/settings.d.ts +49 -49
  357. package/build/file/settings/settings.spec.d.ts +1 -1
  358. package/build/file/shading/index.d.ts +1 -1
  359. package/build/file/shading/shading.d.ts +48 -48
  360. package/build/file/shading/shading.spec.d.ts +1 -1
  361. package/build/file/shared/alignment.d.ts +14 -14
  362. package/build/file/shared/index.d.ts +2 -2
  363. package/build/file/shared/number-format.d.ts +64 -64
  364. package/build/file/space-type.d.ts +4 -4
  365. package/build/file/styles/defaults/document-defaults.d.ts +12 -12
  366. package/build/file/styles/defaults/document-defaults.spec.d.ts +1 -1
  367. package/build/file/styles/defaults/index.d.ts +3 -3
  368. package/build/file/styles/defaults/paragraph-properties.d.ts +5 -5
  369. package/build/file/styles/defaults/run-properties.d.ts +5 -5
  370. package/build/file/styles/external-styles-factory.d.ts +4 -4
  371. package/build/file/styles/external-styles-factory.spec.d.ts +1 -1
  372. package/build/file/styles/factory.d.ts +22 -22
  373. package/build/file/styles/index.d.ts +4 -4
  374. package/build/file/styles/latent-styles/exceptions.d.ts +20 -20
  375. package/build/file/styles/latent-styles/exceptions.spec.d.ts +1 -1
  376. package/build/file/styles/latent-styles/index.d.ts +1 -1
  377. package/build/file/styles/latent-styles/latent-styles.d.ts +5 -5
  378. package/build/file/styles/latent-styles/latent-styles.spec.d.ts +1 -1
  379. package/build/file/styles/sample/default-style.d.ts +102 -102
  380. package/build/file/styles/sample/default-style.spec.d.ts +1 -1
  381. package/build/file/styles/sample/index.d.ts +1 -1
  382. package/build/file/styles/style/character-style.d.ts +13 -13
  383. package/build/file/styles/style/character-style.spec.d.ts +1 -1
  384. package/build/file/styles/style/components.d.ts +11 -11
  385. package/build/file/styles/style/components.spec.d.ts +1 -1
  386. package/build/file/styles/style/default-styles.d.ts +44 -44
  387. package/build/file/styles/style/default-styles.spec.d.ts +1 -1
  388. package/build/file/styles/style/index.d.ts +4 -4
  389. package/build/file/styles/style/paragraph-style.d.ts +15 -15
  390. package/build/file/styles/style/paragraph-style.spec.d.ts +1 -1
  391. package/build/file/styles/style/style.d.ts +20 -20
  392. package/build/file/styles/style/style.spec.d.ts +1 -1
  393. package/build/file/styles/styles.d.ts +15 -15
  394. package/build/file/styles/styles.spec.d.ts +1 -1
  395. package/build/file/table/grid.d.ts +7 -7
  396. package/build/file/table/grid.spec.d.ts +1 -1
  397. package/build/file/table/index.d.ts +5 -5
  398. package/build/file/table/table-cell/index.d.ts +2 -2
  399. package/build/file/table/table-cell/table-cell-components.d.ts +31 -31
  400. package/build/file/table/table-cell/table-cell-properties.d.ts +20 -20
  401. package/build/file/table/table-cell/table-cell-properties.spec.d.ts +1 -1
  402. package/build/file/table/table-cell/table-cell.d.ts +12 -12
  403. package/build/file/table/table-cell/table-cell.spec.d.ts +1 -1
  404. package/build/file/table/table-properties/index.d.ts +5 -5
  405. package/build/file/table/table-properties/table-borders.d.ts +45 -45
  406. package/build/file/table/table-properties/table-borders.spec.d.ts +1 -1
  407. package/build/file/table/table-properties/table-cell-margin.d.ts +16 -16
  408. package/build/file/table/table-properties/table-cell-margin.spec.d.ts +1 -1
  409. package/build/file/table/table-properties/table-float-properties.d.ts +52 -52
  410. package/build/file/table/table-properties/table-float-properties.spec.d.ts +1 -1
  411. package/build/file/table/table-properties/table-layout.d.ts +8 -8
  412. package/build/file/table/table-properties/table-overlap.d.ts +8 -8
  413. package/build/file/table/table-properties/table-overlap.spec.d.ts +1 -1
  414. package/build/file/table/table-properties/table-properties.d.ts +23 -23
  415. package/build/file/table/table-properties/table-properties.spec.d.ts +1 -1
  416. package/build/file/table/table-row/index.d.ts +3 -3
  417. package/build/file/table/table-row/table-row-height.d.ts +18 -18
  418. package/build/file/table/table-row/table-row-properties.d.ts +13 -13
  419. package/build/file/table/table-row/table-row-properties.spec.d.ts +1 -1
  420. package/build/file/table/table-row/table-row.d.ts +16 -16
  421. package/build/file/table/table-row/table-row.spec.d.ts +1 -1
  422. package/build/file/table/table-width.d.ts +14 -14
  423. package/build/file/table/table.d.ts +23 -23
  424. package/build/file/table/table.spec.d.ts +1 -1
  425. package/build/file/table-of-contents/alias.d.ts +4 -4
  426. package/build/file/table-of-contents/field-instruction.d.ts +6 -6
  427. package/build/file/table-of-contents/index.d.ts +2 -2
  428. package/build/file/table-of-contents/sdt-content.d.ts +4 -4
  429. package/build/file/table-of-contents/sdt-properties.d.ts +4 -4
  430. package/build/file/table-of-contents/table-of-contents-properties.d.ts +23 -23
  431. package/build/file/table-of-contents/table-of-contents.d.ts +5 -5
  432. package/build/file/table-of-contents/table-of-contents.spec.d.ts +1 -1
  433. package/build/file/track-revision/index.d.ts +2 -2
  434. package/build/file/track-revision/track-revision-components/deleted-page-number.d.ts +10 -10
  435. package/build/file/track-revision/track-revision-components/deleted-page-number.spec.d.ts +1 -1
  436. package/build/file/track-revision/track-revision-components/deleted-text-run.d.ts +13 -13
  437. package/build/file/track-revision/track-revision-components/deleted-text-run.spec.d.ts +1 -1
  438. package/build/file/track-revision/track-revision-components/deleted-text.d.ts +4 -4
  439. package/build/file/track-revision/track-revision-components/deleted-text.spec.d.ts +1 -1
  440. package/build/file/track-revision/track-revision-components/inserted-text-run.d.ts +9 -9
  441. package/build/file/track-revision/track-revision-components/inserted-text-run.spec.d.ts +1 -1
  442. package/build/file/track-revision/track-revision.d.ts +13 -13
  443. package/build/file/values.d.ts +17 -17
  444. package/build/file/values.spec.d.ts +1 -1
  445. package/build/file/vertical-align/index.d.ts +1 -1
  446. package/build/file/vertical-align/vertical-align.d.ts +17 -17
  447. package/build/file/xml-components/attribute.spec.d.ts +1 -1
  448. package/build/file/xml-components/attributes.d.ts +46 -46
  449. package/build/file/xml-components/base.d.ts +12 -12
  450. package/build/file/xml-components/default-attributes.d.ts +12 -12
  451. package/build/file/xml-components/imported-xml-component.d.ts +14 -14
  452. package/build/file/xml-components/imported-xml-component.spec.d.ts +1 -1
  453. package/build/file/xml-components/index.d.ts +8 -8
  454. package/build/file/xml-components/initializable-xml-component.d.ts +4 -4
  455. package/build/file/xml-components/simple-elements.d.ts +16 -16
  456. package/build/file/xml-components/xml-component.d.ts +12 -12
  457. package/build/file/xml-components/xml-component.spec.d.ts +1 -1
  458. package/build/file/xml-components/xmlable-object.d.ts +7 -7
  459. package/build/import-dotx/import-dotx.d.ts +22 -22
  460. package/build/import-dotx/import-dotx.spec.d.ts +1 -1
  461. package/build/import-dotx/index.d.ts +1 -1
  462. package/build/index.d.ts +5 -5
  463. package/build/index.js +1 -1
  464. package/build/index.spec.d.ts +1 -1
  465. package/build/tests/utility.d.ts +3 -3
  466. package/package.json +100 -100
  467. package/src/export/packer/next-compiler.ts +409 -409
  468. package/src/file/document/body/section-properties/properties/column.ts +26 -26
  469. package/src/file/document/body/section-properties/properties/columns.spec.ts +38 -38
  470. package/src/file/document/body/section-properties/properties/columns.ts +47 -47
  471. package/src/file/document/body/section-properties/properties/index.ts +12 -12
  472. package/src/file/numbering/level.ts +181 -181
  473. package/src/file/numbering/numbering.spec.ts +137 -137
  474. package/src/file/numbering/numbering.ts +235 -235
  475. package/src/file/paragraph/formatting/break.spec.ts +65 -65
  476. package/src/file/paragraph/formatting/break.ts +43 -43
  477. package/src/file/paragraph/formatting/index.ts +8 -8
  478. package/src/file/paragraph/frame/frame-properties.ts +112 -112
  479. package/src/file/paragraph/links/bookmark.ts +43 -43
  480. package/src/file/paragraph/links/hyperlink.spec.ts +130 -130
  481. package/src/file/paragraph/links/hyperlink.ts +43 -43
  482. package/src/file/paragraph/links/index.ts +4 -4
  483. package/src/file/paragraph/links/pageref-field-instruction.spec.ts +24 -24
  484. package/src/file/paragraph/links/pageref-field-instruction.ts +25 -25
  485. package/src/file/paragraph/links/pageref-properties.ts +16 -16
  486. package/src/file/paragraph/links/pageref.spec.ts +76 -76
  487. package/src/file/paragraph/links/pageref.ts +13 -13
  488. package/src/file/paragraph/paragraph.spec.ts +989 -977
  489. package/src/file/paragraph/paragraph.ts +96 -96
  490. package/src/file/paragraph/properties.ts +190 -184
  491. package/src/file/table/table-width.ts +5 -1
  492. package/src/file/table/table.spec.ts +37 -2
  493. package/src/import-dotx/import-dotx.ts +263 -263
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- The MIT License (MIT)
2
-
3
- Copyright (c) 2016 Dolan
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Dolan
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,123 +1,120 @@
1
- <p align="center">
2
- <img alt="clippy the assistant" src="https://i.imgur.com/37uBGhO.gif">
3
- </p>
4
-
5
- <p align="center">
6
- Easily generate .docx files with JS/TS. Works for Node and on the Browser.
7
- </p>
8
-
9
- ---
10
-
11
- [![NPM version][npm-image]][npm-url]
12
- [![Downloads per month][downloads-image]][downloads-url]
13
- [![Build Status][travis-image]][travis-url]
14
- [![GitHub Action Workflow Status][github-actions-workflow-image]][github-actions-workflow-url]
15
- [![Dependency Status][daviddm-image]][daviddm-url]
16
- [![Known Vulnerabilities][snky-image]][snky-url]
17
- [![Chat on Gitter][gitter-image]][gitter-url]
18
- [![PRs Welcome][pr-image]][pr-url]
19
- [![codecov][codecov-image]][codecov-url]
20
-
21
- <p align="center">
22
- <img src="https://i.imgur.com/QeL1HuU.png" alt="drawing"/>
23
- </p>
24
-
25
- # Demo
26
-
27
- ## Browser
28
-
29
- Here are examples of `docx` being used with basic `HTML/JS` in a browser environment:
30
-
31
- * https://codepen.io/dolanmiu/pen/RwNeObg
32
- * https://jsfiddle.net/dolanmiu/onadx1gu/
33
-
34
- Here is an example of `docx` working in `Angular`:
35
-
36
- * https://stackblitz.com/edit/angular-docx
37
-
38
- Here is an example of `docx` working in `React`:
39
-
40
- * https://stackblitz.com/edit/react-docx
41
- * https://stackblitz.com/edit/react-docx-images (adding images to Word Document)
42
-
43
- Here is an example of `docx` working in `Vue.js`:
44
-
45
- * https://stackblitz.com/edit/vuejs-docx
46
-
47
- ## Node
48
-
49
- Press `endpoint` on the `RunKit` website:
50
-
51
- ![RunKit Instructions](https://user-images.githubusercontent.com/2917613/38582539-f84311b6-3d07-11e8-90db-5885ae02c3c4.png)
52
-
53
- * https://runkit.com/dolanmiu/docx-demo1 - Simple paragraph and text
54
- * https://runkit.com/dolanmiu/docx-demo2 - Advanced Paragraphs and text
55
- * https://runkit.com/dolanmiu/docx-demo3 - Bullet points
56
- * https://runkit.com/dolanmiu/docx-demo4 - Simple table
57
- * https://runkit.com/dolanmiu/docx-demo5 - Images
58
- * https://runkit.com/dolanmiu/docx-demo6 - Margins
59
- * https://runkit.com/dolanmiu/docx-demo7 - Landscape
60
- * https://runkit.com/dolanmiu/docx-demo8 - Header and Footer
61
- * https://runkit.com/dolanmiu/docx-demo10 - **My CV generated with docx**
62
-
63
- More [here](https://github.com/dolanmiu/docx/tree/master/demo)
64
-
65
- # How to use & Documentation
66
-
67
- Please refer to the [documentation at https://docx.js.org/](https://docx.js.org/) for details on how to use this library, examples and much more!
68
-
69
- # Examples
70
-
71
- Check the [demo folder](https://github.com/dolanmiu/docx/tree/master/demo) for examples.
72
-
73
- # Contributing
74
-
75
- Read the contribution guidelines [here](https://docx.js.org/#/contribution-guidelines).
76
-
77
- # Used by
78
-
79
- [<img src="https://i.imgur.com/zy5qWmI.png" alt="drawing" height="50"/>](https://hfour.com/)
80
- [<img src="https://i.imgur.com/OYP5tgS.png" alt="drawing" height="50"/>](https://fuzzproductions.com/)
81
- [<img src="https://i.imgur.com/zUDMfZ3.png" alt="drawing" height="50"/>](https://www.mettzer.com/)
82
- [<img src="https://i.imgur.com/wtNB1uq.png" alt="drawing" height="50"/>](https://www.wisedoc.net/)
83
- [<img src="https://i.imgur.com/suiH2zc.png" alt="drawing" height="50"/>](https://www.dabblewriter.com/)
84
- [<img src="https://i.imgur.com/1LjuK2M.png" alt="drawing" height="50"/>](https://turbopatent.com/)
85
- [<img src="https://i.imgur.com/dHMg0wF.gif" alt="drawing" height="50"/>](http://www.madisoncres.com/)
86
- [<img src="https://i.imgur.com/QEZXU5b.png" alt="drawing" height="50"/>](https://www.beekast.com/)
87
- [<img src="https://i.imgur.com/XVU6aoi.png" alt="drawing" height="50"/>](https://herraizsoto.com/)
88
- [<img src="https://i.imgur.com/fn1xccG.png" alt="drawing" height="50"/>](http://www.ativer.com.br/)
89
- [<img src="https://i.imgur.com/cmykN7c.png" alt="drawing" />](https://www.arity.co/)
90
- [<img src="https://i.imgur.com/PXo25um.png" alt="drawing" height="50"/>](https://www.circadianrisk.com/)
91
-
92
-
93
- ...and many more!
94
-
95
- ---
96
-
97
- [![patreon][patreon-image]][patreon-url]
98
- [![browserstack][browserstack-image]][browserstack-url]
99
-
100
- Made with 💖
101
-
102
- [npm-image]: https://badge.fury.io/js/docx.svg
103
- [npm-url]: https://npmjs.org/package/docx
104
- [downloads-image]: https://img.shields.io/npm/dm/docx.svg
105
- [downloads-url]: https://npmjs.org/package/docx
106
- [travis-image]: https://travis-ci.org/dolanmiu/docx.svg?branch=master
107
- [travis-url]: https://travis-ci.org/dolanmiu/docx
108
- [github-actions-workflow-image]: https://github.com/dolanmiu/docx/workflows/Default/badge.svg
109
- [github-actions-workflow-url]: https://github.com/dolanmiu/docx/actions
110
- [daviddm-image]: https://david-dm.org/dolanmiu/docx.svg?theme=shields.io
111
- [daviddm-url]: https://david-dm.org/dolanmiu/docx
112
- [snky-image]: https://snyk.io/test/github/dolanmiu/docx/badge.svg
113
- [snky-url]: https://snyk.io/test/github/dolanmiu/docx
114
- [gitter-image]: https://badges.gitter.im/dolanmiu/docx.svg
115
- [gitter-url]: https://gitter.im/docx-lib/Lobby
116
- [pr-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
117
- [pr-url]: http://makeapullrequest.com
118
- [codecov-image]: https://codecov.io/gh/dolanmiu/docx/branch/master/graph/badge.svg
119
- [codecov-url]: https://codecov.io/gh/dolanmiu/docx
120
- [patreon-image]: https://user-images.githubusercontent.com/2917613/51251459-4e880480-1991-11e9-92bf-38b96675a9e2.png
121
- [patreon-url]: https://www.patreon.com/dolanmiu
122
- [browserstack-image]: https://user-images.githubusercontent.com/2917613/54233552-128e9d00-4505-11e9-88fb-025a4e04007c.png
123
- [browserstack-url]: https://www.browserstack.com
1
+ <p align="center">
2
+ <img alt="clippy the assistant" src="https://i.imgur.com/37uBGhO.gif">
3
+ </p>
4
+
5
+ <p align="center">
6
+ Easily generate .docx files with JS/TS. Works for Node and on the Browser.
7
+ </p>
8
+
9
+ ---
10
+
11
+ [![NPM version][npm-image]][npm-url]
12
+ [![Downloads per month][downloads-image]][downloads-url]
13
+ [![GitHub Action Workflow Status][github-actions-workflow-image]][github-actions-workflow-url]
14
+ [![Dependency Status][daviddm-image]][daviddm-url]
15
+ [![Known Vulnerabilities][snky-image]][snky-url]
16
+ [![Chat on Gitter][gitter-image]][gitter-url]
17
+ [![PRs Welcome][pr-image]][pr-url]
18
+ [![codecov][codecov-image]][codecov-url]
19
+
20
+ <p align="center">
21
+ <img src="https://i.imgur.com/QeL1HuU.png" alt="drawing"/>
22
+ </p>
23
+
24
+ # Demo
25
+
26
+ ## Browser
27
+
28
+ Here are examples of `docx` being used with basic `HTML/JS` in a browser environment:
29
+
30
+ * https://codepen.io/dolanmiu/pen/RwNeObg
31
+ * https://jsfiddle.net/dolanmiu/onadx1gu/
32
+
33
+ Here is an example of `docx` working in `Angular`:
34
+
35
+ * https://stackblitz.com/edit/angular-docx
36
+
37
+ Here is an example of `docx` working in `React`:
38
+
39
+ * https://stackblitz.com/edit/react-docx
40
+ * https://stackblitz.com/edit/react-docx-images (adding images to Word Document)
41
+
42
+ Here is an example of `docx` working in `Vue.js`:
43
+
44
+ * https://stackblitz.com/edit/vuejs-docx
45
+
46
+ ## Node
47
+
48
+ Press `endpoint` on the `RunKit` website:
49
+
50
+ ![RunKit Instructions](https://user-images.githubusercontent.com/2917613/38582539-f84311b6-3d07-11e8-90db-5885ae02c3c4.png)
51
+
52
+ * https://runkit.com/dolanmiu/docx-demo1 - Simple paragraph and text
53
+ * https://runkit.com/dolanmiu/docx-demo2 - Advanced Paragraphs and text
54
+ * https://runkit.com/dolanmiu/docx-demo3 - Bullet points
55
+ * https://runkit.com/dolanmiu/docx-demo4 - Simple table
56
+ * https://runkit.com/dolanmiu/docx-demo5 - Images
57
+ * https://runkit.com/dolanmiu/docx-demo6 - Margins
58
+ * https://runkit.com/dolanmiu/docx-demo7 - Landscape
59
+ * https://runkit.com/dolanmiu/docx-demo8 - Header and Footer
60
+ * https://runkit.com/dolanmiu/docx-demo10 - **My CV generated with docx**
61
+
62
+ More [here](https://github.com/dolanmiu/docx/tree/master/demo)
63
+
64
+ # How to use & Documentation
65
+
66
+ Please refer to the [documentation at https://docx.js.org/](https://docx.js.org/) for details on how to use this library, examples and much more!
67
+
68
+ # Examples
69
+
70
+ Check the [demo folder](https://github.com/dolanmiu/docx/tree/master/demo) for examples.
71
+
72
+ # Contributing
73
+
74
+ Read the contribution guidelines [here](https://docx.js.org/#/contribution-guidelines).
75
+
76
+ # Used by
77
+
78
+ [<img src="https://i.imgur.com/zy5qWmI.png" alt="drawing" height="50"/>](https://hfour.com/)
79
+ [<img src="https://i.imgur.com/OYP5tgS.png" alt="drawing" height="50"/>](https://fuzzproductions.com/)
80
+ [<img src="https://i.imgur.com/zUDMfZ3.png" alt="drawing" height="50"/>](https://www.mettzer.com/)
81
+ [<img src="https://i.imgur.com/wtNB1uq.png" alt="drawing" height="50"/>](https://www.wisedoc.net/)
82
+ [<img src="https://i.imgur.com/suiH2zc.png" alt="drawing" height="50"/>](https://www.dabblewriter.com/)
83
+ [<img src="https://i.imgur.com/1LjuK2M.png" alt="drawing" height="50"/>](https://turbopatent.com/)
84
+ [<img src="https://i.imgur.com/dHMg0wF.gif" alt="drawing" height="50"/>](http://www.madisoncres.com/)
85
+ [<img src="https://i.imgur.com/QEZXU5b.png" alt="drawing" height="50"/>](https://www.beekast.com/)
86
+ [<img src="https://i.imgur.com/XVU6aoi.png" alt="drawing" height="50"/>](https://herraizsoto.com/)
87
+ [<img src="https://i.imgur.com/fn1xccG.png" alt="drawing" height="50"/>](http://www.ativer.com.br/)
88
+ [<img src="https://i.imgur.com/cmykN7c.png" alt="drawing" />](https://www.arity.co/)
89
+ [<img src="https://i.imgur.com/PXo25um.png" alt="drawing" height="50"/>](https://www.circadianrisk.com/)
90
+
91
+
92
+ ...and many more!
93
+
94
+ ---
95
+
96
+ [![patreon][patreon-image]][patreon-url]
97
+ [![browserstack][browserstack-image]][browserstack-url]
98
+
99
+ Made with 💖
100
+
101
+ [npm-image]: https://badge.fury.io/js/docx.svg
102
+ [npm-url]: https://npmjs.org/package/docx
103
+ [downloads-image]: https://img.shields.io/npm/dm/docx.svg
104
+ [downloads-url]: https://npmjs.org/package/docx
105
+ [github-actions-workflow-image]: https://github.com/dolanmiu/docx/workflows/Default/badge.svg
106
+ [github-actions-workflow-url]: https://github.com/dolanmiu/docx/actions
107
+ [daviddm-image]: https://david-dm.org/dolanmiu/docx.svg?theme=shields.io
108
+ [daviddm-url]: https://david-dm.org/dolanmiu/docx
109
+ [snky-image]: https://snyk.io/test/github/dolanmiu/docx/badge.svg
110
+ [snky-url]: https://snyk.io/test/github/dolanmiu/docx
111
+ [gitter-image]: https://badges.gitter.im/dolanmiu/docx.svg
112
+ [gitter-url]: https://gitter.im/docx-lib/Lobby
113
+ [pr-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
114
+ [pr-url]: http://makeapullrequest.com
115
+ [codecov-image]: https://codecov.io/gh/dolanmiu/docx/branch/master/graph/badge.svg
116
+ [codecov-url]: https://codecov.io/gh/dolanmiu/docx
117
+ [patreon-image]: https://user-images.githubusercontent.com/2917613/51251459-4e880480-1991-11e9-92bf-38b96675a9e2.png
118
+ [patreon-url]: https://www.patreon.com/dolanmiu
119
+ [browserstack-image]: https://user-images.githubusercontent.com/2917613/54233552-128e9d00-4505-11e9-88fb-025a4e04007c.png
120
+ [browserstack-url]: https://www.browserstack.com
@@ -1,4 +1,4 @@
1
- export declare const convertMillimetersToTwip: (millimeters: number) => number;
2
- export declare const convertInchesToTwip: (inches: number) => number;
3
- export declare const uniqueNumericId: () => number;
4
- export declare const uniqueId: () => string;
1
+ export declare const convertMillimetersToTwip: (millimeters: number) => number;
2
+ export declare const convertInchesToTwip: (inches: number) => number;
3
+ export declare const uniqueNumericId: () => number;
4
+ export declare const uniqueId: () => string;
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,4 +1,4 @@
1
- import { BaseXmlComponent, IContext, IXmlableObject } from "file/xml-components";
2
- export declare class Formatter {
3
- format(input: BaseXmlComponent, context?: IContext): IXmlableObject;
4
- }
1
+ import { BaseXmlComponent, IContext, IXmlableObject } from "../file/xml-components";
2
+ export declare class Formatter {
3
+ format(input: BaseXmlComponent, context?: IContext): IXmlableObject;
4
+ }
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1 +1 @@
1
- export * from "./packer/packer";
1
+ export * from "./packer/packer";
@@ -1,5 +1,5 @@
1
- import { IMediaData, Media } from "file/media";
2
- export declare class ImageReplacer {
3
- replace(xmlData: string, mediaData: IMediaData[], offset: number): string;
4
- getMediaData(xmlData: string, media: Media): IMediaData[];
5
- }
1
+ import { IMediaData, Media } from "../../file/media";
2
+ export declare class ImageReplacer {
3
+ replace(xmlData: string, mediaData: IMediaData[], offset: number): string;
4
+ getMediaData(xmlData: string, media: Media): IMediaData[];
5
+ }
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,10 +1,10 @@
1
- import * as JSZip from "jszip";
2
- import { File } from "file";
3
- export declare class Compiler {
4
- private readonly formatter;
5
- private readonly imageReplacer;
6
- private readonly numberingReplacer;
7
- constructor();
8
- compile(file: File, prettifyXml?: boolean): JSZip;
9
- private xmlifyFile;
10
- }
1
+ import * as JSZip from "jszip";
2
+ import { File } from "../../file";
3
+ export declare class Compiler {
4
+ private readonly formatter;
5
+ private readonly imageReplacer;
6
+ private readonly numberingReplacer;
7
+ constructor();
8
+ compile(file: File, prettifyXml?: boolean): JSZip;
9
+ private xmlifyFile;
10
+ }
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,4 +1,4 @@
1
- import { ConcreteNumbering } from "file";
2
- export declare class NumberingReplacer {
3
- replace(xmlData: string, concreteNumberings: ConcreteNumbering[]): string;
4
- }
1
+ import { ConcreteNumbering } from "../../file";
2
+ export declare class NumberingReplacer {
3
+ replace(xmlData: string, concreteNumberings: ConcreteNumbering[]): string;
4
+ }
@@ -1,8 +1,8 @@
1
- /// <reference types="node" />
2
- import { File } from "file";
3
- export declare class Packer {
4
- static toBuffer(file: File, prettify?: boolean): Promise<Buffer>;
5
- static toBase64String(file: File, prettify?: boolean): Promise<string>;
6
- static toBlob(file: File, prettify?: boolean): Promise<Blob>;
7
- private static readonly compiler;
8
- }
1
+ /// <reference types="node" />
2
+ import { File } from "../../file";
3
+ export declare class Packer {
4
+ static toBuffer(file: File, prettify?: boolean): Promise<Buffer>;
5
+ static toBase64String(file: File, prettify?: boolean): Promise<string>;
6
+ static toBlob(file: File, prettify?: boolean): Promise<Blob>;
7
+ private static readonly compiler;
8
+ }
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,10 +1,10 @@
1
- import { XmlAttributeComponent } from "file/xml-components";
2
- export declare class AppPropertiesAttributes extends XmlAttributeComponent<{
3
- readonly xmlns: string;
4
- readonly vt: string;
5
- }> {
6
- protected readonly xmlKeys: {
7
- xmlns: string;
8
- vt: string;
9
- };
10
- }
1
+ import { XmlAttributeComponent } from "../../file/xml-components";
2
+ export declare class AppPropertiesAttributes extends XmlAttributeComponent<{
3
+ readonly xmlns: string;
4
+ readonly vt: string;
5
+ }> {
6
+ protected readonly xmlKeys: {
7
+ xmlns: string;
8
+ vt: string;
9
+ };
10
+ }
@@ -1,4 +1,4 @@
1
- import { XmlComponent } from "file/xml-components";
2
- export declare class AppProperties extends XmlComponent {
3
- constructor();
4
- }
1
+ import { XmlComponent } from "../../file/xml-components";
2
+ export declare class AppProperties extends XmlComponent {
3
+ constructor();
4
+ }
@@ -1,39 +1,39 @@
1
- import { XmlComponent } from "file/xml-components";
2
- export interface IBorderOptions {
3
- readonly style: BorderStyle;
4
- readonly color?: string;
5
- readonly size?: number;
6
- readonly space?: number;
7
- }
8
- export declare class BorderElement extends XmlComponent {
9
- constructor(elementName: string, { color, size, space, style }: IBorderOptions);
10
- }
11
- export declare enum BorderStyle {
12
- SINGLE = "single",
13
- DASH_DOT_STROKED = "dashDotStroked",
14
- DASHED = "dashed",
15
- DASH_SMALL_GAP = "dashSmallGap",
16
- DOT_DASH = "dotDash",
17
- DOT_DOT_DASH = "dotDotDash",
18
- DOTTED = "dotted",
19
- DOUBLE = "double",
20
- DOUBLE_WAVE = "doubleWave",
21
- INSET = "inset",
22
- NIL = "nil",
23
- NONE = "none",
24
- OUTSET = "outset",
25
- THICK = "thick",
26
- THICK_THIN_LARGE_GAP = "thickThinLargeGap",
27
- THICK_THIN_MEDIUM_GAP = "thickThinMediumGap",
28
- THICK_THIN_SMALL_GAP = "thickThinSmallGap",
29
- THIN_THICK_LARGE_GAP = "thinThickLargeGap",
30
- THIN_THICK_MEDIUM_GAP = "thinThickMediumGap",
31
- THIN_THICK_SMALL_GAP = "thinThickSmallGap",
32
- THIN_THICK_THIN_LARGE_GAP = "thinThickThinLargeGap",
33
- THIN_THICK_THIN_MEDIUM_GAP = "thinThickThinMediumGap",
34
- THIN_THICK_THIN_SMALL_GAP = "thinThickThinSmallGap",
35
- THREE_D_EMBOSS = "threeDEmboss",
36
- THREE_D_ENGRAVE = "threeDEngrave",
37
- TRIPLE = "triple",
38
- WAVE = "wave"
39
- }
1
+ import { XmlComponent } from "../../file/xml-components";
2
+ export interface IBorderOptions {
3
+ readonly style: BorderStyle;
4
+ readonly color?: string;
5
+ readonly size?: number;
6
+ readonly space?: number;
7
+ }
8
+ export declare class BorderElement extends XmlComponent {
9
+ constructor(elementName: string, { color, size, space, style }: IBorderOptions);
10
+ }
11
+ export declare enum BorderStyle {
12
+ SINGLE = "single",
13
+ DASH_DOT_STROKED = "dashDotStroked",
14
+ DASHED = "dashed",
15
+ DASH_SMALL_GAP = "dashSmallGap",
16
+ DOT_DASH = "dotDash",
17
+ DOT_DOT_DASH = "dotDotDash",
18
+ DOTTED = "dotted",
19
+ DOUBLE = "double",
20
+ DOUBLE_WAVE = "doubleWave",
21
+ INSET = "inset",
22
+ NIL = "nil",
23
+ NONE = "none",
24
+ OUTSET = "outset",
25
+ THICK = "thick",
26
+ THICK_THIN_LARGE_GAP = "thickThinLargeGap",
27
+ THICK_THIN_MEDIUM_GAP = "thickThinMediumGap",
28
+ THICK_THIN_SMALL_GAP = "thickThinSmallGap",
29
+ THIN_THICK_LARGE_GAP = "thinThickLargeGap",
30
+ THIN_THICK_MEDIUM_GAP = "thinThickMediumGap",
31
+ THIN_THICK_SMALL_GAP = "thinThickSmallGap",
32
+ THIN_THICK_THIN_LARGE_GAP = "thinThickThinLargeGap",
33
+ THIN_THICK_THIN_MEDIUM_GAP = "thinThickThinMediumGap",
34
+ THIN_THICK_THIN_SMALL_GAP = "thinThickThinSmallGap",
35
+ THREE_D_EMBOSS = "threeDEmboss",
36
+ THREE_D_ENGRAVE = "threeDEngrave",
37
+ TRIPLE = "triple",
38
+ WAVE = "wave"
39
+ }
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1 +1 @@
1
- export * from "./border";
1
+ export * from "./border";
@@ -1,8 +1,8 @@
1
- import { XmlAttributeComponent } from "file/xml-components";
2
- export declare class ContentTypeAttributes extends XmlAttributeComponent<{
3
- readonly xmlns?: string;
4
- }> {
5
- protected readonly xmlKeys: {
6
- xmlns: string;
7
- };
8
- }
1
+ import { XmlAttributeComponent } from "../../file/xml-components";
2
+ export declare class ContentTypeAttributes extends XmlAttributeComponent<{
3
+ readonly xmlns?: string;
4
+ }> {
5
+ protected readonly xmlKeys: {
6
+ xmlns: string;
7
+ };
8
+ }
@@ -1,6 +1,6 @@
1
- import { XmlComponent } from "file/xml-components";
2
- export declare class ContentTypes extends XmlComponent {
3
- constructor();
4
- addFooter(index: number): void;
5
- addHeader(index: number): void;
6
- }
1
+ import { XmlComponent } from "../../file/xml-components";
2
+ export declare class ContentTypes extends XmlComponent {
3
+ constructor();
4
+ addFooter(index: number): void;
5
+ addHeader(index: number): void;
6
+ }
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,10 +1,10 @@
1
- import { XmlAttributeComponent } from "file/xml-components";
2
- export declare class DefaultAttributes extends XmlAttributeComponent<{
3
- readonly contentType: string;
4
- readonly extension?: string;
5
- }> {
6
- protected readonly xmlKeys: {
7
- contentType: string;
8
- extension: string;
9
- };
10
- }
1
+ import { XmlAttributeComponent } from "../../../file/xml-components";
2
+ export declare class DefaultAttributes extends XmlAttributeComponent<{
3
+ readonly contentType: string;
4
+ readonly extension?: string;
5
+ }> {
6
+ protected readonly xmlKeys: {
7
+ contentType: string;
8
+ extension: string;
9
+ };
10
+ }
@@ -1,4 +1,4 @@
1
- import { XmlComponent } from "file/xml-components";
2
- export declare class Default extends XmlComponent {
3
- constructor(contentType: string, extension?: string);
4
- }
1
+ import { XmlComponent } from "../../../file/xml-components";
2
+ export declare class Default extends XmlComponent {
3
+ constructor(contentType: string, extension?: string);
4
+ }
@@ -1,10 +1,10 @@
1
- import { XmlAttributeComponent } from "file/xml-components";
2
- export declare class OverrideAttributes extends XmlAttributeComponent<{
3
- readonly contentType: string;
4
- readonly partName?: string;
5
- }> {
6
- protected readonly xmlKeys: {
7
- contentType: string;
8
- partName: string;
9
- };
10
- }
1
+ import { XmlAttributeComponent } from "../../../file/xml-components";
2
+ export declare class OverrideAttributes extends XmlAttributeComponent<{
3
+ readonly contentType: string;
4
+ readonly partName?: string;
5
+ }> {
6
+ protected readonly xmlKeys: {
7
+ contentType: string;
8
+ partName: string;
9
+ };
10
+ }
@@ -1,4 +1,4 @@
1
- import { XmlComponent } from "file/xml-components";
2
- export declare class Override extends XmlComponent {
3
- constructor(contentType: string, partName?: string);
4
- }
1
+ import { XmlComponent } from "../../../file/xml-components";
2
+ export declare class Override extends XmlComponent {
3
+ constructor(contentType: string, partName?: string);
4
+ }
@@ -1 +1 @@
1
- export * from "./properties";
1
+ export * from "./properties";