Compare commits
300 Commits
Author | SHA1 | Date | |
---|---|---|---|
82bdb301f9 | |||
c7ea26e422 | |||
34b2029efe | |||
37e610d2b3 | |||
4882235d20 | |||
1552ebde11 | |||
d263d0c8a5 | |||
610b2388bb | |||
bcb16cef9b | |||
0f3afd94f3 | |||
60eb686d05 | |||
7f5e43fba9 | |||
ed52ef358b | |||
214afab711 | |||
18a1677588 | |||
cae372e9ad | |||
ea5f9a48ab | |||
dcf755e756 | |||
d445c21ea1 | |||
6db0449ed0 | |||
ae37b1980f | |||
96f76906c4 | |||
19d9619785 | |||
5be195fd91 | |||
e36e9e1cf4 | |||
102d6aa55c | |||
daea8d2868 | |||
700a74fd4c | |||
32a84a5ad0 | |||
3c9f9474ce | |||
1e10686315 | |||
cae6405d9a | |||
a884ce94e5 | |||
065c17de74 | |||
09db2c528a | |||
2adfe532dd | |||
6cbe40cecb | |||
6b9467393e | |||
5125e77431 | |||
ab68ae0092 | |||
38079b6171 | |||
d584290f3d | |||
9b9baa9b4a | |||
c258310560 | |||
af0bf5ced5 | |||
57c480a6c6 | |||
25f7423533 | |||
0c068bb03b | |||
1822473abc | |||
93a7d607b2 | |||
d45213636c | |||
e196d9d917 | |||
cf88e50afd | |||
64e5814c31 | |||
37251c84f8 | |||
a576098639 | |||
2450fe83ce | |||
e1004440d2 | |||
491c7abd1c | |||
364ce6d856 | |||
ffb6b73bb7 | |||
6041c39a26 | |||
c54f0a52f6 | |||
6b87d9c038 | |||
1285304f97 | |||
58fae6b201 | |||
dc1f3aebe9 | |||
8a189161f2 | |||
6667595627 | |||
33befaab09 | |||
c91f135c28 | |||
08f9926e60 | |||
f323b293fb | |||
adc91929b0 | |||
c63cba5a0c | |||
7a48da440b | |||
05dda37b71 | |||
ee43585210 | |||
a6eb8e01df | |||
8c45c30753 | |||
d18cfbc26f | |||
f4af5f9e33 | |||
69adbbc1c1 | |||
4f6a9f734c | |||
8b78f2d200 | |||
26a3fa6946 | |||
f955a18936 | |||
ee1a7818b6 | |||
8e455f1097 | |||
827c46cf47 | |||
61cbee829d | |||
f0ad1e9194 | |||
bbd339f0e4 | |||
858af64dc3 | |||
01e34c1b28 | |||
41acb475a9 | |||
20978f8c24 | |||
265a3dbe21 | |||
627f5b4bf0 | |||
1538c1aaeb | |||
839661e5f8 | |||
fff6244597 | |||
b2280f64a1 | |||
21d53c41d0 | |||
6e94bbb5e5 | |||
7d655cd3f7 | |||
00821677c8 | |||
784de3e430 | |||
3213c4838d | |||
1b9bc8eb1d | |||
bf58d0b864 | |||
28ca8392ed | |||
5238c55bc2 | |||
901f10c387 | |||
defa22ffe5 | |||
84919c0cc0 | |||
1e8ca123b0 | |||
3ae7c6aedf | |||
6a3ed4bbf8 | |||
e632d323c9 | |||
d2b35ab8f2 | |||
e60f39df41 | |||
076431e04d | |||
75ab44403c | |||
e2d6097819 | |||
ab12ff1257 | |||
25a0212f4e | |||
a8993f14d6 | |||
1834cd86da | |||
437de27ed8 | |||
96f08482da | |||
edec2eca7a | |||
9202524d83 | |||
0461907533 | |||
445a2896d2 | |||
e2d8f1b6b1 | |||
7baa696a76 | |||
3f7ca6bbff | |||
36e1c5fe6a | |||
75a03f1576 | |||
437e83ab78 | |||
b8232f7a02 | |||
49eadb0efc | |||
40dc90e585 | |||
0de302d192 | |||
80bab95f6c | |||
ba3d551c9f | |||
d14fe31f97 | |||
057f41e355 | |||
8c9b61b37a | |||
11e54b3e2c | |||
fa7cb0bef1 | |||
3977c8ab3b | |||
e8f92efe05 | |||
994df8531b | |||
3cdf96ee0c | |||
e2f55d52e9 | |||
d6fa33035a | |||
f11bca728f | |||
596761d78d | |||
8a3c8d4664 | |||
fdfce79e87 | |||
88340aa336 | |||
d0f53fdd4b | |||
d657f61e11 | |||
20e6b98770 | |||
5ae824358c | |||
3ea106bd22 | |||
538264dec5 | |||
6bcd1c2c24 | |||
120c3a7bbe | |||
2654799822 | |||
6245635b86 | |||
b4f1c4dd6a | |||
25a7ce3742 | |||
08bc069cbf | |||
0ebdcc30ed | |||
3eca81d3f5 | |||
faefbae3a1 | |||
370fb098ac | |||
c73019d84c | |||
250a1de71e | |||
012963e90a | |||
632f3cd19b | |||
1c8cd325d7 | |||
7bcdaab2f2 | |||
5b58e520f9 | |||
78f6ea6c44 | |||
b5172e73f9 | |||
5cf534ad26 | |||
d53cdb0558 | |||
212adbbffb | |||
99ab2f0ef5 | |||
a8201b2658 | |||
f13e676c3b | |||
61b01836bc | |||
2ee918b845 | |||
e9579d75c4 | |||
97824f1bb5 | |||
884c134b25 | |||
4f3cb49076 | |||
152285ed5a | |||
49b7ac212d | |||
83450e6277 | |||
6d6155c742 | |||
f8da2c311b | |||
f6bcaef5b5 | |||
1a9e71bfa1 | |||
3591e11637 | |||
47533cf4e2 | |||
de03f19b46 | |||
d1472368f6 | |||
b83d2c388f | |||
ee5425bef7 | |||
3fdbca939e | |||
c68dc8c52a | |||
96471ecb45 | |||
a13f898ad3 | |||
b4cce534a5 | |||
e0698554ad | |||
1649d2a0fa | |||
9683e89159 | |||
2bece0bb61 | |||
deb6c42d86 | |||
2b0953bb19 | |||
d25d22508c | |||
6db37eb4fb | |||
af461f8418 | |||
8bdbd1de39 | |||
1bdc93ef59 | |||
c12101fbc6 | |||
d5ba6578b3 | |||
b37aefdc8d | |||
0be7c26798 | |||
bf1d10e893 | |||
7dfb016faa | |||
b2aeb2d83c | |||
8f4c78e2a8 | |||
bd1f5898a8 | |||
05a4ef1702 | |||
da9e6d6664 | |||
e9d3853d93 | |||
5a9d6120a5 | |||
e8410ff692 | |||
3427d220c7 | |||
643e3c2f84 | |||
9b40b5e55e | |||
a622c210ef | |||
9495f30e2d | |||
617af87065 | |||
9aab68a8f8 | |||
c1dd421b27 | |||
8eff6bd0cf | |||
8566c64eab | |||
afd468277e | |||
ca9c992237 | |||
c93b74661b | |||
08ff092638 | |||
2276572902 | |||
43ddeec6e1 | |||
9eaf04f4c7 | |||
c3c29bb119 | |||
ddb34e6a46 | |||
ef3055430b | |||
75cdae1473 | |||
860afe8f28 | |||
f685dbe0d1 | |||
50911fff57 | |||
a7064f4728 | |||
564e9600ea | |||
fcc4202598 | |||
bfbe59cb84 | |||
06abde2425 | |||
75c3c2f985 | |||
fefefdd473 | |||
db59474f1e | |||
1d5e806ff4 | |||
bf4885c7cf | |||
3b289be5ce | |||
2bb7e08ade | |||
b571a7550f | |||
721de30587 | |||
f16126e948 | |||
40d1a3a7c2 | |||
0d4c7a5fc0 | |||
5d401dfb27 | |||
a37c9d8f2f | |||
10ab3c70bf | |||
591b2f4e04 | |||
2536fbe752 | |||
33549d5ec3 | |||
720c6172e3 | |||
bbad2f5cde | |||
d2a0baa221 | |||
ad62f5459b | |||
dfb910defb | |||
04b6d8e54a | |||
d2dded860d | |||
4f8d435e16 | |||
a1b9be453b |
12
.github/FUNDING.yml
vendored
Normal file
12
.github/FUNDING.yml
vendored
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
# These are supported funding model platforms
|
||||||
|
|
||||||
|
github: dolanmiu
|
||||||
|
patreon: dolanmiu
|
||||||
|
open_collective: # Replace with a single Open Collective username
|
||||||
|
ko_fi: # Replace with a single Ko-fi username
|
||||||
|
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
||||||
|
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
||||||
|
liberapay: # Replace with a single Liberapay username
|
||||||
|
issuehunt: # Replace with a single IssueHunt username
|
||||||
|
otechie: # Replace with a single Otechie username
|
||||||
|
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
|
1
.gitignore
vendored
1
.gitignore
vendored
@ -52,7 +52,6 @@ docs/.nojekyll
|
|||||||
.idea
|
.idea
|
||||||
|
|
||||||
# Lock files
|
# Lock files
|
||||||
package-lock.json
|
|
||||||
yarn.lock
|
yarn.lock
|
||||||
|
|
||||||
# Documents
|
# Documents
|
||||||
|
11
.nycrc
11
.nycrc
@ -1,14 +1,15 @@
|
|||||||
{
|
{
|
||||||
"check-coverage": true,
|
"check-coverage": true,
|
||||||
"lines": 92.34,
|
"lines": 96.81,
|
||||||
"functions": 88.27,
|
"functions": 93.80,
|
||||||
"branches": 84.64,
|
"branches": 92.63,
|
||||||
"statements": 92.15,
|
"statements": 96.80,
|
||||||
"include": [
|
"include": [
|
||||||
"src/**/*.ts"
|
"src/**/*.ts"
|
||||||
],
|
],
|
||||||
"exclude": [
|
"exclude": [
|
||||||
"src/**/*.spec.ts"
|
"src/**/*.spec.ts",
|
||||||
|
"src/import-dotx/import-dotx.ts"
|
||||||
],
|
],
|
||||||
"reporter": [
|
"reporter": [
|
||||||
"lcov",
|
"lcov",
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
language: node_js
|
language: node_js
|
||||||
node_js:
|
node_js:
|
||||||
- 9
|
- 10
|
||||||
install:
|
install:
|
||||||
- npm install
|
- npm install
|
||||||
- npm install -g codecov
|
- npm install -g codecov
|
||||||
@ -10,7 +10,7 @@ script:
|
|||||||
- npm run style
|
- npm run style
|
||||||
- npm run build
|
- npm run build
|
||||||
- npm run ts-node -- ./demo/1-basic.ts
|
- npm run ts-node -- ./demo/1-basic.ts
|
||||||
- npm run e2e "My Document.docx"
|
# - npm run e2e "My Document.docx"
|
||||||
- npm run ts-node -- ./demo/2-declaritive-styles.ts
|
- npm run ts-node -- ./demo/2-declaritive-styles.ts
|
||||||
- npm run ts-node -- ./demo/3-numbering-and-bullet-points.ts
|
- npm run ts-node -- ./demo/3-numbering-and-bullet-points.ts
|
||||||
- npm run ts-node -- ./demo/4-basic-table.ts
|
- npm run ts-node -- ./demo/4-basic-table.ts
|
||||||
@ -20,7 +20,7 @@ script:
|
|||||||
- npm run ts-node -- ./demo/8-header-footer.ts
|
- npm run ts-node -- ./demo/8-header-footer.ts
|
||||||
- npm run ts-node -- ./demo/9-images-in-header-and-footer.ts
|
- npm run ts-node -- ./demo/9-images-in-header-and-footer.ts
|
||||||
- npm run ts-node -- ./demo/10-my-cv.ts
|
- npm run ts-node -- ./demo/10-my-cv.ts
|
||||||
- npm run e2e "My Document.docx"
|
# - npm run e2e "My Document.docx"
|
||||||
- npm run ts-node -- ./demo/11-declaritive-styles-2.ts
|
- npm run ts-node -- ./demo/11-declaritive-styles-2.ts
|
||||||
- npm run ts-node -- ./demo/12-scaling-images.ts
|
- npm run ts-node -- ./demo/12-scaling-images.ts
|
||||||
- npm run ts-node -- ./demo/13-xml-styles.ts
|
- npm run ts-node -- ./demo/13-xml-styles.ts
|
||||||
|
23
README.md
23
README.md
@ -18,7 +18,7 @@
|
|||||||
[![codecov][codecov-image]][codecov-url]
|
[![codecov][codecov-image]][codecov-url]
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="https://i.imgur.com/H5FA1Qy.gif" alt="drawing" width="800"/>
|
<img src="https://i.imgur.com/TCH0YzD.png" alt="drawing" width="800"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
# Demo
|
# Demo
|
||||||
@ -27,13 +27,22 @@
|
|||||||
|
|
||||||
Here are examples of `docx` being used with basic `HTML/JS` in a browser environment:
|
Here are examples of `docx` being used with basic `HTML/JS` in a browser environment:
|
||||||
|
|
||||||
* https://codepen.io/anon/pen/dqoVgQ
|
* https://codepen.io/dolanmiu/pen/RwNeObg
|
||||||
* https://jsfiddle.net/3xhezb5w/2
|
* https://jsfiddle.net/dolanmiu/kqxrj35u/1/
|
||||||
|
|
||||||
Here is an example of `docx` working in `Angular`:
|
Here is an example of `docx` working in `Angular`:
|
||||||
|
|
||||||
* https://stackblitz.com/edit/angular-afvxtz
|
* https://stackblitz.com/edit/angular-afvxtz
|
||||||
|
|
||||||
|
Here is an example of `docx` working in `React`:
|
||||||
|
|
||||||
|
* https://stackblitz.com/edit/react-ts-qq25sp
|
||||||
|
* https://stackblitz.com/edit/react-ts-qdqu7z (adding images to Word Document)
|
||||||
|
|
||||||
|
Here is an example of `docx` working in `Vue.js`:
|
||||||
|
|
||||||
|
* https://stackblitz.com/edit/vuejs-docx
|
||||||
|
|
||||||
## Node
|
## Node
|
||||||
|
|
||||||
Press `endpoint` on the `RunKit` website:
|
Press `endpoint` on the `RunKit` website:
|
||||||
@ -50,7 +59,7 @@ Press `endpoint` on the `RunKit` website:
|
|||||||
* https://runkit.com/dolanmiu/docx-demo8 - Header and Footer
|
* https://runkit.com/dolanmiu/docx-demo8 - Header and Footer
|
||||||
* https://runkit.com/dolanmiu/docx-demo10 - **My CV generated with docx**
|
* https://runkit.com/dolanmiu/docx-demo10 - **My CV generated with docx**
|
||||||
|
|
||||||
More [here](https://docx.js.org/#/examples) and [here](https://github.com/dolanmiu/docx/tree/master/demo)
|
More [here](https://github.com/dolanmiu/docx/tree/master/demo)
|
||||||
|
|
||||||
# How to use & Documentation
|
# How to use & Documentation
|
||||||
|
|
||||||
@ -58,7 +67,7 @@ Please refer to the [documentation at https://docx.js.org/](https://docx.js.org/
|
|||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
Check the `examples` section in the [documentation](https://docx.js.org/#/examples) and the [demo folder](https://github.com/dolanmiu/docx/tree/master/demo) for examples.
|
Check the [demo folder](https://github.com/dolanmiu/docx/tree/master/demo) for examples.
|
||||||
|
|
||||||
# Contributing
|
# Contributing
|
||||||
|
|
||||||
@ -73,6 +82,10 @@ Read the contribution guidelines [here](https://docx.js.org/#/contribution-guide
|
|||||||
[<img src="https://i.imgur.com/suiH2zc.png" alt="drawing" height="50"/>](https://www.dabblewriter.com/)
|
[<img src="https://i.imgur.com/suiH2zc.png" alt="drawing" height="50"/>](https://www.dabblewriter.com/)
|
||||||
[<img src="https://i.imgur.com/1LjuK2M.png" alt="drawing" height="50"/>](https://turbopatent.com/)
|
[<img src="https://i.imgur.com/1LjuK2M.png" alt="drawing" height="50"/>](https://turbopatent.com/)
|
||||||
[<img src="https://i.imgur.com/dHMg0wF.gif" alt="drawing" height="50"/>](http://www.madisoncres.com/)
|
[<img src="https://i.imgur.com/dHMg0wF.gif" alt="drawing" height="50"/>](http://www.madisoncres.com/)
|
||||||
|
[<img src="https://i.imgur.com/QEZXU5b.png" alt="drawing" height="50"/>](https://www.beekast.com/)
|
||||||
|
[<img src="https://imgur.com/XVU6aoi.png" alt="drawing" height="50"/>](https://herraizsoto.com/)
|
||||||
|
[<img src="https://i.imgur.com/fn1xccG.png" alt="drawing" height="50"/>](http://www.ativer.com.br/)
|
||||||
|
|
||||||
|
|
||||||
...and many more!
|
...and many more!
|
||||||
|
|
||||||
|
@ -16,9 +16,9 @@ doc.addSection({
|
|||||||
bold: true,
|
bold: true,
|
||||||
}),
|
}),
|
||||||
new TextRun({
|
new TextRun({
|
||||||
text: "Github is the best",
|
text: "\tGithub is the best",
|
||||||
bold: true,
|
bold: true,
|
||||||
}).tab(),
|
}),
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
// Generate a CV
|
// Generate a CV
|
||||||
// Import from 'docx' rather than '../build' if you install from npm
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { AlignmentType, Document, HeadingLevel, Packer, Paragraph, TextRun } from "../build";
|
import { AlignmentType, Document, HeadingLevel, Packer, Paragraph, TabStopPosition, TabStopType, TextRun } from "../build";
|
||||||
|
|
||||||
// tslint:disable:no-shadowed-variable
|
// tslint:disable:no-shadowed-variable
|
||||||
|
|
||||||
@ -226,18 +226,21 @@ class DocumentCreator {
|
|||||||
|
|
||||||
public createInstitutionHeader(institutionName: string, dateText: string): Paragraph {
|
public createInstitutionHeader(institutionName: string, dateText: string): Paragraph {
|
||||||
return new Paragraph({
|
return new Paragraph({
|
||||||
tabStop: {
|
tabStops: [
|
||||||
maxRight: {},
|
{
|
||||||
},
|
type: TabStopType.RIGHT,
|
||||||
|
position: TabStopPosition.MAX,
|
||||||
|
},
|
||||||
|
],
|
||||||
children: [
|
children: [
|
||||||
new TextRun({
|
new TextRun({
|
||||||
text: institutionName,
|
text: institutionName,
|
||||||
bold: true,
|
bold: true,
|
||||||
}),
|
}),
|
||||||
new TextRun({
|
new TextRun({
|
||||||
text: dateText,
|
text: `\t${dateText}`,
|
||||||
bold: true,
|
bold: true,
|
||||||
}).tab(),
|
}),
|
||||||
],
|
],
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
@ -1,82 +1,153 @@
|
|||||||
// Setting styles with JavaScript configuration
|
// Setting styles with JavaScript configuration
|
||||||
// Import from 'docx' rather than '../build' if you install from npm
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { AlignmentType, Document, Footer, HeadingLevel, Media, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
|
import {
|
||||||
|
AlignmentType,
|
||||||
|
Document,
|
||||||
|
Footer,
|
||||||
|
HeadingLevel,
|
||||||
|
Media,
|
||||||
|
Packer,
|
||||||
|
Paragraph,
|
||||||
|
Table,
|
||||||
|
TableCell,
|
||||||
|
TableRow,
|
||||||
|
TabStopPosition,
|
||||||
|
UnderlineType,
|
||||||
|
} from "../build";
|
||||||
|
|
||||||
const doc = new Document();
|
const doc = new Document({
|
||||||
|
styles: {
|
||||||
doc.Styles.createParagraphStyle("Heading1", "Heading 1")
|
paragraphStyles: [
|
||||||
.basedOn("Normal")
|
{
|
||||||
.next("Normal")
|
id: "Heading1",
|
||||||
.quickFormat()
|
name: "Heading 1",
|
||||||
.font("Calibri")
|
basedOn: "Normal",
|
||||||
.size(52)
|
next: "Normal",
|
||||||
.center()
|
quickFormat: true,
|
||||||
.bold()
|
run: {
|
||||||
.color("000000")
|
font: "Calibri",
|
||||||
.spacing({ line: 340 })
|
size: 52,
|
||||||
.underline("single", "000000");
|
bold: true,
|
||||||
|
color: "000000",
|
||||||
doc.Styles.createParagraphStyle("Heading2", "Heading 2")
|
underline: {
|
||||||
.basedOn("Normal")
|
type: UnderlineType.SINGLE,
|
||||||
.next("Normal")
|
color: "000000",
|
||||||
.font("Calibri")
|
},
|
||||||
.quickFormat()
|
},
|
||||||
.size(26)
|
paragraph: {
|
||||||
.bold()
|
alignment: AlignmentType.CENTER,
|
||||||
.spacing({ line: 340 });
|
spacing: { line: 340 },
|
||||||
|
},
|
||||||
doc.Styles.createParagraphStyle("Heading3", "Heading 3")
|
},
|
||||||
.basedOn("Normal")
|
{
|
||||||
.next("Normal")
|
id: "Heading2",
|
||||||
.font("Calibri")
|
name: "Heading 2",
|
||||||
.quickFormat()
|
basedOn: "Normal",
|
||||||
.size(26)
|
next: "Normal",
|
||||||
.bold()
|
quickFormat: true,
|
||||||
.spacing({ line: 276 });
|
run: {
|
||||||
|
font: "Calibri",
|
||||||
doc.Styles.createParagraphStyle("Heading4", "Heading 4")
|
size: 26,
|
||||||
.basedOn("Normal")
|
bold: true,
|
||||||
.next("Normal")
|
},
|
||||||
.justified()
|
paragraph: {
|
||||||
.font("Calibri")
|
spacing: { line: 340 },
|
||||||
.size(26)
|
},
|
||||||
.bold();
|
},
|
||||||
|
{
|
||||||
doc.Styles.createParagraphStyle("normalPara", "Normal Para")
|
id: "Heading3",
|
||||||
.basedOn("Normal")
|
name: "Heading 3",
|
||||||
.next("Normal")
|
basedOn: "Normal",
|
||||||
.font("Calibri")
|
next: "Normal",
|
||||||
.quickFormat()
|
quickFormat: true,
|
||||||
.leftTabStop(453.543307087)
|
run: {
|
||||||
.maxRightTabStop()
|
font: "Calibri",
|
||||||
.size(26)
|
size: 26,
|
||||||
.spacing({ line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 });
|
bold: true,
|
||||||
|
},
|
||||||
doc.Styles.createParagraphStyle("normalPara2", "Normal Para2")
|
paragraph: {
|
||||||
.basedOn("Normal")
|
spacing: { line: 276 },
|
||||||
.next("Normal")
|
},
|
||||||
.quickFormat()
|
},
|
||||||
.font("Calibri")
|
{
|
||||||
.size(26)
|
id: "Heading4",
|
||||||
.justified()
|
name: "Heading 4",
|
||||||
.spacing({ line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 });
|
basedOn: "Normal",
|
||||||
|
next: "Normal",
|
||||||
doc.Styles.createParagraphStyle("aside", "Aside")
|
quickFormat: true,
|
||||||
.basedOn("Normal")
|
run: {
|
||||||
.next("Normal")
|
font: "Calibri",
|
||||||
.color("999999")
|
size: 26,
|
||||||
.italics()
|
bold: true,
|
||||||
.indent({ left: 720 })
|
},
|
||||||
.spacing({ line: 276 });
|
paragraph: {
|
||||||
|
alignment: AlignmentType.JUSTIFIED,
|
||||||
doc.Styles.createParagraphStyle("wellSpaced", "Well Spaced")
|
},
|
||||||
.basedOn("Normal")
|
},
|
||||||
.spacing({ line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 });
|
{
|
||||||
|
id: "normalPara",
|
||||||
doc.Styles.createParagraphStyle("ListParagraph", "List Paragraph")
|
name: "Normal Para",
|
||||||
.quickFormat()
|
basedOn: "Normal",
|
||||||
.basedOn("Normal");
|
next: "Normal",
|
||||||
|
quickFormat: true,
|
||||||
|
run: {
|
||||||
|
font: "Calibri",
|
||||||
|
size: 26,
|
||||||
|
bold: true,
|
||||||
|
},
|
||||||
|
paragraph: {
|
||||||
|
spacing: { line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 },
|
||||||
|
rightTabStop: TabStopPosition.MAX,
|
||||||
|
leftTabStop: 453.543307087,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: "normalPara2",
|
||||||
|
name: "Normal Para2",
|
||||||
|
basedOn: "Normal",
|
||||||
|
next: "Normal",
|
||||||
|
quickFormat: true,
|
||||||
|
run: {
|
||||||
|
font: "Calibri",
|
||||||
|
size: 26,
|
||||||
|
},
|
||||||
|
paragraph: {
|
||||||
|
alignment: AlignmentType.JUSTIFIED,
|
||||||
|
spacing: { line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: "aside",
|
||||||
|
name: "Aside",
|
||||||
|
basedOn: "Normal",
|
||||||
|
next: "Normal",
|
||||||
|
run: {
|
||||||
|
color: "999999",
|
||||||
|
italics: true,
|
||||||
|
},
|
||||||
|
paragraph: {
|
||||||
|
spacing: { line: 276 },
|
||||||
|
indent: { left: 720 },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: "wellSpaced",
|
||||||
|
name: "Well Spaced",
|
||||||
|
basedOn: "Normal",
|
||||||
|
paragraph: {
|
||||||
|
spacing: { line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: "ListParagraph",
|
||||||
|
name: "List Paragraph",
|
||||||
|
basedOn: "Normal",
|
||||||
|
quickFormat: true,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
const image = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
|
const image = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
|
||||||
|
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
// Page numbers
|
// Page numbers
|
||||||
// Import from 'docx' rather than '../build' if you install from npm
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { AlignmentType, Document, Header, Packer, Paragraph, TextRun } from "../build";
|
import { AlignmentType, Document, Header, Packer, PageBreak, PageNumber, Paragraph, TextRun } from "../build";
|
||||||
|
|
||||||
const doc = new Document();
|
const doc = new Document();
|
||||||
|
|
||||||
@ -11,7 +11,12 @@ doc.addSection({
|
|||||||
children: [
|
children: [
|
||||||
new Paragraph({
|
new Paragraph({
|
||||||
alignment: AlignmentType.RIGHT,
|
alignment: AlignmentType.RIGHT,
|
||||||
children: [new TextRun("My Title "), new TextRun("Page ").pageNumber()],
|
children: [
|
||||||
|
new TextRun("My Title "),
|
||||||
|
new TextRun({
|
||||||
|
children: ["Page ", PageNumber.CURRENT],
|
||||||
|
}),
|
||||||
|
],
|
||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
@ -19,15 +24,20 @@ doc.addSection({
|
|||||||
children: [
|
children: [
|
||||||
new Paragraph({
|
new Paragraph({
|
||||||
alignment: AlignmentType.RIGHT,
|
alignment: AlignmentType.RIGHT,
|
||||||
children: [new TextRun("First Page Header "), new TextRun("Page ").pageNumber()],
|
children: [
|
||||||
|
new TextRun("First Page Header "),
|
||||||
|
new TextRun({
|
||||||
|
children: ["Page ", PageNumber.CURRENT],
|
||||||
|
}),
|
||||||
|
],
|
||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
},
|
},
|
||||||
children: [
|
children: [
|
||||||
new Paragraph({
|
new Paragraph({
|
||||||
text: "First Page",
|
children: [new TextRun("First Page"), new PageBreak()],
|
||||||
}).pageBreak(),
|
}),
|
||||||
new Paragraph("Second Page"),
|
new Paragraph("Second Page"),
|
||||||
],
|
],
|
||||||
});
|
});
|
||||||
|
@ -1,12 +1,12 @@
|
|||||||
// Multiple sections and headers
|
// Multiple sections and headers
|
||||||
// Import from 'docx' rather than '../build' if you install from npm
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { Document, Footer, Header, Packer, PageNumberFormat, PageOrientation, Paragraph, TextRun } from "../build";
|
import { Document, Footer, Header, Packer, PageNumber, PageNumberFormat, PageOrientation, Paragraph, TextRun } from "../build";
|
||||||
|
|
||||||
const doc = new Document();
|
const doc = new Document();
|
||||||
|
|
||||||
doc.addSection({
|
doc.addSection({
|
||||||
children: [new Paragraph("Hello World").pageBreak()],
|
children: [new Paragraph("Hello World")],
|
||||||
});
|
});
|
||||||
|
|
||||||
doc.addSection({
|
doc.addSection({
|
||||||
@ -53,7 +53,11 @@ doc.addSection({
|
|||||||
default: new Header({
|
default: new Header({
|
||||||
children: [
|
children: [
|
||||||
new Paragraph({
|
new Paragraph({
|
||||||
children: [new TextRun("Page number: ").pageNumber()],
|
children: [
|
||||||
|
new TextRun({
|
||||||
|
children: ["Page number: ", PageNumber.CURRENT],
|
||||||
|
}),
|
||||||
|
],
|
||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
@ -69,7 +73,11 @@ doc.addSection({
|
|||||||
default: new Header({
|
default: new Header({
|
||||||
children: [
|
children: [
|
||||||
new Paragraph({
|
new Paragraph({
|
||||||
children: [new TextRun("Page number: ").pageNumber()],
|
children: [
|
||||||
|
new TextRun({
|
||||||
|
children: ["Page number: ", PageNumber.CURRENT],
|
||||||
|
}),
|
||||||
|
],
|
||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
@ -90,7 +98,11 @@ doc.addSection({
|
|||||||
default: new Header({
|
default: new Header({
|
||||||
children: [
|
children: [
|
||||||
new Paragraph({
|
new Paragraph({
|
||||||
children: [new TextRun("Page number: ").pageNumber()],
|
children: [
|
||||||
|
new TextRun({
|
||||||
|
children: ["Page number: ", PageNumber.CURRENT],
|
||||||
|
}),
|
||||||
|
],
|
||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
|
@ -1,16 +1,54 @@
|
|||||||
// Footnotes
|
// Footnotes
|
||||||
// Import from 'docx' rather than '../build' if you install from npm
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { Document, Packer, Paragraph } from "../build";
|
import { Document, FootnoteReferenceRun, Packer, Paragraph, TextRun } from "../build";
|
||||||
|
|
||||||
const doc = new Document();
|
const doc = new Document({
|
||||||
|
footnotes: [
|
||||||
doc.addSection({
|
new Paragraph("Foo"),
|
||||||
children: [new Paragraph("Hello World").referenceFootnote(1), new Paragraph("Hello World").referenceFootnote(2)],
|
new Paragraph("Test"),
|
||||||
|
new Paragraph("My amazing reference"),
|
||||||
|
new Paragraph("Foo1"),
|
||||||
|
new Paragraph("Test1"),
|
||||||
|
new Paragraph("My amazing reference1"),
|
||||||
|
],
|
||||||
});
|
});
|
||||||
|
|
||||||
doc.createFootnote(new Paragraph("Test"));
|
doc.addSection({
|
||||||
doc.createFootnote(new Paragraph("My amazing reference"));
|
children: [
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new TextRun({
|
||||||
|
children: ["Hello", new FootnoteReferenceRun(1)],
|
||||||
|
}),
|
||||||
|
new TextRun({
|
||||||
|
children: [" World!", new FootnoteReferenceRun(2)],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [new TextRun("Hello World"), new FootnoteReferenceRun(3)],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
doc.addSection({
|
||||||
|
children: [
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new TextRun({
|
||||||
|
children: ["Hello", new FootnoteReferenceRun(4)],
|
||||||
|
}),
|
||||||
|
new TextRun({
|
||||||
|
children: [" World!", new FootnoteReferenceRun(5)],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [new TextRun("Hello World"), new FootnoteReferenceRun(6)],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
Packer.toBuffer(doc).then((buffer) => {
|
Packer.toBuffer(doc).then((buffer) => {
|
||||||
fs.writeFileSync("My Document.docx", buffer);
|
fs.writeFileSync("My Document.docx", buffer);
|
||||||
|
@ -15,9 +15,9 @@ doc.addSection({
|
|||||||
bold: true,
|
bold: true,
|
||||||
}),
|
}),
|
||||||
new TextRun({
|
new TextRun({
|
||||||
text: "Bar",
|
text: "\tBar",
|
||||||
bold: true,
|
bold: true,
|
||||||
}).tab(),
|
}),
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
|
@ -1,55 +1,105 @@
|
|||||||
// Example on how to customise the look at feel using Styles
|
// Example on how to customise the look at feel using Styles
|
||||||
// Import from 'docx' rather than '../build' if you install from npm
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { Document, HeadingLevel, Packer, Paragraph, TextRun } from "../build";
|
import { AlignmentType, Document, HeadingLevel, Packer, Paragraph, TextRun, UnderlineType } from "../build";
|
||||||
|
|
||||||
const doc = new Document({
|
const doc = new Document({
|
||||||
creator: "Clippy",
|
creator: "Clippy",
|
||||||
title: "Sample Document",
|
title: "Sample Document",
|
||||||
description: "A brief example of using docx",
|
description: "A brief example of using docx",
|
||||||
|
styles: {
|
||||||
|
paragraphStyles: [
|
||||||
|
{
|
||||||
|
id: "Heading1",
|
||||||
|
name: "Heading 1",
|
||||||
|
basedOn: "Normal",
|
||||||
|
next: "Normal",
|
||||||
|
quickFormat: true,
|
||||||
|
run: {
|
||||||
|
size: 28,
|
||||||
|
bold: true,
|
||||||
|
italics: true,
|
||||||
|
color: "red",
|
||||||
|
},
|
||||||
|
paragraph: {
|
||||||
|
spacing: {
|
||||||
|
after: 120,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: "Heading2",
|
||||||
|
name: "Heading 2",
|
||||||
|
basedOn: "Normal",
|
||||||
|
next: "Normal",
|
||||||
|
quickFormat: true,
|
||||||
|
run: {
|
||||||
|
size: 26,
|
||||||
|
bold: true,
|
||||||
|
underline: {
|
||||||
|
type: UnderlineType.DOUBLE,
|
||||||
|
color: "FF0000",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
paragraph: {
|
||||||
|
spacing: {
|
||||||
|
before: 240,
|
||||||
|
after: 120,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: "aside",
|
||||||
|
name: "Aside",
|
||||||
|
basedOn: "Normal",
|
||||||
|
next: "Normal",
|
||||||
|
run: {
|
||||||
|
color: "999999",
|
||||||
|
italics: true,
|
||||||
|
},
|
||||||
|
paragraph: {
|
||||||
|
indent: {
|
||||||
|
left: 720,
|
||||||
|
},
|
||||||
|
spacing: {
|
||||||
|
line: 276,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: "wellSpaced",
|
||||||
|
name: "Well Spaced",
|
||||||
|
basedOn: "Normal",
|
||||||
|
quickFormat: true,
|
||||||
|
paragraph: {
|
||||||
|
spacing: { line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: "ListParagraph",
|
||||||
|
name: "List Paragraph",
|
||||||
|
basedOn: "Normal",
|
||||||
|
quickFormat: true,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
numbering: {
|
||||||
|
config: [
|
||||||
|
{
|
||||||
|
reference: "my-crazy-numbering",
|
||||||
|
levels: [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerLetter",
|
||||||
|
text: "%1)",
|
||||||
|
alignment: AlignmentType.LEFT,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
doc.Styles.createParagraphStyle("Heading1", "Heading 1")
|
|
||||||
.basedOn("Normal")
|
|
||||||
.next("Normal")
|
|
||||||
.quickFormat()
|
|
||||||
.size(28)
|
|
||||||
.bold()
|
|
||||||
.italics()
|
|
||||||
.spacing({ after: 120 });
|
|
||||||
|
|
||||||
doc.Styles.createParagraphStyle("Heading2", "Heading 2")
|
|
||||||
.basedOn("Normal")
|
|
||||||
.next("Normal")
|
|
||||||
.quickFormat()
|
|
||||||
.size(26)
|
|
||||||
.bold()
|
|
||||||
.underline("double", "FF0000")
|
|
||||||
.spacing({ before: 240, after: 120 });
|
|
||||||
|
|
||||||
doc.Styles.createParagraphStyle("aside", "Aside")
|
|
||||||
.basedOn("Normal")
|
|
||||||
.next("Normal")
|
|
||||||
.color("999999")
|
|
||||||
.italics()
|
|
||||||
.indent({ left: 720 })
|
|
||||||
.spacing({ line: 276 });
|
|
||||||
|
|
||||||
doc.Styles.createParagraphStyle("wellSpaced", "Well Spaced")
|
|
||||||
.basedOn("Normal")
|
|
||||||
.spacing({ line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 });
|
|
||||||
|
|
||||||
doc.Styles.createParagraphStyle("ListParagraph", "List Paragraph")
|
|
||||||
.quickFormat()
|
|
||||||
.basedOn("Normal");
|
|
||||||
|
|
||||||
const numberedAbstract = doc.Numbering.createAbstractNumbering();
|
|
||||||
numberedAbstract.createLevel(0, "lowerLetter", "%1)", "left");
|
|
||||||
|
|
||||||
const letterNumbering = doc.Numbering.createConcreteNumbering(numberedAbstract);
|
|
||||||
const letterNumbering5 = doc.Numbering.createConcreteNumbering(numberedAbstract);
|
|
||||||
letterNumbering5.overrideLevel(0, 5);
|
|
||||||
|
|
||||||
doc.addSection({
|
doc.addSection({
|
||||||
children: [
|
children: [
|
||||||
new Paragraph({
|
new Paragraph({
|
||||||
@ -64,32 +114,34 @@ doc.addSection({
|
|||||||
new Paragraph({
|
new Paragraph({
|
||||||
text: "Option1",
|
text: "Option1",
|
||||||
numbering: {
|
numbering: {
|
||||||
num: letterNumbering,
|
reference: "my-crazy-numbering",
|
||||||
level: 0,
|
level: 0,
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
new Paragraph({
|
new Paragraph({
|
||||||
text: "Option5 -- override 2 to 5",
|
text: "Option5 -- override 2 to 5",
|
||||||
numbering: {
|
numbering: {
|
||||||
num: letterNumbering,
|
reference: "my-crazy-numbering",
|
||||||
level: 0,
|
level: 0,
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
new Paragraph({
|
new Paragraph({
|
||||||
text: "Option3",
|
text: "Option3",
|
||||||
numbering: {
|
numbering: {
|
||||||
num: letterNumbering,
|
reference: "my-crazy-numbering",
|
||||||
level: 0,
|
level: 0,
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
new Paragraph({}).addRun(
|
new Paragraph({
|
||||||
new TextRun({
|
children: [
|
||||||
text: "Some monospaced content",
|
new TextRun({
|
||||||
font: {
|
text: "Some monospaced content",
|
||||||
name: "Monospace",
|
font: {
|
||||||
},
|
name: "Monospace",
|
||||||
}),
|
},
|
||||||
),
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
new Paragraph({
|
new Paragraph({
|
||||||
text: "An aside, in light gray italics and indented",
|
text: "An aside, in light gray italics and indented",
|
||||||
style: "aside",
|
style: "aside",
|
||||||
@ -109,6 +161,10 @@ doc.addSection({
|
|||||||
text: "and then underlined ",
|
text: "and then underlined ",
|
||||||
underline: {},
|
underline: {},
|
||||||
}),
|
}),
|
||||||
|
new TextRun({
|
||||||
|
text: "and then emphasis-mark ",
|
||||||
|
emphasisMark: {},
|
||||||
|
}),
|
||||||
new TextRun({
|
new TextRun({
|
||||||
text: "and back to normal.",
|
text: "and back to normal.",
|
||||||
}),
|
}),
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
// This demo shows how to create bookmarks then link to them with internal hyperlinks
|
// This demo shows how to create bookmarks then link to them with internal hyperlinks
|
||||||
// Import from 'docx' rather than '../build' if you install from npm
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { Document, HeadingLevel, Packer, Paragraph } from "../build";
|
import { Bookmark, Document, HeadingLevel, HyperlinkRef, HyperlinkType, Packer, PageBreak, Paragraph } from "../build";
|
||||||
|
|
||||||
const LOREM_IPSUM =
|
const LOREM_IPSUM =
|
||||||
"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mi velit, convallis convallis scelerisque nec, faucibus nec leo. Phasellus at posuere mauris, tempus dignissim velit. Integer et tortor dolor. Duis auctor efficitur mattis. Vivamus ut metus accumsan tellus auctor sollicitudin venenatis et nibh. Cras quis massa ac metus fringilla venenatis. Proin rutrum mauris purus, ut suscipit magna consectetur id. Integer consectetur sollicitudin ante, vitae faucibus neque efficitur in. Praesent ultricies nibh lectus. Mauris pharetra id odio eget iaculis. Duis dictum, risus id pellentesque rutrum, lorem quam malesuada massa, quis ullamcorper turpis urna a diam. Cras vulputate metus vel massa porta ullamcorper. Etiam porta condimentum nulla nec tristique. Sed nulla urna, pharetra non tortor sed, sollicitudin molestie diam. Maecenas enim leo, feugiat eget vehicula id, sollicitudin vitae ante.";
|
"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mi velit, convallis convallis scelerisque nec, faucibus nec leo. Phasellus at posuere mauris, tempus dignissim velit. Integer et tortor dolor. Duis auctor efficitur mattis. Vivamus ut metus accumsan tellus auctor sollicitudin venenatis et nibh. Cras quis massa ac metus fringilla venenatis. Proin rutrum mauris purus, ut suscipit magna consectetur id. Integer consectetur sollicitudin ante, vitae faucibus neque efficitur in. Praesent ultricies nibh lectus. Mauris pharetra id odio eget iaculis. Duis dictum, risus id pellentesque rutrum, lorem quam malesuada massa, quis ullamcorper turpis urna a diam. Cras vulputate metus vel massa porta ullamcorper. Etiam porta condimentum nulla nec tristique. Sed nulla urna, pharetra non tortor sed, sollicitudin molestie diam. Maecenas enim leo, feugiat eget vehicula id, sollicitudin vitae ante.";
|
||||||
@ -10,23 +10,28 @@ const doc = new Document({
|
|||||||
creator: "Clippy",
|
creator: "Clippy",
|
||||||
title: "Sample Document",
|
title: "Sample Document",
|
||||||
description: "A brief example of using docx with bookmarks and internal hyperlinks",
|
description: "A brief example of using docx with bookmarks and internal hyperlinks",
|
||||||
|
hyperlinks: {
|
||||||
|
myAnchorId: {
|
||||||
|
text: "Hyperlink",
|
||||||
|
type: HyperlinkType.INTERNAL,
|
||||||
|
},
|
||||||
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
const anchorId = "anchorID";
|
|
||||||
|
|
||||||
// First create the bookmark
|
|
||||||
const bookmark = doc.createBookmark(anchorId, "Lorem Ipsum");
|
|
||||||
const hyperlink = doc.createInternalHyperLink(anchorId, `Click me!`);
|
|
||||||
|
|
||||||
doc.addSection({
|
doc.addSection({
|
||||||
children: [
|
children: [
|
||||||
new Paragraph({
|
new Paragraph({
|
||||||
heading: HeadingLevel.HEADING_1,
|
heading: HeadingLevel.HEADING_1,
|
||||||
}).addBookmark(bookmark),
|
children: [new Bookmark("myAnchorId", "Lorem Ipsum")],
|
||||||
|
}),
|
||||||
new Paragraph("\n"),
|
new Paragraph("\n"),
|
||||||
new Paragraph(LOREM_IPSUM),
|
new Paragraph(LOREM_IPSUM),
|
||||||
new Paragraph({}).pageBreak(),
|
new Paragraph({
|
||||||
new Paragraph({}).addHyperLink(hyperlink),
|
children: [new PageBreak()],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [new HyperlinkRef("myAnchorId")],
|
||||||
|
}),
|
||||||
],
|
],
|
||||||
});
|
});
|
||||||
|
|
||||||
|
@ -1,28 +1,53 @@
|
|||||||
// Custom styles using JavaScript configuration
|
// Custom styles using JavaScript configuration
|
||||||
// Import from 'docx' rather than '../build' if you install from npm
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { Document, HeadingLevel, Packer, Paragraph } from "../build";
|
import { Document, HeadingLevel, Packer, Paragraph, UnderlineType } from "../build";
|
||||||
|
|
||||||
const doc = new Document();
|
const doc = new Document({
|
||||||
|
styles: {
|
||||||
// The first argument is an ID you use to apply the style to paragraphs
|
paragraphStyles: [
|
||||||
// The second argument is a human-friendly name to show in the UI
|
{
|
||||||
doc.Styles.createParagraphStyle("myWonkyStyle", "My Wonky Style")
|
id: "myWonkyStyle",
|
||||||
.basedOn("Normal")
|
name: "My Wonky Style",
|
||||||
.next("Normal")
|
basedOn: "Normal",
|
||||||
.color("990000")
|
next: "Normal",
|
||||||
.italics()
|
run: {
|
||||||
.indent({ left: 720 }) // 720 TWIP === 720 / 20 pt === .5 in
|
color: "990000",
|
||||||
.spacing({ line: 276 }); // 276 / 240 = 1.15x line spacing
|
italics: true,
|
||||||
|
},
|
||||||
doc.Styles.createParagraphStyle("Heading2", "Heading 2")
|
paragraph: {
|
||||||
.basedOn("Normal")
|
indent: {
|
||||||
.next("Normal")
|
left: 720,
|
||||||
.quickFormat()
|
},
|
||||||
.size(26) // 26 half-points === 13pt font
|
spacing: {
|
||||||
.bold()
|
line: 276,
|
||||||
.underline("double", "FF0000")
|
},
|
||||||
.spacing({ before: 240, after: 120 }); // TWIP for both
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: "Heading2",
|
||||||
|
name: "Heading 2",
|
||||||
|
basedOn: "Normal",
|
||||||
|
next: "Normal",
|
||||||
|
quickFormat: true,
|
||||||
|
run: {
|
||||||
|
bold: true,
|
||||||
|
size: 26,
|
||||||
|
underline: {
|
||||||
|
type: UnderlineType.DOUBLE,
|
||||||
|
color: "FF0000",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
paragraph: {
|
||||||
|
spacing: {
|
||||||
|
before: 240,
|
||||||
|
after: 120,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
doc.addSection({
|
doc.addSection({
|
||||||
children: [
|
children: [
|
||||||
|
@ -3,15 +3,23 @@
|
|||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { File, HeadingLevel, Packer, Paragraph, StyleLevel, TableOfContents } from "../build";
|
import { File, HeadingLevel, Packer, Paragraph, StyleLevel, TableOfContents } from "../build";
|
||||||
|
|
||||||
const doc = new File();
|
const doc = new File({
|
||||||
|
styles: {
|
||||||
// The first argument is an ID you use to apply the style to paragraphs
|
paragraphStyles: [
|
||||||
// The second argument is a human-friendly name to show in the UI
|
{
|
||||||
doc.Styles.createParagraphStyle("MySpectacularStyle", "My Spectacular Style")
|
id: "MySpectacularStyle",
|
||||||
.basedOn("Heading1")
|
name: "My Spectacular Style",
|
||||||
.next("Heading1")
|
basedOn: "Heading1",
|
||||||
.color("990000")
|
next: "Heading1",
|
||||||
.italics();
|
quickFormat: true,
|
||||||
|
run: {
|
||||||
|
italics: true,
|
||||||
|
color: "990000",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
// WordprocessingML docs for TableOfContents can be found here:
|
// WordprocessingML docs for TableOfContents can be found here:
|
||||||
// http://officeopenxml.com/WPtableOfContents.php
|
// http://officeopenxml.com/WPtableOfContents.php
|
||||||
|
@ -1,23 +1,53 @@
|
|||||||
// Numbered lists
|
// Numbered lists
|
||||||
// Import from 'docx' rather than '../build' if you install from npm
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { Document, Numbering, Packer, Paragraph } from "../build";
|
import { AlignmentType, Document, Packer, Paragraph } from "../build";
|
||||||
|
|
||||||
const doc = new Document();
|
const doc = new Document({
|
||||||
|
numbering: {
|
||||||
const numbering = new Numbering();
|
config: [
|
||||||
|
{
|
||||||
const abstractNum = numbering.createAbstractNumbering();
|
levels: [
|
||||||
abstractNum.createLevel(0, "upperRoman", "%1", "start").indent({ left: 720, hanging: 260 });
|
{
|
||||||
|
level: 0,
|
||||||
const concrete = numbering.createConcreteNumbering(abstractNum);
|
format: "upperRoman",
|
||||||
|
text: "%1",
|
||||||
|
alignment: AlignmentType.START,
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
indent: { left: 720, hanging: 260 },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
reference: "my-crazy-reference",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
levels: [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "decimal",
|
||||||
|
text: "%1",
|
||||||
|
alignment: AlignmentType.START,
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
indent: { left: 720, hanging: 260 },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
reference: "my-number-numbering-reference",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
doc.addSection({
|
doc.addSection({
|
||||||
children: [
|
children: [
|
||||||
new Paragraph({
|
new Paragraph({
|
||||||
text: "line with contextual spacing",
|
text: "line with contextual spacing",
|
||||||
numbering: {
|
numbering: {
|
||||||
num: concrete,
|
reference: "my-crazy-reference",
|
||||||
level: 0,
|
level: 0,
|
||||||
},
|
},
|
||||||
contextualSpacing: true,
|
contextualSpacing: true,
|
||||||
@ -28,7 +58,7 @@ doc.addSection({
|
|||||||
new Paragraph({
|
new Paragraph({
|
||||||
text: "line with contextual spacing",
|
text: "line with contextual spacing",
|
||||||
numbering: {
|
numbering: {
|
||||||
num: concrete,
|
reference: "my-crazy-reference",
|
||||||
level: 0,
|
level: 0,
|
||||||
},
|
},
|
||||||
contextualSpacing: true,
|
contextualSpacing: true,
|
||||||
@ -39,7 +69,7 @@ doc.addSection({
|
|||||||
new Paragraph({
|
new Paragraph({
|
||||||
text: "line without contextual spacing",
|
text: "line without contextual spacing",
|
||||||
numbering: {
|
numbering: {
|
||||||
num: concrete,
|
reference: "my-crazy-reference",
|
||||||
level: 0,
|
level: 0,
|
||||||
},
|
},
|
||||||
contextualSpacing: false,
|
contextualSpacing: false,
|
||||||
@ -50,7 +80,7 @@ doc.addSection({
|
|||||||
new Paragraph({
|
new Paragraph({
|
||||||
text: "line without contextual spacing",
|
text: "line without contextual spacing",
|
||||||
numbering: {
|
numbering: {
|
||||||
num: concrete,
|
reference: "my-crazy-reference",
|
||||||
level: 0,
|
level: 0,
|
||||||
},
|
},
|
||||||
contextualSpacing: false,
|
contextualSpacing: false,
|
||||||
@ -58,6 +88,27 @@ doc.addSection({
|
|||||||
before: 200,
|
before: 200,
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
text: "Step 1 - Add sugar",
|
||||||
|
numbering: {
|
||||||
|
reference: "my-number-numbering-reference",
|
||||||
|
level: 0,
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
text: "Step 2 - Add wheat",
|
||||||
|
numbering: {
|
||||||
|
reference: "my-number-numbering-reference",
|
||||||
|
level: 0,
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
text: "Step 3 - Put in oven",
|
||||||
|
numbering: {
|
||||||
|
reference: "my-number-numbering-reference",
|
||||||
|
level: 0,
|
||||||
|
},
|
||||||
|
}),
|
||||||
],
|
],
|
||||||
});
|
});
|
||||||
|
|
||||||
|
@ -1,46 +1,91 @@
|
|||||||
// Numbering and bullet points example
|
// Numbering and bullet points example
|
||||||
// Import from 'docx' rather than '../build' if you install from npm
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { Document, Numbering, Packer, Paragraph } from "../build";
|
import { AlignmentType, Document, Packer, Paragraph } from "../build";
|
||||||
|
|
||||||
const doc = new Document();
|
const doc = new Document({
|
||||||
|
numbering: {
|
||||||
const numbering = new Numbering();
|
config: [
|
||||||
|
{
|
||||||
const abstractNum = numbering.createAbstractNumbering();
|
reference: "my-crazy-numbering",
|
||||||
abstractNum.createLevel(0, "upperRoman", "%1", "start").indent({ left: 720, hanging: 260 });
|
levels: [
|
||||||
abstractNum.createLevel(1, "decimal", "%2.", "start").indent({ left: 1440, hanging: 980 });
|
{
|
||||||
abstractNum.createLevel(2, "lowerLetter", "%3)", "start").indent({ left: 2160, hanging: 1700 });
|
level: 0,
|
||||||
|
format: "upperRoman",
|
||||||
const concrete = numbering.createConcreteNumbering(abstractNum);
|
text: "%1",
|
||||||
|
alignment: AlignmentType.START,
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
indent: { left: 720, hanging: 260 },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
level: 1,
|
||||||
|
format: "decimal",
|
||||||
|
text: "%2.",
|
||||||
|
alignment: AlignmentType.START,
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
indent: { left: 1440, hanging: 980 },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
level: 2,
|
||||||
|
format: "lowerLetter",
|
||||||
|
text: "%3)",
|
||||||
|
alignment: AlignmentType.START,
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
indent: { left: 2160, hanging: 1700 },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
level: 3,
|
||||||
|
format: "upperLetter",
|
||||||
|
text: "%4)",
|
||||||
|
alignment: AlignmentType.START,
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
indent: { left: 2880, hanging: 2420 },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
doc.addSection({
|
doc.addSection({
|
||||||
children: [
|
children: [
|
||||||
new Paragraph({
|
new Paragraph({
|
||||||
text: "Hey you",
|
text: "Hey you",
|
||||||
numbering: {
|
numbering: {
|
||||||
num: concrete,
|
reference: "my-crazy-numbering",
|
||||||
level: 0,
|
level: 0,
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
new Paragraph({
|
new Paragraph({
|
||||||
text: "What's up fam",
|
text: "What's up fam",
|
||||||
numbering: {
|
numbering: {
|
||||||
num: concrete,
|
reference: "my-crazy-numbering",
|
||||||
level: 1,
|
level: 1,
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
new Paragraph({
|
new Paragraph({
|
||||||
text: "Hello World 2",
|
text: "Hello World 2",
|
||||||
numbering: {
|
numbering: {
|
||||||
num: concrete,
|
reference: "my-crazy-numbering",
|
||||||
level: 1,
|
level: 1,
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
new Paragraph({
|
new Paragraph({
|
||||||
text: "Yeah boi",
|
text: "Yeah boi",
|
||||||
numbering: {
|
numbering: {
|
||||||
num: concrete,
|
reference: "my-crazy-numbering",
|
||||||
level: 2,
|
level: 2,
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
@ -68,6 +113,27 @@ doc.addSection({
|
|||||||
level: 3,
|
level: 3,
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
text: "101 MSXFM",
|
||||||
|
numbering: {
|
||||||
|
reference: "my-crazy-numbering",
|
||||||
|
level: 3,
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
text: "back to level 1",
|
||||||
|
numbering: {
|
||||||
|
reference: "my-crazy-numbering",
|
||||||
|
level: 1,
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
text: "back to level 0",
|
||||||
|
numbering: {
|
||||||
|
reference: "my-crazy-numbering",
|
||||||
|
level: 0,
|
||||||
|
},
|
||||||
|
}),
|
||||||
],
|
],
|
||||||
});
|
});
|
||||||
|
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
// Example of how you would create a table and add data to it
|
// Example of how you would create a table and add data to it
|
||||||
// Import from 'docx' rather than '../build' if you install from npm
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { Document, HeadingLevel, Packer, Paragraph, Table, TableCell, TableRow, VerticalAlign } from "../build";
|
import { Document, HeadingLevel, Packer, Paragraph, Table, TableCell, TableRow, VerticalAlign, TextDirection } from "../build";
|
||||||
|
|
||||||
const doc = new Document();
|
const doc = new Document();
|
||||||
|
|
||||||
@ -17,6 +17,14 @@ const table = new Table({
|
|||||||
children: [new Paragraph({}), new Paragraph({})],
|
children: [new Paragraph({}), new Paragraph({})],
|
||||||
verticalAlign: VerticalAlign.CENTER,
|
verticalAlign: VerticalAlign.CENTER,
|
||||||
}),
|
}),
|
||||||
|
new TableCell({
|
||||||
|
children: [new Paragraph({ text: "bottom to top" }), new Paragraph({})],
|
||||||
|
textDirection: TextDirection.BOTTOM_TO_TOP_LEFT_TO_RIGHT,
|
||||||
|
}),
|
||||||
|
new TableCell({
|
||||||
|
children: [new Paragraph({ text: "top to bottom" }), new Paragraph({})],
|
||||||
|
textDirection: TextDirection.TOP_TO_BOTTOM_RIGHT_TO_LEFT,
|
||||||
|
}),
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
new TableRow({
|
new TableRow({
|
||||||
@ -38,6 +46,22 @@ const table = new Table({
|
|||||||
],
|
],
|
||||||
verticalAlign: VerticalAlign.CENTER,
|
verticalAlign: VerticalAlign.CENTER,
|
||||||
}),
|
}),
|
||||||
|
new TableCell({
|
||||||
|
children: [
|
||||||
|
new Paragraph({
|
||||||
|
text: "Text above should be vertical from bottom to top",
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
verticalAlign: VerticalAlign.CENTER,
|
||||||
|
}),
|
||||||
|
new TableCell({
|
||||||
|
children: [
|
||||||
|
new Paragraph({
|
||||||
|
text: "Text above should be vertical from top to bottom",
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
verticalAlign: VerticalAlign.CENTER,
|
||||||
|
}),
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
|
@ -1,7 +1,8 @@
|
|||||||
// Example of how you would merge cells together (Rows and Columns) and apply shading
|
// Example of how you would merge cells together (Rows and Columns) and apply shading
|
||||||
|
// Also includes an example on how to center tables
|
||||||
// Import from 'docx' rather than '../build' if you install from npm
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { Document, HeadingLevel, Packer, Paragraph, ShadingType, Table, TableCell, TableRow, WidthType } from "../build";
|
import { AlignmentType, BorderStyle, Document, HeadingLevel, Packer, Paragraph, ShadingType, Table, TableCell, TableRow, WidthType } from "../build";
|
||||||
|
|
||||||
const doc = new Document();
|
const doc = new Document();
|
||||||
|
|
||||||
@ -29,6 +30,7 @@ const table = new Table({
|
|||||||
});
|
});
|
||||||
|
|
||||||
const table2 = new Table({
|
const table2 = new Table({
|
||||||
|
alignment: AlignmentType.CENTER,
|
||||||
rows: [
|
rows: [
|
||||||
new TableRow({
|
new TableRow({
|
||||||
children: [
|
children: [
|
||||||
@ -66,6 +68,7 @@ const table2 = new Table({
|
|||||||
});
|
});
|
||||||
|
|
||||||
const table3 = new Table({
|
const table3 = new Table({
|
||||||
|
alignment: AlignmentType.CENTER,
|
||||||
rows: [
|
rows: [
|
||||||
new TableRow({
|
new TableRow({
|
||||||
children: [
|
children: [
|
||||||
@ -181,7 +184,7 @@ const table5 = new Table({
|
|||||||
new TableRow({
|
new TableRow({
|
||||||
children: [
|
children: [
|
||||||
new TableCell({
|
new TableCell({
|
||||||
children: [],
|
children: [new Paragraph("1,0")],
|
||||||
}),
|
}),
|
||||||
new TableCell({
|
new TableCell({
|
||||||
children: [new Paragraph("1,2")],
|
children: [new Paragraph("1,2")],
|
||||||
@ -192,10 +195,10 @@ const table5 = new Table({
|
|||||||
new TableRow({
|
new TableRow({
|
||||||
children: [
|
children: [
|
||||||
new TableCell({
|
new TableCell({
|
||||||
children: [],
|
children: [new Paragraph("2,0")],
|
||||||
}),
|
}),
|
||||||
new TableCell({
|
new TableCell({
|
||||||
children: [],
|
children: [new Paragraph("2,1")],
|
||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
@ -206,6 +209,163 @@ const table5 = new Table({
|
|||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const borders = {
|
||||||
|
top: {
|
||||||
|
style: BorderStyle.DASH_SMALL_GAP,
|
||||||
|
size: 1,
|
||||||
|
color: "red",
|
||||||
|
},
|
||||||
|
bottom: {
|
||||||
|
style: BorderStyle.DASH_SMALL_GAP,
|
||||||
|
size: 1,
|
||||||
|
color: "red",
|
||||||
|
},
|
||||||
|
left: {
|
||||||
|
style: BorderStyle.DASH_SMALL_GAP,
|
||||||
|
size: 1,
|
||||||
|
color: "red",
|
||||||
|
},
|
||||||
|
right: {
|
||||||
|
style: BorderStyle.DASH_SMALL_GAP,
|
||||||
|
size: 1,
|
||||||
|
color: "red",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const table6 = new Table({
|
||||||
|
rows: [
|
||||||
|
new TableRow({
|
||||||
|
children: [
|
||||||
|
new TableCell({
|
||||||
|
borders,
|
||||||
|
children: [new Paragraph("0,0")],
|
||||||
|
rowSpan: 2,
|
||||||
|
}),
|
||||||
|
new TableCell({
|
||||||
|
borders,
|
||||||
|
children: [new Paragraph("0,1")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new TableRow({
|
||||||
|
children: [
|
||||||
|
new TableCell({
|
||||||
|
borders,
|
||||||
|
children: [new Paragraph("1,1")],
|
||||||
|
rowSpan: 2,
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new TableRow({
|
||||||
|
children: [
|
||||||
|
new TableCell({
|
||||||
|
borders,
|
||||||
|
children: [new Paragraph("2,0")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
width: {
|
||||||
|
size: 100,
|
||||||
|
type: WidthType.PERCENTAGE,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const table7 = new Table({
|
||||||
|
rows: [
|
||||||
|
new TableRow({
|
||||||
|
children: [
|
||||||
|
new TableCell({
|
||||||
|
children: [new Paragraph("0,0")],
|
||||||
|
}),
|
||||||
|
new TableCell({
|
||||||
|
children: [new Paragraph("0,1")],
|
||||||
|
}),
|
||||||
|
new TableCell({
|
||||||
|
children: [new Paragraph("0,2")],
|
||||||
|
rowSpan: 2,
|
||||||
|
}),
|
||||||
|
new TableCell({
|
||||||
|
children: [new Paragraph("0,3")],
|
||||||
|
rowSpan: 3,
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new TableRow({
|
||||||
|
children: [
|
||||||
|
new TableCell({
|
||||||
|
children: [new Paragraph("1,0")],
|
||||||
|
columnSpan: 2,
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new TableRow({
|
||||||
|
children: [
|
||||||
|
new TableCell({
|
||||||
|
children: [new Paragraph("2,0")],
|
||||||
|
columnSpan: 2,
|
||||||
|
}),
|
||||||
|
new TableCell({
|
||||||
|
children: [new Paragraph("2,2")],
|
||||||
|
rowSpan: 2,
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new TableRow({
|
||||||
|
children: [
|
||||||
|
new TableCell({
|
||||||
|
children: [new Paragraph("3,0")],
|
||||||
|
}),
|
||||||
|
new TableCell({
|
||||||
|
children: [new Paragraph("3,1")],
|
||||||
|
}),
|
||||||
|
new TableCell({
|
||||||
|
children: [new Paragraph("3,3")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
width: {
|
||||||
|
size: 100,
|
||||||
|
type: WidthType.PERCENTAGE,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const table8 = new Table({
|
||||||
|
rows: [
|
||||||
|
new TableRow({
|
||||||
|
children: [
|
||||||
|
new TableCell({ children: [new Paragraph("1,1")] }),
|
||||||
|
new TableCell({ children: [new Paragraph("1,2")] }),
|
||||||
|
new TableCell({ children: [new Paragraph("1,3")] }),
|
||||||
|
new TableCell({ children: [new Paragraph("1,4")], rowSpan: 4, borders }),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new TableRow({
|
||||||
|
children: [
|
||||||
|
new TableCell({ children: [new Paragraph("2,1")] }),
|
||||||
|
new TableCell({ children: [new Paragraph("2,2")] }),
|
||||||
|
new TableCell({ children: [new Paragraph("2,3")], rowSpan: 3 }),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new TableRow({
|
||||||
|
children: [
|
||||||
|
new TableCell({ children: [new Paragraph("3,1")] }),
|
||||||
|
new TableCell({ children: [new Paragraph("3,2")], rowSpan: 2 }),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new TableRow({
|
||||||
|
children: [
|
||||||
|
new TableCell({ children: [new Paragraph("4,1")] }),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
width: {
|
||||||
|
size: 100,
|
||||||
|
type: WidthType.PERCENTAGE,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
doc.addSection({
|
doc.addSection({
|
||||||
children: [
|
children: [
|
||||||
table,
|
table,
|
||||||
@ -219,10 +379,16 @@ doc.addSection({
|
|||||||
heading: HeadingLevel.HEADING_2,
|
heading: HeadingLevel.HEADING_2,
|
||||||
}),
|
}),
|
||||||
table3,
|
table3,
|
||||||
new Paragraph("Merging columns"),
|
new Paragraph("Merging columns 1"),
|
||||||
table4,
|
table4,
|
||||||
new Paragraph("More Merging columns"),
|
new Paragraph("Merging columns 2"),
|
||||||
table5,
|
table5,
|
||||||
|
new Paragraph("Merging columns 3"),
|
||||||
|
table6,
|
||||||
|
new Paragraph("Merging columns 4"),
|
||||||
|
table7,
|
||||||
|
new Paragraph("Merging columns 5"),
|
||||||
|
table8,
|
||||||
],
|
],
|
||||||
});
|
});
|
||||||
|
|
||||||
|
@ -1,28 +1,44 @@
|
|||||||
// Sequential Captions
|
// Sequential Captions
|
||||||
// Import from 'docx' rather than '../build' if you install from npm
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { Document, Packer, Paragraph, TextRun } from "../build";
|
import { Document, Packer, Paragraph, SequentialIdentifier, TextRun } from "../build";
|
||||||
|
|
||||||
const doc = new Document();
|
const doc = new Document();
|
||||||
|
|
||||||
doc.addSection({
|
doc.addSection({
|
||||||
children: [
|
children: [
|
||||||
new Paragraph("Hello World 1->")
|
new Paragraph({
|
||||||
.addSequentialIdentifier("Caption")
|
children: [
|
||||||
.addRun(new TextRun(" text after sequencial caption 2->"))
|
new TextRun("Hello World 1->"),
|
||||||
.addSequentialIdentifier("Caption"),
|
new SequentialIdentifier("Caption"),
|
||||||
new Paragraph("Hello World 1->")
|
new TextRun(" text after sequencial caption 2->"),
|
||||||
.addSequentialIdentifier("Label")
|
new SequentialIdentifier("Caption"),
|
||||||
.addRun(new TextRun(" text after sequencial caption 2->"))
|
],
|
||||||
.addSequentialIdentifier("Label"),
|
}),
|
||||||
new Paragraph("Hello World 1->")
|
new Paragraph({
|
||||||
.addSequentialIdentifier("Another")
|
children: [
|
||||||
.addRun(new TextRun(" text after sequencial caption 3->"))
|
new TextRun("Hello World 1->"),
|
||||||
.addSequentialIdentifier("Label"),
|
new SequentialIdentifier("Label"),
|
||||||
new Paragraph("Hello World 2->")
|
new TextRun(" text after sequencial caption 2->"),
|
||||||
.addSequentialIdentifier("Another")
|
new SequentialIdentifier("Label"),
|
||||||
.addRun(new TextRun(" text after sequencial caption 4->"))
|
],
|
||||||
.addSequentialIdentifier("Label"),
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new TextRun("Hello World 1->"),
|
||||||
|
new SequentialIdentifier("Another"),
|
||||||
|
new TextRun(" text after sequencial caption 3->"),
|
||||||
|
new SequentialIdentifier("Label"),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new TextRun("Hello World 2->"),
|
||||||
|
new SequentialIdentifier("Another"),
|
||||||
|
new TextRun(" text after sequencial caption 4->"),
|
||||||
|
new SequentialIdentifier("Label"),
|
||||||
|
],
|
||||||
|
}),
|
||||||
],
|
],
|
||||||
});
|
});
|
||||||
|
|
||||||
|
@ -3,6 +3,7 @@
|
|||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import {
|
import {
|
||||||
Document,
|
Document,
|
||||||
|
OverlapType,
|
||||||
Packer,
|
Packer,
|
||||||
Paragraph,
|
Paragraph,
|
||||||
RelativeHorizontalPosition,
|
RelativeHorizontalPosition,
|
||||||
@ -43,6 +44,7 @@ const table = new Table({
|
|||||||
verticalAnchor: TableAnchorType.MARGIN,
|
verticalAnchor: TableAnchorType.MARGIN,
|
||||||
relativeHorizontalPosition: RelativeHorizontalPosition.RIGHT,
|
relativeHorizontalPosition: RelativeHorizontalPosition.RIGHT,
|
||||||
relativeVerticalPosition: RelativeVerticalPosition.BOTTOM,
|
relativeVerticalPosition: RelativeVerticalPosition.BOTTOM,
|
||||||
|
overlap: OverlapType.NEVER,
|
||||||
},
|
},
|
||||||
width: {
|
width: {
|
||||||
size: 4535,
|
size: 4535,
|
||||||
|
@ -1,15 +1,34 @@
|
|||||||
// Example on how to add hyperlinks to websites
|
// Example on how to add hyperlinks to websites
|
||||||
// Import from 'docx' rather than '../build' if you install from npm
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { Document, Packer, Paragraph } from "../build";
|
import { Document, HyperlinkRef, HyperlinkType, Packer, Paragraph, Media } from "../build";
|
||||||
|
|
||||||
const doc = new Document();
|
const doc = new Document({
|
||||||
const paragraph = new Paragraph({});
|
hyperlinks: {
|
||||||
const link = doc.createHyperlink("http://www.example.com", "Hyperlink");
|
myCoolLink: {
|
||||||
|
link: "http://www.example.com",
|
||||||
|
text: "Hyperlink",
|
||||||
|
type: HyperlinkType.EXTERNAL,
|
||||||
|
},
|
||||||
|
myOtherLink: {
|
||||||
|
link: "http://www.google.com",
|
||||||
|
text: "Google Link",
|
||||||
|
type: HyperlinkType.EXTERNAL,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const image1 = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
|
||||||
|
|
||||||
paragraph.addHyperLink(link);
|
|
||||||
doc.addSection({
|
doc.addSection({
|
||||||
children: [paragraph],
|
children: [
|
||||||
|
new Paragraph({
|
||||||
|
children: [new HyperlinkRef("myCoolLink")],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [image1, new HyperlinkRef("myOtherLink")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
});
|
});
|
||||||
|
|
||||||
Packer.toBuffer(doc).then((buffer) => {
|
Packer.toBuffer(doc).then((buffer) => {
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
// Example how to display page numbers
|
// Example how to display page numbers
|
||||||
// Import from 'docx' rather than '../build' if you install from npm
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { AlignmentType, Document, Footer, Header, Packer, PageNumberFormat, Paragraph, TextRun } from "../build";
|
import { AlignmentType, Document, Footer, Header, Packer, PageBreak, PageNumber, PageNumberFormat, Paragraph, TextRun } from "../build";
|
||||||
|
|
||||||
const doc = new Document({});
|
const doc = new Document({});
|
||||||
|
|
||||||
@ -9,9 +9,17 @@ doc.addSection({
|
|||||||
headers: {
|
headers: {
|
||||||
default: new Header({
|
default: new Header({
|
||||||
children: [
|
children: [
|
||||||
new Paragraph("Foo Bar corp. ")
|
new Paragraph({
|
||||||
.addRun(new TextRun("Page Number ").pageNumber())
|
children: [
|
||||||
.addRun(new TextRun(" to ").numberOfTotalPages()),
|
new TextRun("Foo Bar corp. "),
|
||||||
|
new TextRun({
|
||||||
|
children: ["Page Number ", PageNumber.CURRENT],
|
||||||
|
}),
|
||||||
|
new TextRun({
|
||||||
|
children: [" to ", PageNumber.TOTAL_PAGES],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
},
|
},
|
||||||
@ -19,11 +27,17 @@ doc.addSection({
|
|||||||
default: new Footer({
|
default: new Footer({
|
||||||
children: [
|
children: [
|
||||||
new Paragraph({
|
new Paragraph({
|
||||||
text: "Foo Bar corp. ",
|
|
||||||
alignment: AlignmentType.CENTER,
|
alignment: AlignmentType.CENTER,
|
||||||
})
|
children: [
|
||||||
.addRun(new TextRun("Page Number: ").pageNumber())
|
new TextRun("Foo Bar corp. "),
|
||||||
.addRun(new TextRun(" to ").numberOfTotalPages()),
|
new TextRun({
|
||||||
|
children: ["Page Number: ", PageNumber.CURRENT],
|
||||||
|
}),
|
||||||
|
new TextRun({
|
||||||
|
children: [" to ", PageNumber.TOTAL_PAGES],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
},
|
},
|
||||||
@ -32,11 +46,21 @@ doc.addSection({
|
|||||||
pageNumberFormatType: PageNumberFormat.DECIMAL,
|
pageNumberFormatType: PageNumberFormat.DECIMAL,
|
||||||
},
|
},
|
||||||
children: [
|
children: [
|
||||||
new Paragraph("Hello World 1").pageBreak(),
|
new Paragraph({
|
||||||
new Paragraph("Hello World 2").pageBreak(),
|
children: [new TextRun("Hello World 1"), new PageBreak()],
|
||||||
new Paragraph("Hello World 3").pageBreak(),
|
}),
|
||||||
new Paragraph("Hello World 4").pageBreak(),
|
new Paragraph({
|
||||||
new Paragraph("Hello World 5").pageBreak(),
|
children: [new TextRun("Hello World 2"), new PageBreak()],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [new TextRun("Hello World 3"), new PageBreak()],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [new TextRun("Hello World 4"), new PageBreak()],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [new TextRun("Hello World 5"), new PageBreak()],
|
||||||
|
}),
|
||||||
],
|
],
|
||||||
});
|
});
|
||||||
|
|
||||||
|
@ -28,6 +28,18 @@ doc.addSection({
|
|||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
shading: {
|
||||||
|
type: ShadingType.DIAGONAL_CROSS,
|
||||||
|
color: "00FFFF",
|
||||||
|
fill: "FF0000",
|
||||||
|
},
|
||||||
|
children: [
|
||||||
|
new TextRun({
|
||||||
|
text: "Hello World for entire paragraph",
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
},
|
},
|
||||||
|
@ -1,18 +1,30 @@
|
|||||||
// Multiple sections with total number of pages in each section
|
// Multiple sections with total number of pages in each section
|
||||||
// Import from 'docx' rather than '../build' if you install from npm
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { Document, Packer, PageNumberFormat, TextRun } from "../build";
|
import { AlignmentType, Document, Footer, Header, Packer, PageBreak, PageNumber, PageNumberFormat, Paragraph, TextRun } from "../build";
|
||||||
|
|
||||||
const doc = new Document();
|
const doc = new Document();
|
||||||
|
|
||||||
|
const header = new Header({
|
||||||
|
children: [
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new TextRun("Header on another page"),
|
||||||
|
new TextRun({
|
||||||
|
children: ["Page number: ", PageNumber.CURRENT],
|
||||||
|
}),
|
||||||
|
new TextRun({
|
||||||
|
children: [" to ", PageNumber.TOTAL_PAGES_IN_SECTION],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
alignment: AlignmentType.CENTER,
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
const header = doc.createHeader();
|
const footer = new Footer({
|
||||||
header.createParagraph("Header on another page");
|
children: [new Paragraph("Foo Bar corp. ")],
|
||||||
const footer = doc.createFooter();
|
});
|
||||||
footer.createParagraph("Foo Bar corp. ")
|
|
||||||
.center()
|
|
||||||
.addRun(new TextRun("Page Number: ").pageNumber())
|
|
||||||
.addRun(new TextRun(" to ").numberOfTotalPagesSection());
|
|
||||||
|
|
||||||
doc.addSection({
|
doc.addSection({
|
||||||
headers: {
|
headers: {
|
||||||
@ -21,13 +33,17 @@ doc.addSection({
|
|||||||
footers: {
|
footers: {
|
||||||
default: footer,
|
default: footer,
|
||||||
},
|
},
|
||||||
pageNumberStart: 1,
|
properties: {
|
||||||
pageNumberFormatType: PageNumberFormat.DECIMAL,
|
pageNumberStart: 1,
|
||||||
|
pageNumberFormatType: PageNumberFormat.DECIMAL,
|
||||||
|
},
|
||||||
|
children: [
|
||||||
|
new Paragraph({
|
||||||
|
children: [new TextRun("Section 1"), new PageBreak(), new TextRun("Section 1"), new PageBreak()],
|
||||||
|
}),
|
||||||
|
],
|
||||||
});
|
});
|
||||||
|
|
||||||
doc.createParagraph("Section 1").pageBreak();
|
|
||||||
doc.createParagraph("Section 1").pageBreak();
|
|
||||||
|
|
||||||
doc.addSection({
|
doc.addSection({
|
||||||
headers: {
|
headers: {
|
||||||
default: header,
|
default: header,
|
||||||
@ -35,15 +51,17 @@ doc.addSection({
|
|||||||
footers: {
|
footers: {
|
||||||
default: footer,
|
default: footer,
|
||||||
},
|
},
|
||||||
pageNumberStart: 1,
|
properties: {
|
||||||
pageNumberFormatType: PageNumberFormat.DECIMAL,
|
pageNumberStart: 1,
|
||||||
|
pageNumberFormatType: PageNumberFormat.DECIMAL,
|
||||||
|
},
|
||||||
|
children: [
|
||||||
|
new Paragraph({
|
||||||
|
children: [new TextRun("Section 2"), new PageBreak(), new TextRun("Section 2"), new PageBreak()],
|
||||||
|
}),
|
||||||
|
],
|
||||||
});
|
});
|
||||||
|
|
||||||
doc.createParagraph("Section 2").pageBreak();
|
Packer.toBuffer(doc).then((buffer) => {
|
||||||
doc.createParagraph("Section 2").pageBreak();
|
|
||||||
|
|
||||||
const packer = new Packer();
|
|
||||||
|
|
||||||
packer.toBuffer(doc).then((buffer) => {
|
|
||||||
fs.writeFileSync("My Document.docx", buffer);
|
fs.writeFileSync("My Document.docx", buffer);
|
||||||
});
|
});
|
||||||
|
31
demo/48-vertical-align.ts
Normal file
31
demo/48-vertical-align.ts
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
// Example of making content of section vertically aligned
|
||||||
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
|
import * as fs from "fs";
|
||||||
|
import { Document, Packer, Paragraph, SectionVerticalAlignValue, TextRun } from "../build";
|
||||||
|
|
||||||
|
const doc = new Document();
|
||||||
|
|
||||||
|
doc.addSection({
|
||||||
|
properties: {
|
||||||
|
verticalAlign: SectionVerticalAlignValue.CENTER,
|
||||||
|
},
|
||||||
|
children: [
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new TextRun("Hello World"),
|
||||||
|
new TextRun({
|
||||||
|
text: "Foo Bar",
|
||||||
|
bold: true,
|
||||||
|
}),
|
||||||
|
new TextRun({
|
||||||
|
text: "\tGithub is the best",
|
||||||
|
bold: true,
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
Packer.toBuffer(doc).then((buffer) => {
|
||||||
|
fs.writeFileSync("My Document.docx", buffer);
|
||||||
|
});
|
37
demo/49-table-borders.ts
Normal file
37
demo/49-table-borders.ts
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
// Add custom borders to the table itself
|
||||||
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
|
import * as fs from "fs";
|
||||||
|
import { BorderStyle, Document, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
|
||||||
|
|
||||||
|
const doc = new Document();
|
||||||
|
|
||||||
|
const table = new Table({
|
||||||
|
rows: [
|
||||||
|
new TableRow({
|
||||||
|
children: [
|
||||||
|
new TableCell({
|
||||||
|
children: [new Paragraph("Hello")],
|
||||||
|
}),
|
||||||
|
new TableCell({
|
||||||
|
children: [],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new TableRow({
|
||||||
|
children: [
|
||||||
|
new TableCell({
|
||||||
|
children: [],
|
||||||
|
}),
|
||||||
|
new TableCell({
|
||||||
|
children: [new Paragraph("World")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
doc.addSection({ children: [table] });
|
||||||
|
|
||||||
|
Packer.toBuffer(doc).then((buffer) => {
|
||||||
|
fs.writeFileSync("My Document.docx", buffer);
|
||||||
|
});
|
61
demo/50-readme-demo.ts
Normal file
61
demo/50-readme-demo.ts
Normal file
@ -0,0 +1,61 @@
|
|||||||
|
// Simple example to add text to a document
|
||||||
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
|
import * as fs from "fs";
|
||||||
|
import { Document, HeadingLevel, Media, Packer, Paragraph, Table, TableCell, TableRow, VerticalAlign } from "../build";
|
||||||
|
|
||||||
|
const doc = new Document();
|
||||||
|
|
||||||
|
const image1 = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
|
||||||
|
const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
|
||||||
|
|
||||||
|
const table = new Table({
|
||||||
|
rows: [
|
||||||
|
new TableRow({
|
||||||
|
children: [
|
||||||
|
new TableCell({
|
||||||
|
children: [new Paragraph(image1)],
|
||||||
|
verticalAlign: VerticalAlign.CENTER,
|
||||||
|
}),
|
||||||
|
new TableCell({
|
||||||
|
children: [
|
||||||
|
new Paragraph({
|
||||||
|
text: "Hello",
|
||||||
|
heading: HeadingLevel.HEADING_1,
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
verticalAlign: VerticalAlign.CENTER,
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new TableRow({
|
||||||
|
children: [
|
||||||
|
new TableCell({
|
||||||
|
children: [
|
||||||
|
new Paragraph({
|
||||||
|
text: "World",
|
||||||
|
heading: HeadingLevel.HEADING_1,
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new TableCell({
|
||||||
|
children: [new Paragraph(image1)],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
doc.addSection({
|
||||||
|
children: [
|
||||||
|
new Paragraph({
|
||||||
|
text: "Hello World",
|
||||||
|
heading: HeadingLevel.HEADING_1,
|
||||||
|
}),
|
||||||
|
table,
|
||||||
|
new Paragraph(image2),
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
Packer.toBuffer(doc).then((buffer) => {
|
||||||
|
fs.writeFileSync("My Document.docx", buffer);
|
||||||
|
});
|
37
demo/51-character-styles.ts
Normal file
37
demo/51-character-styles.ts
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
// Custom character styles using JavaScript configuration
|
||||||
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
|
import * as fs from "fs";
|
||||||
|
import { Document, Packer, Paragraph, TextRun } from "../build";
|
||||||
|
|
||||||
|
const doc = new Document({
|
||||||
|
styles: {
|
||||||
|
characterStyles: [
|
||||||
|
{
|
||||||
|
id: "myRedStyle",
|
||||||
|
name: "My Wonky Style",
|
||||||
|
basedOn: "Normal",
|
||||||
|
run: {
|
||||||
|
color: "990000",
|
||||||
|
italics: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
doc.addSection({
|
||||||
|
children: [
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new TextRun({
|
||||||
|
text: "Foo bar",
|
||||||
|
style: "myRedStyle",
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
Packer.toBuffer(doc).then((buffer) => {
|
||||||
|
fs.writeFileSync("My Document.docx", buffer);
|
||||||
|
});
|
37
demo/52-japanese.ts
Normal file
37
demo/52-japanese.ts
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
// Japanese text - Need to use a Japanese font
|
||||||
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
|
import * as fs from "fs";
|
||||||
|
import { Document, HeadingLevel, Packer, Paragraph } from "../build";
|
||||||
|
|
||||||
|
const doc = new Document({
|
||||||
|
styles: {
|
||||||
|
paragraphStyles: [
|
||||||
|
{
|
||||||
|
id: "Normal",
|
||||||
|
name: "Normal",
|
||||||
|
basedOn: "Normal",
|
||||||
|
next: "Normal",
|
||||||
|
quickFormat: true,
|
||||||
|
run: {
|
||||||
|
font: "MS Gothic",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
doc.addSection({
|
||||||
|
children: [
|
||||||
|
new Paragraph({
|
||||||
|
text: "KFCを食べるのが好き",
|
||||||
|
heading: HeadingLevel.HEADING_1,
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
text: "こんにちは",
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
Packer.toBuffer(doc).then((buffer) => {
|
||||||
|
fs.writeFileSync("My Document.docx", buffer);
|
||||||
|
});
|
55
demo/53-chinese.ts
Normal file
55
demo/53-chinese.ts
Normal file
@ -0,0 +1,55 @@
|
|||||||
|
// Chinese text - Chinese text need to use a Chinese font. And ascii text need to use a ascii font.
|
||||||
|
// Different from the `52-japanese.ts`.
|
||||||
|
// `52-japanese.ts` will set all characters to use Japanese font.
|
||||||
|
// `53-chinese.ts` will set Chinese characters to use Chinese font, and set ascii characters to use ascii font.
|
||||||
|
|
||||||
|
// Note that if the OS have not install `KaiTi` font, this demo doesn't work.
|
||||||
|
|
||||||
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
|
import * as fs from "fs";
|
||||||
|
import { Document, HeadingLevel, Packer, Paragraph, TextRun } from "../build";
|
||||||
|
|
||||||
|
const doc = new Document({
|
||||||
|
styles: {
|
||||||
|
paragraphStyles: [
|
||||||
|
{
|
||||||
|
id: "Normal",
|
||||||
|
name: "Normal",
|
||||||
|
basedOn: "Normal",
|
||||||
|
next: "Normal",
|
||||||
|
quickFormat: true,
|
||||||
|
run: {
|
||||||
|
font: {
|
||||||
|
ascii: "Times",
|
||||||
|
eastAsia: "KaiTi",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
doc.addSection({
|
||||||
|
children: [
|
||||||
|
new Paragraph({
|
||||||
|
text: "中文和英文 Chinese and English",
|
||||||
|
heading: HeadingLevel.HEADING_1,
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
text: "中文和英文 Chinese and English",
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new TextRun({
|
||||||
|
text: "中文和英文 Chinese and English",
|
||||||
|
font: { eastAsia: "SimSun" }, // set eastAsia to "SimSun".
|
||||||
|
// The ascii characters will use the default font ("Times") specified in paragraphStyles
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
Packer.toBuffer(doc).then((buffer) => {
|
||||||
|
fs.writeFileSync("My Document.docx", buffer);
|
||||||
|
});
|
145
demo/54-track-revisions.ts
Normal file
145
demo/54-track-revisions.ts
Normal file
@ -0,0 +1,145 @@
|
|||||||
|
// Track Revisions aka. "Track Changes"
|
||||||
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
|
import * as fs from "fs";
|
||||||
|
import {
|
||||||
|
AlignmentType,
|
||||||
|
DeletedTextRun,
|
||||||
|
Document,
|
||||||
|
Footer,
|
||||||
|
FootnoteReferenceRun,
|
||||||
|
InsertedTextRun,
|
||||||
|
Packer,
|
||||||
|
PageNumber,
|
||||||
|
Paragraph,
|
||||||
|
ShadingType,
|
||||||
|
TextRun,
|
||||||
|
} from "../build";
|
||||||
|
|
||||||
|
/*
|
||||||
|
For reference, see
|
||||||
|
- https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.wordprocessing.insertedrun
|
||||||
|
- https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.wordprocessing.deletedrun
|
||||||
|
|
||||||
|
The method `addTrackRevisions()` adds an element `<w:trackRevisions />` to the `settings.xml` file. This specifies that the application shall track *new* revisions made to the existing document.
|
||||||
|
See also https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.wordprocessing.trackrevisions
|
||||||
|
|
||||||
|
Note that this setting enables to track *new changes* after teh file is generated, so this example will still show inserted and deleted text runs when you remove it.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const doc = new Document({
|
||||||
|
footnotes: [
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new TextRun("This is a footnote"),
|
||||||
|
new DeletedTextRun({
|
||||||
|
text: " with some extra text which was deleted",
|
||||||
|
id: 0,
|
||||||
|
author: "Firstname Lastname",
|
||||||
|
date: "2020-10-06T09:05:00Z",
|
||||||
|
}),
|
||||||
|
new InsertedTextRun({
|
||||||
|
text: " and new content",
|
||||||
|
id: 1,
|
||||||
|
author: "Firstname Lastname",
|
||||||
|
date: "2020-10-06T09:05:00Z",
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
features: {
|
||||||
|
trackRevisions: true,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const paragraph = new Paragraph({
|
||||||
|
children: [
|
||||||
|
new TextRun("This is a simple demo "),
|
||||||
|
new TextRun({
|
||||||
|
text: "on how to ",
|
||||||
|
}),
|
||||||
|
new InsertedTextRun({
|
||||||
|
text: "mark a text as an insertion ",
|
||||||
|
id: 0,
|
||||||
|
author: "Firstname Lastname",
|
||||||
|
date: "2020-10-06T09:00:00Z",
|
||||||
|
}),
|
||||||
|
new DeletedTextRun({
|
||||||
|
text: "or a deletion.",
|
||||||
|
id: 1,
|
||||||
|
author: "Firstname Lastname",
|
||||||
|
date: "2020-10-06T09:00:00Z",
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
doc.addSection({
|
||||||
|
properties: {},
|
||||||
|
children: [
|
||||||
|
paragraph,
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new TextRun("This is a demo "),
|
||||||
|
new DeletedTextRun({
|
||||||
|
text: "in order",
|
||||||
|
color: "red",
|
||||||
|
bold: true,
|
||||||
|
size: 24,
|
||||||
|
font: {
|
||||||
|
name: "Garamond",
|
||||||
|
},
|
||||||
|
shading: {
|
||||||
|
type: ShadingType.REVERSE_DIAGONAL_STRIPE,
|
||||||
|
color: "00FFFF",
|
||||||
|
fill: "FF0000",
|
||||||
|
},
|
||||||
|
id: 2,
|
||||||
|
author: "Firstname Lastname",
|
||||||
|
date: "2020-10-06T09:00:00Z",
|
||||||
|
}).break(),
|
||||||
|
new InsertedTextRun({
|
||||||
|
text: "to show how to ",
|
||||||
|
bold: false,
|
||||||
|
id: 3,
|
||||||
|
author: "Firstname Lastname",
|
||||||
|
date: "2020-10-06T09:05:00Z",
|
||||||
|
}),
|
||||||
|
new TextRun({
|
||||||
|
bold: true,
|
||||||
|
children: ["\tuse Inserted and Deleted TextRuns.", new FootnoteReferenceRun(1)],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
footers: {
|
||||||
|
default: new Footer({
|
||||||
|
children: [
|
||||||
|
new Paragraph({
|
||||||
|
alignment: AlignmentType.CENTER,
|
||||||
|
children: [
|
||||||
|
new TextRun("Awesome LLC"),
|
||||||
|
new TextRun({
|
||||||
|
children: ["Page Number: ", PageNumber.CURRENT],
|
||||||
|
}),
|
||||||
|
new DeletedTextRun({
|
||||||
|
children: [" to ", PageNumber.TOTAL_PAGES],
|
||||||
|
id: 4,
|
||||||
|
author: "Firstname Lastname",
|
||||||
|
date: "2020-10-06T09:05:00Z",
|
||||||
|
}),
|
||||||
|
new InsertedTextRun({
|
||||||
|
children: [" from ", PageNumber.TOTAL_PAGES],
|
||||||
|
bold: true,
|
||||||
|
id: 5,
|
||||||
|
author: "Firstname Lastname",
|
||||||
|
date: "2020-10-06T09:05:00Z",
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
Packer.toBuffer(doc).then((buffer) => {
|
||||||
|
fs.writeFileSync("My Document.docx", buffer);
|
||||||
|
});
|
294
demo/55-math.ts
Normal file
294
demo/55-math.ts
Normal file
@ -0,0 +1,294 @@
|
|||||||
|
// Simple example to add text to a document
|
||||||
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
|
import * as fs from "fs";
|
||||||
|
import {
|
||||||
|
Document,
|
||||||
|
Math,
|
||||||
|
MathAngledBrackets,
|
||||||
|
MathCurlyBrackets,
|
||||||
|
MathFraction,
|
||||||
|
MathFunction,
|
||||||
|
MathPreSubSuperScript,
|
||||||
|
MathRadical,
|
||||||
|
MathRoundBrackets,
|
||||||
|
MathRun,
|
||||||
|
MathSquareBrackets,
|
||||||
|
MathSubScript,
|
||||||
|
MathSubSuperScript,
|
||||||
|
MathSum,
|
||||||
|
MathSuperScript,
|
||||||
|
Packer,
|
||||||
|
Paragraph,
|
||||||
|
TextRun,
|
||||||
|
} from "../build";
|
||||||
|
|
||||||
|
const doc = new Document();
|
||||||
|
|
||||||
|
doc.addSection({
|
||||||
|
properties: {},
|
||||||
|
children: [
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new Math({
|
||||||
|
children: [
|
||||||
|
new MathRun("2+2"),
|
||||||
|
new MathFraction({
|
||||||
|
numerator: [new MathRun("hi")],
|
||||||
|
denominator: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new TextRun({
|
||||||
|
text: "Foo Bar",
|
||||||
|
bold: true,
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new Math({
|
||||||
|
children: [
|
||||||
|
new MathFraction({
|
||||||
|
numerator: [
|
||||||
|
new MathRun("1"),
|
||||||
|
new MathRadical({
|
||||||
|
children: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
denominator: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new Math({
|
||||||
|
children: [
|
||||||
|
new MathSum({
|
||||||
|
children: [new MathRun("test")],
|
||||||
|
}),
|
||||||
|
new MathSum({
|
||||||
|
children: [
|
||||||
|
new MathSuperScript({
|
||||||
|
children: [new MathRun("e")],
|
||||||
|
superScript: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
subScript: [new MathRun("i")],
|
||||||
|
}),
|
||||||
|
new MathSum({
|
||||||
|
children: [
|
||||||
|
new MathRadical({
|
||||||
|
children: [new MathRun("i")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
subScript: [new MathRun("i")],
|
||||||
|
superScript: [new MathRun("10")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new Math({
|
||||||
|
children: [
|
||||||
|
new MathSuperScript({
|
||||||
|
children: [new MathRun("test")],
|
||||||
|
superScript: [new MathRun("hello")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new Math({
|
||||||
|
children: [
|
||||||
|
new MathSubScript({
|
||||||
|
children: [new MathRun("test")],
|
||||||
|
subScript: [new MathRun("hello")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new Math({
|
||||||
|
children: [
|
||||||
|
new MathSubScript({
|
||||||
|
children: [new MathRun("x")],
|
||||||
|
subScript: [
|
||||||
|
new MathSuperScript({
|
||||||
|
children: [new MathRun("y")],
|
||||||
|
superScript: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new Math({
|
||||||
|
children: [
|
||||||
|
new MathSubSuperScript({
|
||||||
|
children: [new MathRun("test")],
|
||||||
|
superScript: [new MathRun("hello")],
|
||||||
|
subScript: [new MathRun("world")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new Math({
|
||||||
|
children: [
|
||||||
|
new MathPreSubSuperScript({
|
||||||
|
children: [new MathRun("test")],
|
||||||
|
superScript: [new MathRun("hello")],
|
||||||
|
subScript: [new MathRun("world")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new Math({
|
||||||
|
children: [
|
||||||
|
new MathSubScript({
|
||||||
|
children: [
|
||||||
|
new MathFraction({
|
||||||
|
numerator: [new MathRun("1")],
|
||||||
|
denominator: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
subScript: [new MathRun("4")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new Math({
|
||||||
|
children: [
|
||||||
|
new MathSubScript({
|
||||||
|
children: [
|
||||||
|
new MathRadical({
|
||||||
|
children: [
|
||||||
|
new MathFraction({
|
||||||
|
numerator: [new MathRun("1")],
|
||||||
|
denominator: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
degree: [new MathRun("4")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
subScript: [new MathRun("x")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new Math({
|
||||||
|
children: [
|
||||||
|
new MathRadical({
|
||||||
|
children: [new MathRun("4")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new Math({
|
||||||
|
children: [
|
||||||
|
new MathFunction({
|
||||||
|
name: [
|
||||||
|
new MathSuperScript({
|
||||||
|
children: [new MathRun("cos")],
|
||||||
|
superScript: [new MathRun("-1")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
children: [new MathRun("100")],
|
||||||
|
}),
|
||||||
|
new MathRun("×"),
|
||||||
|
new MathFunction({
|
||||||
|
name: [new MathRun("sin")],
|
||||||
|
children: [new MathRun("360")],
|
||||||
|
}),
|
||||||
|
new MathRun("= x"),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new Math({
|
||||||
|
children: [
|
||||||
|
new MathRoundBrackets({
|
||||||
|
children: [
|
||||||
|
new MathFraction({
|
||||||
|
numerator: [new MathRun("1")],
|
||||||
|
denominator: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new MathSquareBrackets({
|
||||||
|
children: [
|
||||||
|
new MathFraction({
|
||||||
|
numerator: [new MathRun("1")],
|
||||||
|
denominator: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new MathCurlyBrackets({
|
||||||
|
children: [
|
||||||
|
new MathFraction({
|
||||||
|
numerator: [new MathRun("1")],
|
||||||
|
denominator: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new MathAngledBrackets({
|
||||||
|
children: [
|
||||||
|
new MathFraction({
|
||||||
|
numerator: [new MathRun("1")],
|
||||||
|
denominator: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new Math({
|
||||||
|
children: [
|
||||||
|
new MathFraction({
|
||||||
|
numerator: [
|
||||||
|
new MathRadical({
|
||||||
|
children: [new MathRun("4")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
denominator: [new MathRun("2a")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
Packer.toBuffer(doc).then((buffer) => {
|
||||||
|
fs.writeFileSync("My Document.docx", buffer);
|
||||||
|
});
|
33
demo/56-background-color.ts
Normal file
33
demo/56-background-color.ts
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
// Change background colour of whole document
|
||||||
|
// Import from 'docx' rather than '../build' if you install from npm
|
||||||
|
import * as fs from "fs";
|
||||||
|
import { Document, Packer, Paragraph, TextRun } from "../build";
|
||||||
|
|
||||||
|
const doc = new Document({
|
||||||
|
background: {
|
||||||
|
color: "C45911",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
doc.addSection({
|
||||||
|
properties: {},
|
||||||
|
children: [
|
||||||
|
new Paragraph({
|
||||||
|
children: [
|
||||||
|
new TextRun("Hello World"),
|
||||||
|
new TextRun({
|
||||||
|
text: "Foo Bar",
|
||||||
|
bold: true,
|
||||||
|
}),
|
||||||
|
new TextRun({
|
||||||
|
text: "\tGithub is the best",
|
||||||
|
bold: true,
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
Packer.toBuffer(doc).then((buffer) => {
|
||||||
|
fs.writeFileSync("My Document.docx", buffer);
|
||||||
|
});
|
@ -21,9 +21,9 @@ doc.addSection({
|
|||||||
bold: true,
|
bold: true,
|
||||||
}),
|
}),
|
||||||
new TextRun({
|
new TextRun({
|
||||||
text: "Github is the best",
|
text: "\tGithub is the best",
|
||||||
bold: true,
|
bold: true,
|
||||||
}).tab(),
|
}),
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
new Paragraph({
|
new Paragraph({
|
||||||
|
@ -12,21 +12,21 @@
|
|||||||
|
|
||||||
<script>
|
<script>
|
||||||
function generate() {
|
function generate() {
|
||||||
const doc = new Document();
|
const doc = new docx.Document();
|
||||||
|
|
||||||
doc.addSection({
|
doc.addSection({
|
||||||
children: [
|
children: [
|
||||||
new Paragraph({
|
new docx.Paragraph({
|
||||||
children: [
|
children: [
|
||||||
new TextRun("Hello World"),
|
new docx.TextRun("Hello World"),
|
||||||
new TextRun({
|
new docx.TextRun({
|
||||||
text: "Foo Bar",
|
text: "Foo Bar",
|
||||||
bold: true,
|
bold: true,
|
||||||
}),
|
}),
|
||||||
new TextRun({
|
new docx.TextRun({
|
||||||
text: "Github is the best",
|
text: "\tGithub is the best",
|
||||||
bold: true,
|
bold: true,
|
||||||
}).tab(),
|
}),
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
@ -34,7 +34,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
Packer.toBlob(doc).then((blob) => {
|
docx.Packer.toBlob(doc).then((blob) => {
|
||||||
console.log(blob);
|
console.log(blob);
|
||||||
saveAs(blob, "example.docx");
|
saveAs(blob, "example.docx");
|
||||||
console.log("Document created successfully");
|
console.log("Document created successfully");
|
||||||
|
@ -1,13 +1,3 @@
|
|||||||
<p align="center">
|
|
||||||
<img alt="clippy the assistant" src="https://i.imgur.com/37uBGhO.gif">
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p align="center">
|
|
||||||
Easily generate .docx files with JS/TS. Works for Node and on the Browser. :100:
|
|
||||||
</p>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Welcome
|
# Welcome
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
@ -50,9 +40,9 @@ doc.addSection({
|
|||||||
bold: true,
|
bold: true,
|
||||||
}),
|
}),
|
||||||
new TextRun({
|
new TextRun({
|
||||||
text: "Github is the best",
|
text: "\tGithub is the best",
|
||||||
bold: true,
|
bold: true,
|
||||||
}).tab(),
|
}),
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
@ -63,17 +53,11 @@ Packer.toBuffer(doc).then((buffer) => {
|
|||||||
fs.writeFileSync("My Document.docx", buffer);
|
fs.writeFileSync("My Document.docx", buffer);
|
||||||
});
|
});
|
||||||
|
|
||||||
// Done! A file called 'My First Document.docx' will be in your file system.
|
// Done! A file called 'My Document.docx' will be in your file system.
|
||||||
```
|
```
|
||||||
|
|
||||||
## Honoured Mentions
|
|
||||||
|
|
||||||
[@felipeochoa](https://github.com/felipeochoa)
|
|
||||||
|
|
||||||
[@h4buli](https://github.com/h4buli)
|
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img alt="clippy the assistant" src="http://i60.tinypic.com/339pvtt.png">
|
<img alt="clippy the assistant" src="./clippy.png">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
10
docs/_coverpage.md
Normal file
10
docs/_coverpage.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
<img src="https://i.imgur.com/37uBGhO.gif" alt="drawing" style="width:200px;"/>
|
||||||
|
|
||||||
|
> Easily generate .docx files with JS/TS. Works for Node and on the Browser. :100:
|
||||||
|
|
||||||
|
- Simple, declarative API
|
||||||
|
- 50+ usage examples
|
||||||
|
- Battle tested, mature, 95%+ coverage
|
||||||
|
|
||||||
|
[GitHub](https://github.com/dolanmiu/docx)
|
||||||
|
[Get Started](#Welcome)
|
@ -1,6 +1,6 @@
|
|||||||
* [Getting Started](/)
|
* [Getting Started](/)
|
||||||
|
|
||||||
* [Examples](examples.md)
|
* [Examples](https://github.com/dolanmiu/docx/tree/master/demo)
|
||||||
|
|
||||||
* API
|
* API
|
||||||
|
|
||||||
@ -20,6 +20,8 @@
|
|||||||
* [Tab Stops](usage/tab-stops.md)
|
* [Tab Stops](usage/tab-stops.md)
|
||||||
* [Table of Contents](usage/table-of-contents.md)
|
* [Table of Contents](usage/table-of-contents.md)
|
||||||
* [Page Numbers](usage/page-numbers.md)
|
* [Page Numbers](usage/page-numbers.md)
|
||||||
|
* [Change Tracking](usage/change-tracking.md)
|
||||||
|
* [Math](usage/math.md)
|
||||||
* Styling
|
* Styling
|
||||||
* [Styling with JS](usage/styling-with-js.md)
|
* [Styling with JS](usage/styling-with-js.md)
|
||||||
* [Styling with XML](usage/styling-with-xml.md)
|
* [Styling with XML](usage/styling-with-xml.md)
|
||||||
@ -28,4 +30,3 @@
|
|||||||
* [Packers](usage/packers.md)
|
* [Packers](usage/packers.md)
|
||||||
|
|
||||||
* [Contribution Guidelines](contribution-guidelines.md)
|
* [Contribution Guidelines](contribution-guidelines.md)
|
||||||
|
|
||||||
|
BIN
docs/clippy.png
Normal file
BIN
docs/clippy.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 30 KiB |
BIN
docs/clippy.psd
Normal file
BIN
docs/clippy.psd
Normal file
Binary file not shown.
@ -1,25 +1,23 @@
|
|||||||
# Contribution Guidelines
|
# Contribution Guidelines
|
||||||
|
|
||||||
* Include documentation reference(s) at the top of each file:
|
- Include documentation reference(s) at the top of each file:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
// http://officeopenxml.com/WPdocument.php
|
// http://officeopenxml.com/WPdocument.php
|
||||||
```
|
```
|
||||||
|
|
||||||
* Follow Prettier standards, and consider using the [Prettier VSCode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) plugin.
|
- Follow Prettier standards, and consider using the [Prettier VSCode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) plugin.
|
||||||
|
|
||||||
* Follow the `TSLint` rules
|
- Follow the `TSLint` rules
|
||||||
|
|
||||||
## Always think about the user
|
## Always think about the user
|
||||||
|
|
||||||
The number one pillar for contribution to `docx` is to **ALWAYS** think about how the user will use `docx`.
|
|
||||||
|
|
||||||
Put yourself in their position, and imagine how they would feel about your feature you wrote.
|
Put yourself in their position, and imagine how they would feel about your feature you wrote.
|
||||||
|
|
||||||
1. Is it easy to use?
|
1. Is it easy to use?
|
||||||
2. Has it been documented well?
|
2. Has it been documented well?
|
||||||
3. Is it intuitive?
|
3. Is it intuitive?
|
||||||
4. Is it consistent with the rest of the API?
|
4. Is it declarative?
|
||||||
5. Is it fun to use?
|
5. Is it fun to use?
|
||||||
|
|
||||||
## Good Commit Names
|
## Good Commit Names
|
||||||
@ -27,6 +25,7 @@ Put yourself in their position, and imagine how they would feel about your featu
|
|||||||
Please write good commit messages when making a commit: https://chris.beams.io/posts/git-commit/
|
Please write good commit messages when making a commit: https://chris.beams.io/posts/git-commit/
|
||||||
|
|
||||||
**Do not:**
|
**Do not:**
|
||||||
|
|
||||||
```
|
```
|
||||||
c // What?
|
c // What?
|
||||||
rtl // Adding acryonyms without explaining anything else is not helpful
|
rtl // Adding acryonyms without explaining anything else is not helpful
|
||||||
@ -35,34 +34,6 @@ demo updated // Getting better, but capitalize the first letter
|
|||||||
Unesesary coment removed // Make sure to use correct spelling
|
Unesesary coment removed // Make sure to use correct spelling
|
||||||
```
|
```
|
||||||
|
|
||||||
## No leaky components in API interface
|
|
||||||
|
|
||||||
> This mainly applies to the API the end user will consume.
|
|
||||||
|
|
||||||
Try to make method parameters of the outside API accept primitives, or `json` objects, so that child components are created **inside** the component, rather than being **injected** in.
|
|
||||||
|
|
||||||
This is so that:
|
|
||||||
|
|
||||||
1. Imports are much cleaner for the end user, no need for:
|
|
||||||
```ts
|
|
||||||
import { ChildComponent } from "./my-feature/sub-component/deeper/.../my-deep.component";
|
|
||||||
```
|
|
||||||
|
|
||||||
2. This is what I consider "leakage". The code is aware of the underlying implementation of the component.
|
|
||||||
3. It means the end user does not need to import and create the child component to be injected.
|
|
||||||
|
|
||||||
**Do not**
|
|
||||||
|
|
||||||
`TableFloatProperties` is a class. The outside world would have to `new` up the object, and inject it in like so:
|
|
||||||
|
|
||||||
```ts
|
|
||||||
public float(tableFloatProperties: TableFloatProperties): Table
|
|
||||||
```
|
|
||||||
|
|
||||||
```ts
|
|
||||||
table.float(new TableFloatProperties(...));
|
|
||||||
```
|
|
||||||
|
|
||||||
**Do**
|
**Do**
|
||||||
|
|
||||||
`ITableFloatOptions` is an interface for a JSON of primitives. The end user would need to pass in a json object and not need to worry about the internals:
|
`ITableFloatOptions` is an interface for a JSON of primitives. The end user would need to pass in a json object and not need to worry about the internals:
|
||||||
@ -71,31 +42,29 @@ This is so that:
|
|||||||
public float(tableFloatOptions: ITableFloatOptions): Table
|
public float(tableFloatOptions: ITableFloatOptions): Table
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Delcariative API
|
||||||
|
|
||||||
|
Make sure the API is declarative, so no _method calling_ or _mutation_. This is a design decision, consistent with the rest of the project. There are benefits to delcariative code over other styles of code, explained here: https://dzone.com/articles/why-declarative-coding-makes-you-a-better-programm
|
||||||
|
|
||||||
|
**Do not:**
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
table.float({...});
|
const paragraph = doc.createParagraph();
|
||||||
|
const text = paragraph.createText();
|
||||||
|
text.contents = "Hello World";
|
||||||
```
|
```
|
||||||
|
|
||||||
## Add vs Create
|
**Do**
|
||||||
|
|
||||||
This is just a guideline, and the rules can sometimes be broken.
|
```ts
|
||||||
|
doc.addSection({
|
||||||
* Use `create` if the method `new`'s up an element inside:
|
children: [
|
||||||
|
new Paragraph({
|
||||||
```ts
|
children: [new TextRun("Hello World")],
|
||||||
public createParagraph() {
|
}),
|
||||||
const paragraph = new Paragraph();
|
],
|
||||||
this.root.push(paragraph);
|
});
|
||||||
}
|
```
|
||||||
```
|
|
||||||
|
|
||||||
* Use `add` if you add the element into the method as a parameter.
|
|
||||||
*Note:* This may look like its breaking the previous guideline, but it has semantically different meanings. The previous one is using data to construct an object, whereas this one is simply adding elements into the document:
|
|
||||||
|
|
||||||
```ts
|
|
||||||
public add(paragraph: Paragraph) {
|
|
||||||
this.root.push(paragraph);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Getters and Setters
|
## Getters and Setters
|
||||||
|
|
||||||
@ -107,7 +76,7 @@ public get Level() {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
There is no performance advantage by doing this. It means we don't need to prefix all private variables with the ugly `_`:
|
This is the convention of this project. There is no performance advantage by doing this. It means we don't need to prefix all private variables with `_`:
|
||||||
|
|
||||||
**Do not:**
|
**Do not:**
|
||||||
|
|
||||||
@ -121,30 +90,6 @@ private get _level: string;
|
|||||||
private get level: string;
|
private get level: string;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Temporal Methods
|
|
||||||
|
|
||||||
Some methods are `non-temporal`, which means regardless of when you call the method, it will have the same affect on the document. For example, setting the width of a table at the end of the document will have the same effect as setting the width at the start:
|
|
||||||
|
|
||||||
```ts
|
|
||||||
table.setWidth(1000); // now removed as of version 5.0.0
|
|
||||||
```
|
|
||||||
|
|
||||||
Whereas some methods are `temporal`, which means depending on the time-frame they are called, it would produce a difference result. For example, moving `createParagraph()` around your code will physically alter the document.
|
|
||||||
|
|
||||||
```ts
|
|
||||||
doc.createParagraph("hello");
|
|
||||||
```
|
|
||||||
|
|
||||||
If a method is `non-temporal`, put it in the objects `constructor`. For example:
|
|
||||||
|
|
||||||
```ts
|
|
||||||
const table = new Table(width: number);
|
|
||||||
```
|
|
||||||
|
|
||||||
`Non-temporal` methods are usually methods which can only be used one time and one time only. For example, `.float()`. It does not make sense to call `.float()` again if its already floating.
|
|
||||||
|
|
||||||
I am not sure what the real term is, but this will do.
|
|
||||||
|
|
||||||
## Interfaces over type alias
|
## Interfaces over type alias
|
||||||
|
|
||||||
Do not use `type`, but rather use `Interfaces`. `type` cannot be extended, and a class cannot implement it.
|
Do not use `type`, but rather use `Interfaces`. `type` cannot be extended, and a class cannot implement it.
|
||||||
@ -152,14 +97,14 @@ Do not use `type`, but rather use `Interfaces`. `type` cannot be extended, and a
|
|||||||
> "In general, use what you want ( type alias / interface ) just be consistent"
|
> "In general, use what you want ( type alias / interface ) just be consistent"
|
||||||
> "always use interface for public API's definition when authoring a library or 3rd party ambient type definitions"
|
> "always use interface for public API's definition when authoring a library or 3rd party ambient type definitions"
|
||||||
>
|
>
|
||||||
> * https://medium.com/@martin_hotell/interface-vs-type-alias-in-typescript-2-7-2a8f1777af4c
|
> - https://medium.com/@martin_hotell/interface-vs-type-alias-in-typescript-2-7-2a8f1777af4c
|
||||||
|
|
||||||
`Interface` is generally preferred over `type`: https://stackoverflow.com/questions/37233735/typescript-interfaces-vs-types
|
`Interface` is generally preferred over `type`: https://stackoverflow.com/questions/37233735/typescript-interfaces-vs-types
|
||||||
|
|
||||||
**Do not:**
|
**Do not:**
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
type RelationshipFileInfo = { id: number, target: string };
|
type RelationshipFileInfo = { id: number; target: string };
|
||||||
```
|
```
|
||||||
|
|
||||||
**Do:**
|
**Do:**
|
||||||
@ -193,26 +138,26 @@ enum WeaponType = {
|
|||||||
|
|
||||||
## Spell correctly, in full and in American English
|
## Spell correctly, in full and in American English
|
||||||
|
|
||||||
I am not sure where these habits in software development come from, but I do not believe it is beneficial:
|
|
||||||
|
|
||||||
**Do not:**
|
**Do not:**
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
readdy // misspelling
|
readdy; // misspelling
|
||||||
perm // abbreviation
|
perm; // abbreviation
|
||||||
conf // abbreviation
|
conf; // abbreviation
|
||||||
cnty // abbreviation
|
cnty; // abbreviation
|
||||||
relationFile // abbreviation
|
relationFile; // abbreviation
|
||||||
colour // U.K. English
|
colour; // U.K. English
|
||||||
```
|
```
|
||||||
|
|
||||||
**Do:**
|
**Do:**
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
ready
|
ready;
|
||||||
permission
|
permission;
|
||||||
config
|
config;
|
||||||
country
|
country;
|
||||||
relationshipFile
|
relationshipFile;
|
||||||
color
|
color;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Keep files small (within reason)
|
## Keep files small (within reason)
|
||||||
|
219
docs/examples.md
219
docs/examples.md
@ -1,219 +0,0 @@
|
|||||||
# Examples
|
|
||||||
|
|
||||||
> All examples can run independently and can be found in the `/demo` folder of the project
|
|
||||||
|
|
||||||
All the examples below can be ran locally, to do so, run the following command:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
npm run demo
|
|
||||||
```
|
|
||||||
|
|
||||||
This command will run the `demo selector app` in the `/demo` folder. It will prompt you to select a demo number, which will run a demo from that folder.
|
|
||||||
|
|
||||||
## Simple
|
|
||||||
|
|
||||||
A simple hello world of the `docx` library:
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo1.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo1.ts_
|
|
||||||
|
|
||||||
## Styles
|
|
||||||
|
|
||||||
### Styling with JS
|
|
||||||
|
|
||||||
This example shows how to customise the look and feel of a document using JS configuration
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo2.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo2.ts_
|
|
||||||
|
|
||||||
### Styling with XML
|
|
||||||
|
|
||||||
This example shows how to customise the look and feel of a document using XML configuration
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo13.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo13.ts_
|
|
||||||
|
|
||||||
## Numbering
|
|
||||||
|
|
||||||
This example shows many levels of numbering
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo3.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo3.ts_
|
|
||||||
|
|
||||||
## Table
|
|
||||||
|
|
||||||
Example of simple table
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo4.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo4.ts_
|
|
||||||
|
|
||||||
### Styling table borders
|
|
||||||
|
|
||||||
Styling the borders of a table
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo20.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo20.ts_
|
|
||||||
|
|
||||||
## Images
|
|
||||||
|
|
||||||
### Add image to the document
|
|
||||||
|
|
||||||
Importing Images from file system path
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo5.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo5.ts_
|
|
||||||
|
|
||||||
### Add images to header and footer
|
|
||||||
|
|
||||||
Example showing how to add image to headers and footers
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo9.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo9.ts_
|
|
||||||
|
|
||||||
### Scaling images
|
|
||||||
|
|
||||||
Example showing how to scale images
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo12.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo12.ts_
|
|
||||||
|
|
||||||
### Add Image to media before adding to document
|
|
||||||
|
|
||||||
This is the best way to add an image to a document because you can add the same image in two locations without increasing document size by re-using the same image
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo23.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo23.ts_
|
|
||||||
|
|
||||||
### Add image to table
|
|
||||||
|
|
||||||
As before, to add an image to a table, you would need to add it to the `Media` object first
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo24.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo24.ts_
|
|
||||||
|
|
||||||
### Images using Base64 URI
|
|
||||||
|
|
||||||
If you want to use a Base64 image instead
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo18.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo18.ts_
|
|
||||||
|
|
||||||
## Margins
|
|
||||||
|
|
||||||
Example showing how to set custom margins
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo6.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo6.ts_
|
|
||||||
|
|
||||||
## Orientation
|
|
||||||
|
|
||||||
Example showing how to set the document to `landscape` or `portrait`
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo7.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo7.ts_
|
|
||||||
|
|
||||||
## Headers & Footers
|
|
||||||
|
|
||||||
Example showing how to add headers and footers
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo8.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo8.ts_
|
|
||||||
|
|
||||||
## Multiple headers and footers
|
|
||||||
|
|
||||||
Check out `Sections` for this feature
|
|
||||||
|
|
||||||
## Page Breaks
|
|
||||||
|
|
||||||
### Normal page breaks
|
|
||||||
|
|
||||||
Example showing how to page break
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo14.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo14.ts_
|
|
||||||
|
|
||||||
### Page break before
|
|
||||||
|
|
||||||
Example showing how to page break before like in Word
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo15.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo15.ts_
|
|
||||||
|
|
||||||
## Sections
|
|
||||||
|
|
||||||
Example of how sections work. Sections allow multiple headers and footers, and `landscape`/`portrait` inside the same document.
|
|
||||||
Also you can have different page number formats and starts for different sections.
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo16.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo16.ts_
|
|
||||||
|
|
||||||
## Footnotes
|
|
||||||
|
|
||||||
Example of how to add footnotes. Good for references
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo17.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo17.ts_
|
|
||||||
|
|
||||||
## Packers
|
|
||||||
|
|
||||||
## Buffer output
|
|
||||||
|
|
||||||
Example showing how to use the Buffer packer and then write that buffer to the file system
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo19.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo19.ts_
|
|
||||||
|
|
||||||
|
|
||||||
## Bookmarks
|
|
||||||
|
|
||||||
Example showing how to make bookmarks to make internal hyperlinks within the document
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo21.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo21.ts_
|
|
||||||
|
|
||||||
## Bidirectional text
|
|
||||||
|
|
||||||
Example showing how to use bidirectional text for certain languages such as Hebrew
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo22.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo22.ts_
|
|
||||||
|
|
||||||
## Showcase
|
|
||||||
|
|
||||||
### My CV
|
|
||||||
|
|
||||||
Example showing how to add headers and footers
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo10.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo10.ts_
|
|
||||||
|
|
||||||
### Style and Images
|
|
||||||
|
|
||||||
This example shows how to customise the look and feel of a document and add images
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo11.ts ':include')
|
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo11.ts_
|
|
BIN
docs/images/math-example.png
Normal file
BIN
docs/images/math-example.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 16 KiB |
@ -1,31 +1,36 @@
|
|||||||
<!DOCTYPE html>
|
<!DOCTYPE html>
|
||||||
<html lang="en">
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<title>docx - Generate .docx documents with JavaScript</title>
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
|
||||||
|
<meta name="description" content="Generate .docx documents with JavaScript" />
|
||||||
|
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0" />
|
||||||
|
<link
|
||||||
|
rel="stylesheet"
|
||||||
|
href="//cdn.jsdelivr.net/npm/docsify-darklight-theme@latest/dist/style.min.css"
|
||||||
|
title="docsify-darklight-theme"
|
||||||
|
type="text/css"
|
||||||
|
/>
|
||||||
|
</head>
|
||||||
|
|
||||||
<head>
|
<body>
|
||||||
<meta charset="UTF-8">
|
<div id="app"></div>
|
||||||
<title>docx - Generate .docx documents with JavaScript</title>
|
<script>
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
|
window.$docsify = {
|
||||||
<meta name="description" content="Generate .docx documents with JavaScript">
|
name: "docx",
|
||||||
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
|
repo: "https://github.com/dolanmiu/docx",
|
||||||
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
|
loadSidebar: true,
|
||||||
</head>
|
subMaxLevel: 2,
|
||||||
|
search: "auto",
|
||||||
<body>
|
coverpage: true,
|
||||||
<div id="app"></div>
|
};
|
||||||
<script>
|
</script>
|
||||||
window.$docsify = {
|
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
|
||||||
name: 'docx',
|
<script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>
|
||||||
repo: 'https://github.com/dolanmiu/docx',
|
<script src="https://unpkg.com/docsify-copy-code@2"></script>
|
||||||
loadSidebar: true,
|
<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
|
||||||
subMaxLevel: 2,
|
<script src="//unpkg.com/prismjs/components/prism-typescript.min.js"></script>
|
||||||
search: 'auto',
|
<script src="//cdn.jsdelivr.net/npm/docsify-darklight-theme@latest/dist/index.min.js" type="text/javascript"></script>
|
||||||
}
|
</body>
|
||||||
</script>
|
|
||||||
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
|
|
||||||
<script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>
|
|
||||||
<script src="https://unpkg.com/docsify-copy-code@2"></script>
|
|
||||||
<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
|
|
||||||
<script src="//unpkg.com/prismjs/components/prism-typescript.min.js"></script>
|
|
||||||
</body>
|
|
||||||
|
|
||||||
</html>
|
</html>
|
||||||
|
61
docs/usage/change-tracking.md
Normal file
61
docs/usage/change-tracking.md
Normal file
@ -0,0 +1,61 @@
|
|||||||
|
# Change Tracking
|
||||||
|
|
||||||
|
> Instead of adding a `TextRun` into a `Paragraph`, you can also add an `InsertedTextRun` or `DeletedTextRun` where you need to supply an `id`, `author` and `date` for the change.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { Paragraph, TextRun, InsertedTextRun, DeletedTextRun } from "docx";
|
||||||
|
|
||||||
|
const paragraph = new Paragraph({
|
||||||
|
children: [
|
||||||
|
new TextRun("This is a simple demo "),
|
||||||
|
new TextRun({
|
||||||
|
text: "on how to "
|
||||||
|
}),
|
||||||
|
new InsertedTextRun({
|
||||||
|
text: "mark a text as an insertion ",
|
||||||
|
id: 0,
|
||||||
|
author: "Firstname Lastname",
|
||||||
|
date: "2020-10-06T09:00:00Z",
|
||||||
|
}),
|
||||||
|
new DeletedTextRun({
|
||||||
|
text: "or a deletion.",
|
||||||
|
id: 1,
|
||||||
|
author: "Firstname Lastname",
|
||||||
|
date: "2020-10-06T09:00:00Z",
|
||||||
|
})
|
||||||
|
],
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that for a `InsertedTextRun` and `DeletedTextRun`, it is not possible to simply call it with only a text as in `new TextRun("some text")`, since the additonal fields for change tracking need to be provided. Similar to a normal `TextRun` you can add additional text properties.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { Paragraph, TextRun, InsertedTextRun, DeletedTextRun } from "docx";
|
||||||
|
|
||||||
|
const paragraph = new Paragraph({
|
||||||
|
children: [
|
||||||
|
new TextRun("This is a simple demo"),
|
||||||
|
new DeletedTextRun({
|
||||||
|
text: "with a deletion.",
|
||||||
|
color: "red",
|
||||||
|
bold: true,
|
||||||
|
size: 24,
|
||||||
|
id: 0,
|
||||||
|
author: "Firstname Lastname",
|
||||||
|
date: "2020-10-06T09:00:00Z",
|
||||||
|
})
|
||||||
|
],
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
In addtion to marking text as inserted or deleted, change tracking can also be added via the document settings. This will enable new changes to be tracked as well.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { Document } from "docx";
|
||||||
|
|
||||||
|
const doc = new Document({
|
||||||
|
features: {
|
||||||
|
trackRevisions: true,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
```
|
@ -30,6 +30,24 @@ const doc = new docx.Document({
|
|||||||
* keywords
|
* keywords
|
||||||
* lastModifiedBy
|
* lastModifiedBy
|
||||||
* revision
|
* revision
|
||||||
|
* externalStyles
|
||||||
|
* styles
|
||||||
|
* numbering
|
||||||
|
* footnotes
|
||||||
|
* hyperlinks
|
||||||
|
* background
|
||||||
|
|
||||||
|
### Change background color of Document
|
||||||
|
|
||||||
|
Set the hex value in the document like so:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const doc = new docx.Document({
|
||||||
|
background: {
|
||||||
|
color: "C45911",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
You can mix and match whatever properties you want, or provide no properties.
|
You can mix and match whatever properties you want, or provide no properties.
|
||||||
|
|
||||||
|
265
docs/usage/math.md
Normal file
265
docs/usage/math.md
Normal file
@ -0,0 +1,265 @@
|
|||||||
|
# Math
|
||||||
|
|
||||||
|
!> Math requires an understanding of [Sections](usage/sections.md) and [Paragraphs](usage/paragraph.md).
|
||||||
|
|
||||||
|
## Intro
|
||||||
|
|
||||||
|
1. To add math, create a `Math` object
|
||||||
|
2. Add `MathComponents` inside `Math`
|
||||||
|
3. `MathComponents` can have nested `MathComponents` inside. e.g. A fraction where the numerator is a square root, and the demoninator as another fraction. More on `MathComponents` below
|
||||||
|
4. Make sure to add the `Math` object inside a `Paragraph`
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```ts
|
||||||
|
new Math({
|
||||||
|
children: [
|
||||||
|
new MathRun("2+2"),
|
||||||
|
new MathFraction({
|
||||||
|
numerator: [new MathRun("hi")],
|
||||||
|
denominator: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
```
|
||||||
|
|
||||||
|
This will produce:
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<img alt="clippy the assistant" src="images/math-example.png" width="200">
|
||||||
|
</p>
|
||||||
|
|
||||||
|
## Math Components
|
||||||
|
|
||||||
|
`MathComponents` are the unit sized building blocks of an equation in `docx`. A `MathComponent` takes in more nested `MathComponents` until you reach `MathRun`, which has no children. `MathRun` is similar to a [TextRun](usage/text.md).
|
||||||
|
|
||||||
|
### Math Run
|
||||||
|
|
||||||
|
`MathRun` is the most basic `MathComponent`.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
```ts
|
||||||
|
new MathRun("2+2");
|
||||||
|
```
|
||||||
|
|
||||||
|
```ts
|
||||||
|
new MathRun("hello");
|
||||||
|
```
|
||||||
|
|
||||||
|
An example of it being used inside `Math`:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
new Math({
|
||||||
|
children: [
|
||||||
|
new MathRun("2"),
|
||||||
|
new MathRun("+"),
|
||||||
|
new MathRun("2"),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
```
|
||||||
|
|
||||||
|
### Math Fraction
|
||||||
|
|
||||||
|
`MathFractions` require a `numerator` and a `demoninator`, which are both a list of `MathComponents`
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
```ts
|
||||||
|
new MathFraction({
|
||||||
|
numerator: [new MathRun("1")],
|
||||||
|
denominator: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
```
|
||||||
|
|
||||||
|
```ts
|
||||||
|
new MathFraction({
|
||||||
|
numerator: [
|
||||||
|
new MathRun("1"),
|
||||||
|
new MathRadical({
|
||||||
|
children: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
denominator: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
```
|
||||||
|
|
||||||
|
An example of it being used inside `Math`:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
new Math({
|
||||||
|
children: [
|
||||||
|
new MathFraction({
|
||||||
|
numerator: [new MathRun("1")],
|
||||||
|
denominator: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
new MathText("+"),
|
||||||
|
new MathFraction({
|
||||||
|
numerator: [new MathRun("1")],
|
||||||
|
denominator: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
new MathText("= 1"),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
```
|
||||||
|
|
||||||
|
### Sum
|
||||||
|
|
||||||
|
A `MathComponent` for `Σ`. It can take a `superScript` and/or `subScript` as arguments to add `MathComponents` (usually limits) on the top and bottom
|
||||||
|
|
||||||
|
```ts
|
||||||
|
new MathSum({
|
||||||
|
children: [new MathRun("i")],
|
||||||
|
}),
|
||||||
|
```
|
||||||
|
|
||||||
|
```ts
|
||||||
|
new MathSum({
|
||||||
|
children: [
|
||||||
|
new MathSuperScript({
|
||||||
|
children: [new MathRun("e")],
|
||||||
|
superScript: [new MathRun("2")],
|
||||||
|
})
|
||||||
|
],
|
||||||
|
subScript: [new MathRun("i")],
|
||||||
|
superScript: [new MathRun("10")],
|
||||||
|
}),
|
||||||
|
```
|
||||||
|
|
||||||
|
### Radicals
|
||||||
|
|
||||||
|
A `MathComponent` for the `√` symbol. Examples include, square root, cube root etc. There is an optional `degree` parameter to specify the number of times the radicand is multiplied by itself. For example, `3` for cube root.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
new MathRadical({
|
||||||
|
children: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
```
|
||||||
|
|
||||||
|
Cube root example:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
new MathRadical({
|
||||||
|
children: [
|
||||||
|
new MathFraction({
|
||||||
|
numerator: [new MathRun("1")],
|
||||||
|
denominator: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
new MathRun('+ 1'),
|
||||||
|
],
|
||||||
|
degree: [new MathRun("3")],
|
||||||
|
}),
|
||||||
|
```
|
||||||
|
|
||||||
|
### Super Script
|
||||||
|
|
||||||
|
`MathSuperScripts` are the little numbers written to the top right of numbers or variables. It means the exponent or power if written by itself with the number or variable.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
new MathSuperScript({
|
||||||
|
children: [new MathRun("x")],
|
||||||
|
superScript: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
```
|
||||||
|
|
||||||
|
An example with cosine:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
new MathSuperScript({
|
||||||
|
children: [new MathRun("cos")],
|
||||||
|
superScript: [new MathRun("-1")],
|
||||||
|
}),
|
||||||
|
```
|
||||||
|
|
||||||
|
### Sub Script
|
||||||
|
|
||||||
|
`MathSubScripts` are similar to `MathSuperScripts`, except the little number is written below.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
new MathSubScript({
|
||||||
|
children: [new MathRun("F")],
|
||||||
|
subScript: [new MathRun("n-1")],
|
||||||
|
}),
|
||||||
|
```
|
||||||
|
|
||||||
|
### Sub-Super Script
|
||||||
|
|
||||||
|
`MathSubSuperScripts` are a combination of both `MathSuperScript` and `MathSubScript`.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
new MathSubSuperScript({
|
||||||
|
children: [new MathRun("test")],
|
||||||
|
superScript: [new MathRun("hello")],
|
||||||
|
subScript: [new MathRun("world")],
|
||||||
|
}),
|
||||||
|
```
|
||||||
|
|
||||||
|
### Function
|
||||||
|
|
||||||
|
`MathFunctions` are a way of describing what happens to an input variable, in order to get the output result. It takes a `name` parameter to specify the name of the function.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
new MathFunction({
|
||||||
|
name: [
|
||||||
|
new MathSuperScript({
|
||||||
|
children: [new MathRun("cos")],
|
||||||
|
superScript: [new MathRun("-1")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
children: [new MathRun("100")],
|
||||||
|
}),
|
||||||
|
```
|
||||||
|
|
||||||
|
### Brackets
|
||||||
|
|
||||||
|
#### Square brackets
|
||||||
|
|
||||||
|
```ts
|
||||||
|
new MathSquareBrackets({
|
||||||
|
children: [
|
||||||
|
new MathFraction({
|
||||||
|
numerator: [new MathRun("1")],
|
||||||
|
denominator: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Round brackets
|
||||||
|
|
||||||
|
```ts
|
||||||
|
new MathRoundBrackets({
|
||||||
|
children: [
|
||||||
|
new MathFraction({
|
||||||
|
numerator: [new MathRun("1")],
|
||||||
|
denominator: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Curly brackets
|
||||||
|
|
||||||
|
```ts
|
||||||
|
new MathCurlyBrackets({
|
||||||
|
children: [
|
||||||
|
new MathFraction({
|
||||||
|
numerator: [new MathRun("1")],
|
||||||
|
denominator: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Angled brackets
|
||||||
|
|
||||||
|
```ts
|
||||||
|
new MathAngledBrackets({
|
||||||
|
children: [
|
||||||
|
new MathFraction({
|
||||||
|
numerator: [new MathRun("1")],
|
||||||
|
denominator: [new MathRun("2")],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
```
|
@ -2,11 +2,7 @@
|
|||||||
|
|
||||||
> Packers are the way in which `docx` turns your code into `.docx` format. It is completely decoupled from the `docx.Document`.
|
> Packers are the way in which `docx` turns your code into `.docx` format. It is completely decoupled from the `docx.Document`.
|
||||||
|
|
||||||
Packers in `version 4` and above are now one single `Packer`. It works in both a node and browser environment (Angular etc). Now, the packer returns a `Buffer`, `Blob` or `base64 string`. It is up to you to take that and persist it with node's `fs`, send it down as a downloadable file, or anything else you wish. As of version 4, this library will not have options to export to PDF.
|
Packers works in both a node and browser environment (Angular etc). Now, the packer returns a `Buffer`, `Blob` or `base64 string`. It is up to you to take that and persist it with node's `fs`, send it down as a downloadable file, or anything else you wish. As of `version 4+`, this library will not have options to export to PDF.
|
||||||
|
|
||||||
## Version 5
|
|
||||||
|
|
||||||
Packers in `version 5` and above are now static methods on `Packer`.
|
|
||||||
|
|
||||||
### Export as Buffer
|
### Export as Buffer
|
||||||
|
|
||||||
@ -36,117 +32,3 @@ Packer.toBlob(doc).then((blob) => {
|
|||||||
saveAs(blob, "example.docx");
|
saveAs(blob, "example.docx");
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
## Version 4
|
|
||||||
|
|
||||||
The `Packer` in `version 4` requires an instance of `Packer`, so be sure to `new` it.
|
|
||||||
|
|
||||||
### Export as Buffer
|
|
||||||
|
|
||||||
This will return a NodeJS `Buffer`. If this is used in the browser, it will return a `UInt8Array` instead.
|
|
||||||
|
|
||||||
```ts
|
|
||||||
const packer = new docx.Packer();
|
|
||||||
|
|
||||||
packer.toBuffer(doc).then((buffer) => {
|
|
||||||
fs.writeFileSync("My Document.docx", buffer);
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
### Export as a `base64` string
|
|
||||||
|
|
||||||
```ts
|
|
||||||
const packer = new docx.Packer();
|
|
||||||
|
|
||||||
packer.toBase64String(doc).then((string) => {
|
|
||||||
console.log(string);
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
### Export as Blob
|
|
||||||
|
|
||||||
This is useful if you want to send it as an downloadable in a browser environment.
|
|
||||||
|
|
||||||
```ts
|
|
||||||
const packer = new docx.Packer();
|
|
||||||
|
|
||||||
packer.toBlob(doc).then((blob) => {
|
|
||||||
// saveAs from FileSaver will download the file
|
|
||||||
saveAs(blob, "example.docx");
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
## Version 3 and below
|
|
||||||
|
|
||||||
### File System Packer
|
|
||||||
|
|
||||||
```ts
|
|
||||||
const docx = require("docx");
|
|
||||||
|
|
||||||
const doc = new docx.Document();
|
|
||||||
const exporter = new docx.LocalPacker(doc);
|
|
||||||
exporter.pack("My Document");
|
|
||||||
// Word Document is in file system
|
|
||||||
```
|
|
||||||
|
|
||||||
### Buffer Packer
|
|
||||||
|
|
||||||
```ts
|
|
||||||
const docx = require("docx");
|
|
||||||
|
|
||||||
const doc = new docx.Document();
|
|
||||||
const exporter = new docx.BufferPacker(doc);
|
|
||||||
const buffer = exporter.pack();
|
|
||||||
```
|
|
||||||
|
|
||||||
### Stream Packer
|
|
||||||
|
|
||||||
Creates a `node` `Readable` stream
|
|
||||||
|
|
||||||
```ts
|
|
||||||
const docx = require("docx");
|
|
||||||
|
|
||||||
const doc = new docx.Document();
|
|
||||||
const exporter = new docx.StreamPacker(doc);
|
|
||||||
const stream = exporter.pack();
|
|
||||||
```
|
|
||||||
|
|
||||||
### Express Packer
|
|
||||||
|
|
||||||
The old express packer is now deprecated and may disappear soon, so you should upgrade.
|
|
||||||
|
|
||||||
The reason for this is because it means this project needs to know about and use `express`, which for a Word document generator, does not sound right. Seperation of concerns.
|
|
||||||
|
|
||||||
It will still be usable (for now), but it is ill advised.
|
|
||||||
|
|
||||||
I used the express exporter in my [website](http://www.dolan.bio).
|
|
||||||
|
|
||||||
The recommended way is to use the `StreamPacker` and handle the `express` magic outside of the library:
|
|
||||||
|
|
||||||
```ts
|
|
||||||
const docx = require("docx");
|
|
||||||
|
|
||||||
const doc = new docx.Document();
|
|
||||||
const exporter = new docx.StreamPacker(doc);
|
|
||||||
|
|
||||||
const stream = exporter.pack();
|
|
||||||
|
|
||||||
// Express' response object
|
|
||||||
res.attachment("yourfile.xlsx");
|
|
||||||
stream.pipe(res);
|
|
||||||
```
|
|
||||||
|
|
||||||
where `res` is the response object obtained through the Express router. It is that simple. The file will begin downloading in the browser.
|
|
||||||
|
|
||||||
### PDF Exporting
|
|
||||||
|
|
||||||
You can export your word document as a PDF file like so:
|
|
||||||
|
|
||||||
```ts
|
|
||||||
const exporter = new docx.LocalPacker(doc);
|
|
||||||
exporter.packPdf("My Document");
|
|
||||||
|
|
||||||
// Express
|
|
||||||
const exporter = new docx.ExpressPacker(doc, res);
|
|
||||||
exporter.packPdf("My Document");
|
|
||||||
```
|
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
> Everything (text, images, graphs etc) in OpenXML is organised in paragraphs.
|
> Everything (text, images, graphs etc) in OpenXML is organised in paragraphs.
|
||||||
|
|
||||||
!> Paragraphs requires an understanding of [Sections](usage/sections.md).
|
!> Paragraphs requires an understanding of [Sections](sections.md).
|
||||||
|
|
||||||
You can create `Paragraphs` in the following ways:
|
You can create `Paragraphs` in the following ways:
|
||||||
|
|
||||||
@ -16,11 +16,11 @@ const paragraph = new Paragraph("Short hand Hello World");
|
|||||||
|
|
||||||
### Children Method
|
### Children Method
|
||||||
|
|
||||||
This method is useful for adding different `text` with different styles or adding `images` inline.
|
This method is useful for adding different [text](text.md) with different styles, [symbols](symbols.md), or adding [images](images.md) inline.
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
const paragraph = new Paragraph({
|
const paragraph = new Paragraph({
|
||||||
children: [new TextRun("Lorem Ipsum Foo Bar"), new TextRun("Hello World")],
|
children: [new TextRun("Lorem Ipsum Foo Bar"), new TextRun("Hello World"), new SymbolRun("F071")],
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -56,27 +56,27 @@ doc.addSection({
|
|||||||
|
|
||||||
This is the list of options for a paragraph. A detailed explanation is below:
|
This is the list of options for a paragraph. A detailed explanation is below:
|
||||||
|
|
||||||
| Property | Type | Mandatory? | Possible Values |
|
| Property | Type | Mandatory? | Possible Values |
|
||||||
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------- |
|
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------- |
|
||||||
| [text](#text) | `string` | Optional | |
|
| [text](#text) | `string` | Optional | |
|
||||||
| [heading](#heading) | `HeadingLevel` | Optional | `HEADING_1`, `HEADING_2`, `HEADING_3`, `HEADING_4`, `HEADING_5`, `HEADING_6`, `TITLE` |
|
| [heading](#heading) | `HeadingLevel` | Optional | `HEADING_1`, `HEADING_2`, `HEADING_3`, `HEADING_4`, `HEADING_5`, `HEADING_6`, `TITLE` |
|
||||||
| [border](#border) | `IBorderOptions` | Optional | `top`, `bottom`, `left`, `right`. Each of these are of type IBorderPropertyOptions. Click here for Example |
|
| [border](#border) | `IBorderOptions` | Optional | `top`, `bottom`, `left`, `right`. Each of these are of type IBorderPropertyOptions. Click here for Example |
|
||||||
| [spacing](#spacing) | `ISpacingProperties` | Optional | See below for ISpacingProperties |
|
| [spacing](#spacing) | `ISpacingProperties` | Optional | See below for ISpacingProperties |
|
||||||
| [outlineLevel](#outline-level) | `number` | Optional | |
|
| [outlineLevel](#outline-level) | `number` | Optional | |
|
||||||
| alignment | `AlignmentType` | Optional | |
|
| alignment | `AlignmentType` | Optional | |
|
||||||
| heading | `HeadingLevel` | Optional | |
|
| heading | `HeadingLevel` | Optional | |
|
||||||
| bidirectional | `boolean` | Optional | |
|
| bidirectional | `boolean` | Optional | |
|
||||||
| thematicBreak | `boolean` | Optional | |
|
| thematicBreak | `boolean` | Optional | |
|
||||||
| pageBreakBefore | `boolean` | Optional | |
|
| pageBreakBefore | `boolean` | Optional | |
|
||||||
| contextualSpacing | `boolean` | Optional | |
|
| contextualSpacing | `boolean` | Optional | |
|
||||||
| indent | `IIndentAttributesProperties` | Optional | |
|
| indent | `IIndentAttributesProperties` | Optional | |
|
||||||
| keepLines | `boolean` | Optional | |
|
| keepLines | `boolean` | Optional | |
|
||||||
| keepNext | `boolean` | Optional | |
|
| keepNext | `boolean` | Optional | |
|
||||||
| children | `(TextRun or PictureRun or Hyperlink)[]` | Optional | |
|
| children | `(TextRun or PictureRun or Hyperlink)[]` | Optional | |
|
||||||
| style | `string` | Optional | |
|
| style | `string` | Optional | |
|
||||||
| tabStop | `{ left?: ITabStopOptions; right?: ITabStopOptions; maxRight?: { leader: LeaderType; }; center?: ITabStopOptions }` | Optional | |
|
| tabStop | `{ left?: ITabStopOptions; right?: ITabStopOptions; maxRight?: { leader: LeaderType; }; center?: ITabStopOptions }` | Optional | |
|
||||||
| bullet | `{ level: number }` | Optional | |
|
| bullet | `{ level: number }` | Optional | |
|
||||||
| numbering | `{ num: Num; level: number; custom?: boolean }` | Optional | |
|
| numbering | `{ num: ConcreteNumbering; level: number; custom?: boolean }` | Optional | |
|
||||||
|
|
||||||
## Text
|
## Text
|
||||||
|
|
||||||
@ -142,6 +142,21 @@ const paragraph = new Paragraph({
|
|||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Shading
|
||||||
|
|
||||||
|
Add color to an entire paragraph block
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const paragraph = new Paragraph({
|
||||||
|
text: "shading",
|
||||||
|
shading: {
|
||||||
|
type: ShadingType.REVERSE_DIAGONAL_STRIPE,
|
||||||
|
color: "00FFFF",
|
||||||
|
fill: "FF0000",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
## Spacing
|
## Spacing
|
||||||
|
|
||||||
Adding spacing between paragraphs
|
Adding spacing between paragraphs
|
||||||
@ -244,10 +259,12 @@ The above example will create a heading with a page break directly under it.
|
|||||||
|
|
||||||
## Page Break
|
## Page Break
|
||||||
|
|
||||||
To move to a new page (insert a page break), simply add `.pageBreak()` on a paragraph:
|
To move to a new page (insert a page break):
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
const paragraph = new docx.Paragraph("Amazing Heading").pageBreak();
|
const paragraph = new docx.Paragraph({
|
||||||
|
children: [new TextRun("Amazing Heading"), new PageBreak()],
|
||||||
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
The above example will create a heading and start a new page immediately afterwards.
|
The above example will create a heading and start a new page immediately afterwards.
|
||||||
|
@ -3,112 +3,148 @@
|
|||||||
## Example
|
## Example
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
const para = new Paragraph("To whom it may concern:").heading2().center();
|
const para = new Paragraph({
|
||||||
|
text: "To whom it may concern:",
|
||||||
|
heading: HeadingLevel.HEADING_2,
|
||||||
|
alignment: AlignmentType.CENTER,
|
||||||
|
});
|
||||||
|
|
||||||
const name = new TextRun("Name:")
|
const name = new TextRun({
|
||||||
.bold()
|
text: "Name:",
|
||||||
.font("Calibri")
|
bold: true,
|
||||||
.allCaps();
|
font: "Calibri",
|
||||||
|
allCaps: true,
|
||||||
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
## Available methods
|
## Available Options
|
||||||
|
|
||||||
* For run formatting:
|
### Run formatting
|
||||||
* `.bold()`, `.italics()`, `.smallCaps()`, `.allCaps()`, `.strike()`, `.doubleStrike()`, `.subScript()`, `.superScript()`: Set the formatting property to true
|
|
||||||
* `.underline(style="single", color=null)`: Set the underline style and color
|
|
||||||
* `.color(color)`: Set the text color, using 6 hex characters for RRGGBB (no leading `#`)
|
|
||||||
* `.size(halfPts)`: Set the font size, measured in half-points
|
|
||||||
* `.font(name)`: Set the run's font
|
|
||||||
* `.style(name)`: Apply a named run style
|
|
||||||
* `.characterSpacing(value)`: Set the character spacing adjustment (in TWIPs)
|
|
||||||
* For paragraph formatting:
|
|
||||||
* `.heading1()`, `.heading2()`, `.heading3()`, `.heading4()`, `.heading5()`, `.title()`: apply the appropriate style to the paragraph
|
|
||||||
* `.left()`, `.center()`, `.right()`, `.justified()`: set the paragraph's alignment
|
|
||||||
* `.thematicBreak()`, `.pageBreak()`: Insert a thick rule or a page break beneath the paragraph
|
|
||||||
* `.leftTabStop(position)`: Add a left tab stop (measured in TWIPs from the left)
|
|
||||||
* `.maxRightTabStop()`: Add a right tab stop at the far right
|
|
||||||
* `.bullet()`: Use the default bullet style
|
|
||||||
* `.setNumbering(numbering, indentLevel)`: Use a custom numbering format for the paragraph
|
|
||||||
* `.style(name)`: Apply a named paragraph style
|
|
||||||
* `.indent(start, hanging=0)`: Set the paragraph's indent level (in TWIPs)
|
|
||||||
* `.spacing({before=0, after=0, line=0})`: Set the line and before/after on the paragraph. Before/after is measured in TWIPs, line is measured in 240ths of a line
|
|
||||||
|
|
||||||
Paragraph styles have all the run formatting methods, except `style()`, and `.left()`, `.center()`, `.right()`, `.justified()`, `.thematicBreak()`, `.leftTabStop(position)`, `.maxRightTabStop()`, `.indent(start, hanging=0)`, and `.spacing({before=0, after=0, line=0})` methods.
|
- `bold`, `italics`, `smallCaps`, `allCaps`, `strike`, `doubleStrike`, `subScript`, `superScript`: Set the formatting property to true
|
||||||
|
- `underline({type="single", color=null})`: Set the underline style and color
|
||||||
|
- `emphasisMark({type="dot"})`: Set the emphasis mark style
|
||||||
|
- `color(color)`: Set the text color, using 6 hex characters for RRGGBB (no leading `#`)
|
||||||
|
- `size(halfPts)`: Set the font size, measured in half-points
|
||||||
|
- `font(name)` or `font({ascii, cs, eastAsia, hAnsi, hint})`: Set the run's font
|
||||||
|
- `style(name)`: Apply a named run style
|
||||||
|
- `characterSpacing(value)`: Set the character spacing adjustment (in TWIPs)
|
||||||
|
|
||||||
|
### Paragraph formatting
|
||||||
|
|
||||||
|
- `heading1`, `heading2`, `heading3`, `heading4`, `heading5`, `title`: apply the appropriate style to the paragraph
|
||||||
|
- `left`, `center`, `right`, `justified`: set the paragraph's alignment
|
||||||
|
- `thematicBreak`, `pageBreak`: Insert a thick rule or a page break beneath the paragraph
|
||||||
|
- `leftTabStop(position)`: Add a left tab stop (measured in TWIPs from the left)
|
||||||
|
- `maxRightTabStop`: Add a right tab stop at the far right
|
||||||
|
- `bullet`: Use the default bullet style
|
||||||
|
- `setNumbering(numbering, indentLevel)`: Use a custom numbering format for the paragraph
|
||||||
|
- `style(name)`: Apply a named paragraph style
|
||||||
|
- `indent(start, hanging=0)`: Set the paragraph's indent level (in TWIPs)
|
||||||
|
- `spacing({before=0, after=0, line=0})`: Set the line and before/after on the paragraph. Before/after is measured in TWIPs, line is measured in 240ths of a line
|
||||||
|
|
||||||
|
Paragraph styles have all the run formatting methods, except `style()`, and `left()`, `center()`, `right()`, `justified()`, `thematicBreak()`, `leftTabStop(position)`, `maxRightTabStop()`, `indent(start, hanging=0)`, and `spacing({before=0, after=0, line=0})` methods.
|
||||||
|
|
||||||
## Detailed guide
|
## Detailed guide
|
||||||
|
|
||||||
There are 4 items in DOCX that can be styled:
|
There are 4 items in `docx` that can be styled:
|
||||||
|
|
||||||
* Characters: Attributes that can change within a paragraph. e.g., bold, italics, etc.
|
- Characters: Attributes that can change within a paragraph. e.g., bold, italics, etc.
|
||||||
* Paragraphs: Attributes like indent, text alignment, line spacing, etc.
|
- Paragraphs: Attributes like indent, text alignment, line spacing, etc.
|
||||||
* Tables: Border styles, table formats, etc.
|
- Tables: Border styles, table formats, etc.
|
||||||
* List items: These are the numbers and bullets that are automatically inserted
|
- List items: These are the numbers and bullets that are automatically inserted
|
||||||
|
|
||||||
There are a few different ways of styling this content in DOCX, which somewhat resemble the HTML/CSS approach. In order of greatest to lowest priority:
|
There are a few different ways of styling this content in `docx`, which somewhat resemble the HTML/CSS approach. In order of greatest to lowest priority:
|
||||||
|
|
||||||
1. Direct formatting (AKA inline formatting)
|
1. Direct formatting (inline formatting)
|
||||||
2. Centrally defined styles (similar to external CSS)
|
2. Declaritive Styles (similar to external CSS)
|
||||||
3. Document defaults (similar to a `*` rule in CSS)
|
3. Document defaults (similar to a `*` rule in CSS)
|
||||||
|
|
||||||
Unlike CSS, less specific rules don't _necessarily_ override parent rules. The rules are a bit wonky, but if you're interested, see the [advanced formatting section](#Advanced formatting).
|
Unlike CSS, less specific rules don't _necessarily_ override parent rules. The rules are a bit wonky, but if you're interested, see the [advanced formatting section](#Advanced formatting).
|
||||||
|
|
||||||
### Direct formatting (AKA inline formatting)
|
### Direct formatting (inline formatting)
|
||||||
|
|
||||||
This is the type of formatting that your uncle uses when he types out documents: _N ... a ... m ... e ... :_ Then he grabs the mouse, highlights _Name:_ and moves over to the **B** for bold. This manner of formatting results in markup that is similar to writing `<span style="bold: true">Name:</span>` if you were typing out HTML. DOCX (the format) allows you to specify this for any of the four types of items. `docx` (the library) only supports this type of formatting for paragraphs and characters, using a _fluent_ api. Thus you could do:
|
This is the type of formatting that your uncle uses when he types out documents: _N ... a ... m ... e ... :_ Then he grabs the mouse, highlights _Name:_ and moves over to the **B** for bold. This manner of formatting results in markup that is similar to writing `<span style="bold: true">Name:</span>` if you were typing out HTML. `docx` (the format) allows you to specify this for any of the four types of items. `docx` (the library) only supports this type of formatting for paragraphs and characters, using a _fluent_ api. Thus you could do:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
const name = new TextRun("Name:")
|
const name = new TextRun({
|
||||||
.bold()
|
text: "Name:",
|
||||||
.font("Calibri")
|
bold: true,
|
||||||
.allCaps();
|
font: "Calibri",
|
||||||
|
allCaps: true,
|
||||||
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
Or for paragraph formatting:
|
Or for paragraph formatting:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
const para = new Paragraph("To whom it may concern:").heading2().center();
|
const para = new Paragraph({
|
||||||
|
text: "To whom it may concern:",
|
||||||
|
heading: HeadingLevel.HEADING_2,
|
||||||
|
alignment: AlignmentType.CENTER,
|
||||||
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
### Centrally defined styles (similar to external CSS)
|
### Declaritive Styles (similar to external CSS)
|
||||||
|
|
||||||
DOCX files contain a styles section separate from the main content, much like how HTML includes CSS files. Unlike CSS, DOCX distinguishes between styles meant for tables (which show up in the table formatting toolbar), styles for lists (which show up under bullets and numbering), and styles for runs and paragraphs, which show up as dropdowns offering standard styles, like "Heading 1", "Caption", or any custom styles defined in that document. <!-- TODO: add pictures of the panes -->. `docx` allows you to define these styles using a fluent interface as well.
|
`docx` files contain a styles section separate from the main content, much like how HTML includes CSS files. Unlike CSS, `docx` distinguishes between styles meant for tables (which show up in the table formatting toolbar), styles for lists (which show up under bullets and numbering), and styles for runs and paragraphs, which show up as dropdowns offering standard styles, like "Heading 1", "Caption", or any custom styles defined in that document. <!-- TODO: add pictures of the panes -->. `docx` allows you to define these styles using a fluent interface as well.
|
||||||
|
|
||||||
There are three parts to using custom styles with `docx`:
|
To add styles, define your custom styles in the `document`:
|
||||||
|
|
||||||
1. Create a container object for the style definitions:
|
```ts
|
||||||
```ts
|
// The first argument is an ID you use to apply the style to paragraphs
|
||||||
const myStyles = new docx.Styles();
|
// The second argument is a human-friendly name to show in the UI
|
||||||
```
|
const doc = new Document({
|
||||||
2. Define your custom styles, similar to the way you would format a paragraph or run
|
creator: "Clippy",
|
||||||
|
title: "Sample Document",
|
||||||
```ts
|
description: "A brief example of using docx",
|
||||||
// The first argument is an ID you use to apply the style to paragraphs
|
styles: {
|
||||||
// The second argument is a human-friendly name to show in the UI
|
paragraphStyles: [
|
||||||
myStyles
|
{
|
||||||
.createParagraphStyle("myWonkyStyle", "My Wonky Style")
|
id: "myWonkyStyle",
|
||||||
.basedOn("Normal")
|
name: "My Wonky Style",
|
||||||
.next("Normal")
|
basedOn: "Normal",
|
||||||
.color("999999")
|
next: "Normal",
|
||||||
.italics()
|
quickFormat: true,
|
||||||
.indent(720) // 720 TWIP === 720 / 20 pt === .5 in
|
run: {
|
||||||
.spacing({ line: 276 }); // 276 / 240 = 1.15x line spacing
|
italics: true,
|
||||||
|
color: "999999",
|
||||||
myStyles
|
},
|
||||||
.createParagraphStyle("Heading2", "Heading 2")
|
paragraph: {
|
||||||
.basedOn("Normal")
|
spacing: {
|
||||||
.next("Normal")
|
line: 276,
|
||||||
.quickFormat()
|
},
|
||||||
.size(26) // 26 half-points === 13pt font
|
indent: {
|
||||||
.bold()
|
left: 720,
|
||||||
.underline("double", "FF0000")
|
},
|
||||||
.spacing({ before: 240, after: 120 }); // TWIP for both
|
},
|
||||||
```
|
},
|
||||||
|
{
|
||||||
3. When you generate your document, make sure to pass the `styles` container to the `Packer`:
|
id: "Heading2",
|
||||||
|
name: "Heading 2",
|
||||||
```ts
|
basedOn: "Normal",
|
||||||
Packer.pack(myOutStream);
|
next: "Normal",
|
||||||
```
|
quickFormat: true,
|
||||||
|
run: {
|
||||||
|
size: 26
|
||||||
|
bold: true,
|
||||||
|
color: "999999",
|
||||||
|
{
|
||||||
|
type: UnderlineType.DOUBLE,
|
||||||
|
color: "FF0000",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
paragraph: {
|
||||||
|
spacing: {
|
||||||
|
before: 240,
|
||||||
|
after: 120
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]
|
||||||
|
}
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
**Note**: If you are using the `.headingX` or `.title` methods of paragraphs, you must make sure to define `HeadingX` or `Title` styles for these. Otherwise they'll show up unstyled :(. If you are using the `.bullet` or `.setNumbering` methods, you need to define a `ListParagraph` style or the numbers may not show up.
|
**Note**: If you are using the `.headingX` or `.title` methods of paragraphs, you must make sure to define `HeadingX` or `Title` styles for these. Otherwise they'll show up unstyled :(. If you are using the `.bullet` or `.setNumbering` methods, you need to define a `ListParagraph` style or the numbers may not show up.
|
||||||
|
|
||||||
@ -144,19 +180,29 @@ To determine the value of a styling property, you must first identify whether it
|
|||||||
|
|
||||||
The following properties are treated in a special manner; they're called toggle properties:
|
The following properties are treated in a special manner; they're called toggle properties:
|
||||||
|
|
||||||
* Bold
|
- Bold
|
||||||
* All caps
|
- All caps
|
||||||
* Small caps
|
- Small caps
|
||||||
* Italics
|
- Italics
|
||||||
* Single strike-through
|
- Single strike-through
|
||||||
* Hidden
|
- Hidden
|
||||||
* Imprint
|
- Imprint
|
||||||
* Emboss
|
- Emboss
|
||||||
* Character outline
|
- Character outline
|
||||||
* Character shadow
|
- Character shadow
|
||||||
|
|
||||||
For these properties, the rules state the following conflict resolution in case the property is specified at multiple points for the same item:
|
For these properties, the rules state the following conflict resolution in case the property is specified at multiple points for the same item:
|
||||||
|
|
||||||
* Direct formatting trumps all if specified (either true or false)
|
- Direct formatting trumps all if specified (either true or false)
|
||||||
* Otherwise, if the property is true in document defaults, the property is set to true
|
- Otherwise, if the property is true in document defaults, the property is set to true
|
||||||
* Otherwise, the property's value is an XOR of its effective table, paragraph, and character values. (So specifying bold `true` on a table style and a paragraph style would result in non-bold text if a paragraph inside the table had that style)
|
- Otherwise, the property's value is an XOR of its effective table, paragraph, and character values. (So specifying bold `true` on a table style and a paragraph style would result in non-bold text if a paragraph inside the table had that style)
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Declaritive styles
|
||||||
|
|
||||||
|
Importing Images from file system path
|
||||||
|
|
||||||
|
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/2-declaritive-styles.ts ':include')
|
||||||
|
|
||||||
|
_Source: https://github.com/dolanmiu/docx/blob/master/demo/2-declaritive-styles.ts_
|
||||||
|
53
docs/usage/symbols.md
Normal file
53
docs/usage/symbols.md
Normal file
@ -0,0 +1,53 @@
|
|||||||
|
# Symbol Runs
|
||||||
|
|
||||||
|
!> SymbolRuns require an understanding of [Paragraphs](paragraph.md).
|
||||||
|
|
||||||
|
You can add multiple `symbol runs` in `Paragraphs` along with [text runs](text.md) using the Paragraph's `children` property.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { Paragraph, TextRun, SymbolRun } from "docx";
|
||||||
|
|
||||||
|
const paragraph = new Paragraph({
|
||||||
|
children: [
|
||||||
|
new TextRun("This is a checkbox: "),
|
||||||
|
new SymbolRun("F071")
|
||||||
|
],
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## Specifying symbol font
|
||||||
|
|
||||||
|
By default symbol runs will use the `Wingdings` font. To switch fonts, pass an object instead of a string to the `SymbolRun` constructor and specify `char` and `symbolfont` properties:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const symbol = new SymbolRun({
|
||||||
|
char: "F071",
|
||||||
|
symbolfont: "Arial",
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## Example symbols
|
||||||
|
|
||||||
|
Symbols are specified by their hexidecimal code. Ref http://officeopenxml.com/WPtextSpecialContent-symbol.php. Below are some examples.
|
||||||
|
|
||||||
|
- `F071`: empty checkbox
|
||||||
|
- `F043`: thumbs up
|
||||||
|
- `F04A`: smile
|
||||||
|
- `F04C`: frown
|
||||||
|
- `F022`: scissors
|
||||||
|
- `F0F0`: right arrow
|
||||||
|
- `F0FE`: checked box
|
||||||
|
|
||||||
|
## Typographical Emphasis
|
||||||
|
|
||||||
|
Symbol runs can have their display modified just like text runs. For example, they can be bolded and italicized:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const symbol = new SymbolRun({
|
||||||
|
char: "F071",
|
||||||
|
bold: true,
|
||||||
|
italics: true,
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
See the [text run](text.md) documentation for more info.
|
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
> Tab stops are useful, if you are unclear of what they are, [here is a link explaining](https://en.wikipedia.org/wiki/Tab_stop). It enables side by side text which is nicely laid out without the need for tables, or constantly pressing space bar.
|
> Tab stops are useful, if you are unclear of what they are, [here is a link explaining](https://en.wikipedia.org/wiki/Tab_stop). It enables side by side text which is nicely laid out without the need for tables, or constantly pressing space bar.
|
||||||
|
|
||||||
!> **Note**: At the moment, the unit of measurement for a tab stop is counter intuitive for a human. It is using OpenXMLs own measuring system. For example, 2268 roughly translates to 3cm. Therefore in the future, I may consider changing it to percentages or even cm.
|
!> **Note**: The unit of measurement for a tab stop is in [DXA](https://stackoverflow.com/questions/14360183/default-wordml-unit-measurement-pixel-or-point-or-inches)
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@ -11,44 +11,111 @@ Simply call the relevant methods on the paragraph listed below. Then just add a
|
|||||||
## Example
|
## Example
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
const paragraph = new docx.Paragraph().maxRightTabStop();
|
const paragraph = new Paragraph({
|
||||||
const leftText = new docx.TextRun("Hey everyone").bold();
|
children: [new TextRun("Hey everyone").bold(), new TextRun(\t"11th November 1999")],
|
||||||
const rightText = new docx.TextRun("11th November 2015").tab();
|
tabStops: [
|
||||||
paragraph.addRun(leftText);
|
{
|
||||||
paragraph.addRun(rightText);
|
type: TabStopType.RIGHT,
|
||||||
|
position: TabStopPosition.MAX,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
```
|
```
|
||||||
The example above will create a left aligned text, and a right aligned text on the same line. The laymans approach to this problem would be to either use text boxes or tables. YUK!
|
|
||||||
|
The example above will create a left aligned text, and a right aligned text on the same line. The laymans approach to this problem would be to either use text boxes or tables. Not ideal!
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
const paragraph = new docx.Paragraph();
|
const paragraph = new Paragraph({
|
||||||
paragraph.maxRightTabStop();
|
children: [new TextRun("Second tab stop here I come!")],
|
||||||
paragraph.leftTabStop(1000);
|
tabStops: [
|
||||||
const text = new docx.TextRun("Second tab stop here I come!").tab().tab();
|
{
|
||||||
paragraph.addRun(text);
|
type: TabStopType.RIGHT,
|
||||||
|
position: TabStopPosition.MAX,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: TabStopType.LEFT,
|
||||||
|
position: 1000,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
The above shows the use of two tab stops, and how to select/use it.
|
The above shows the use of two tab stops, and how to select/use it.
|
||||||
|
|
||||||
## Left Tab Stop
|
You can add multiple tab stops of the same `type` too.
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
paragraph.leftTabStop(2268);
|
const paragraph = new Paragraph({
|
||||||
|
children: [new TextRun("Multiple tab stops!")],
|
||||||
|
tabStops: [
|
||||||
|
{
|
||||||
|
type: TabStopType.RIGHT,
|
||||||
|
position: TabStopPosition.MAX,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: TabStopType.RIGHT,
|
||||||
|
position: 1000,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Left Tab Stop
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const paragraph = new Paragraph({
|
||||||
|
tabStops: [
|
||||||
|
{
|
||||||
|
type: TabStopType.LEFT,
|
||||||
|
position: 2268,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
2268 is the distance from the left side.
|
2268 is the distance from the left side.
|
||||||
|
|
||||||
## Center Tab Stop
|
## Center Tab Stop
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
paragraph.centerTabStop(2268);
|
const paragraph = new Paragraph({
|
||||||
|
tabStops: [
|
||||||
|
{
|
||||||
|
type: TabStopType.CENTER,
|
||||||
|
position: 2268,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
```
|
```
|
||||||
2268 is the distance from the left side.
|
|
||||||
|
2268 is the distance from the center.
|
||||||
|
|
||||||
## Right Tab Stop
|
## Right Tab Stop
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
paragraph.rightTabStop(2268);
|
const paragraph = new Paragraph({
|
||||||
|
tabStops: [
|
||||||
|
{
|
||||||
|
type: TabStopType.RIGHT,
|
||||||
|
position: 2268,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
```
|
```
|
||||||
2268 is the distance from the left side.
|
|
||||||
|
2268 is the distance fro0oum the left side.
|
||||||
|
|
||||||
## Max Right Tab Stop
|
## Max Right Tab Stop
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
paragraph.maxRightTabStop();
|
const paragraph = new Paragraph({
|
||||||
|
tabStops: [
|
||||||
|
{
|
||||||
|
type: TabStopType.RIGHT,
|
||||||
|
position: TabStopPosition.MAX,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
This will create a tab stop on the very edge of the right hand side. Handy for right aligning and left aligning text on the same line.
|
This will create a tab stop on the very edge of the right hand side. Handy for right aligning and left aligning text on the same line.
|
||||||
|
@ -47,30 +47,6 @@ Here is the list of all options that you can use to generate your tables of cont
|
|||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
```ts
|
|
||||||
// Let's define the options for generate a TOC for heading 1-5 and MySpectacularStyle,
|
|
||||||
// making the entries be hyperlinks for the paragraph
|
|
||||||
const toc = new TableOfContents("Summary", {
|
|
||||||
hyperlink: true,
|
|
||||||
headingStyleRange: "1-5",
|
|
||||||
stylesWithLevels: [new StyleLevel("MySpectacularStyle", 1)],
|
|
||||||
});
|
|
||||||
|
|
||||||
doc.addTableOfContents(toc);
|
|
||||||
|
|
||||||
doc.add(new Paragraph("Header #1").heading1().pageBreakBefore());
|
|
||||||
doc.add(new Paragraph("I'm a little text, very nicely written.'"));
|
|
||||||
|
|
||||||
doc.add(new Paragraph("Header #2").heading1().pageBreakBefore());
|
|
||||||
doc.add(new Paragraph("I'm another text very nicely written.'"));
|
|
||||||
doc.add(new Paragraph("Header #2.1").heading2());
|
|
||||||
doc.add(new Paragraph("I'm another text very nicely written.'"));
|
|
||||||
|
|
||||||
doc.add(new Paragraph("My Spectacular Style #1").style("MySpectacularStyle").pageBreakBefore());
|
|
||||||
```
|
|
||||||
|
|
||||||
### Complete example
|
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/28-table-of-contents.ts ':include')
|
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/28-table-of-contents.ts ':include')
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/28-table-of-contents.ts_
|
_Source: https://github.com/dolanmiu/docx/blob/master/demo/28-table-of-contents.ts_
|
||||||
|
@ -51,19 +51,6 @@ const table = new Table({
|
|||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
### Pagination
|
|
||||||
|
|
||||||
#### Prevent row pagination
|
|
||||||
|
|
||||||
To prevent breaking contents of a row across multiple pages, call `cantSplit`:
|
|
||||||
|
|
||||||
```ts
|
|
||||||
const table = new Table({
|
|
||||||
rows: [],
|
|
||||||
cantSplit: true,
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
## Table Row
|
## Table Row
|
||||||
|
|
||||||
A table consists of multiple `table rows`. Table rows have a list of `children` which accepts a list of `table cells` explained below. You can create a simple `table row` like so:
|
A table consists of multiple `table rows`. Table rows have a list of `children` which accepts a list of `table cells` explained below. You can create a simple `table row` like so:
|
||||||
@ -103,7 +90,7 @@ Here is a list of options you can add to the `table row`:
|
|||||||
| children | `Array<TableCell>` | Required |
|
| children | `Array<TableCell>` | Required |
|
||||||
| cantSplit | `boolean` | Optional |
|
| cantSplit | `boolean` | Optional |
|
||||||
| tableHeader | `boolean` | Optional |
|
| tableHeader | `boolean` | Optional |
|
||||||
| height | `{ value: number, rule: HeightRule }` | Optional |
|
| height | `{ height: number, rule: HeightRule }` | Optional |
|
||||||
|
|
||||||
### Repeat row
|
### Repeat row
|
||||||
|
|
||||||
@ -116,6 +103,19 @@ const row = new TableRow({
|
|||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Pagination
|
||||||
|
|
||||||
|
#### Prevent row pagination
|
||||||
|
|
||||||
|
To prevent breaking contents of a row across multiple pages, call `cantSplit`:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const row = new Row({
|
||||||
|
...,
|
||||||
|
cantSplit: true,
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
## Table Cells
|
## Table Cells
|
||||||
|
|
||||||
Cells need to be added in the `table row`, you can create a table cell like:
|
Cells need to be added in the `table row`, you can create a table cell like:
|
||||||
@ -328,7 +328,7 @@ const cell = new TableCell({
|
|||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/4-basic-table.ts ":include")
|
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/4-basic-table.ts ':include')
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/4-basic-table.ts_
|
_Source: https://github.com/dolanmiu/docx/blob/master/demo/4-basic-table.ts_
|
||||||
|
|
||||||
@ -336,7 +336,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/4-basic-table.ts_
|
|||||||
|
|
||||||
Example showing how to add colourful borders to tables
|
Example showing how to add colourful borders to tables
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/20-table-cell-borders.ts ":include")
|
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/20-table-cell-borders.ts ':include')
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/20-table-cell-borders.ts_
|
_Source: https://github.com/dolanmiu/docx/blob/master/demo/20-table-cell-borders.ts_
|
||||||
|
|
||||||
@ -344,11 +344,11 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/20-table-cell-borders
|
|||||||
|
|
||||||
Example showing how to add images to tables
|
Example showing how to add images to tables
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/24-images-to-table-cell.ts ":include")
|
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/24-images-to-table-cell.ts ':include')
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/24-images-to-table-cell.ts_
|
_Source: https://github.com/dolanmiu/docx/blob/master/demo/24-images-to-table-cell.ts_
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/36-image-to-table-cell.ts ":include")
|
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/36-image-to-table-cell.ts ':include')
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/36-image-to-table-cell.ts_
|
_Source: https://github.com/dolanmiu/docx/blob/master/demo/36-image-to-table-cell.ts_
|
||||||
|
|
||||||
@ -356,7 +356,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/36-image-to-table-cel
|
|||||||
|
|
||||||
Example showing how align text in a table cell
|
Example showing how align text in a table cell
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/31-tables.ts ":include")
|
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/31-tables.ts ':include')
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/31-tables.ts_
|
_Source: https://github.com/dolanmiu/docx/blob/master/demo/31-tables.ts_
|
||||||
|
|
||||||
@ -364,11 +364,11 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/31-tables.ts_
|
|||||||
|
|
||||||
Example showing merging of columns and rows and shading
|
Example showing merging of columns and rows and shading
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/32-merge-table-cells.ts ":include")
|
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/32-merge-and-shade-table-cells.ts ':include')
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/32-merge-table-cells.ts_
|
_Source: https://github.com/dolanmiu/docx/blob/master/demo/32-merge-and-shade-table-cells.ts_
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/41-merge-table-cells-2.ts ":include")
|
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/41-merge-table-cells-2.ts ':include')
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/41-merge-table-cells-2.ts_
|
_Source: https://github.com/dolanmiu/docx/blob/master/demo/41-merge-table-cells-2.ts_
|
||||||
|
|
||||||
@ -376,12 +376,12 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/41-merge-table-cells-
|
|||||||
|
|
||||||
Example showing merging of columns and rows
|
Example showing merging of columns and rows
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/43-images-to-table-cell-2.ts ":include")
|
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/43-images-to-table-cell-2.ts ':include')
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/43-images-to-table-cell-2.ts_
|
_Source: https://github.com/dolanmiu/docx/blob/master/demo/43-images-to-table-cell-2.ts_
|
||||||
|
|
||||||
### Floating tables
|
### Floating tables
|
||||||
|
|
||||||
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/34-floating-tables.ts ":include")
|
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/34-floating-tables.ts ':include')
|
||||||
|
|
||||||
_Source: https://github.com/dolanmiu/docx/blob/master/demo/34-floating-tables.ts_
|
_Source: https://github.com/dolanmiu/docx/blob/master/demo/34-floating-tables.ts_
|
||||||
|
@ -68,40 +68,87 @@ const text = new TextRun({
|
|||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Emphasis Mark
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const text = new TextRun({
|
||||||
|
text: "and then emphasis mark",
|
||||||
|
emphasisMark: {},
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Shading and Highlighting
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const text = new TextRun({
|
||||||
|
text: "shading",
|
||||||
|
shading: {
|
||||||
|
type: ShadingType.REVERSE_DIAGONAL_STRIPE,
|
||||||
|
color: "00FFFF",
|
||||||
|
fill: "FF0000",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const text = new TextRun({
|
||||||
|
text: "highlighting",
|
||||||
|
highlight: "yellow",
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
### Strike through
|
### Strike through
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
text.strike();
|
const text = new TextRun({
|
||||||
|
text: "strike",
|
||||||
|
strike: true,
|
||||||
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
### Double strike through
|
### Double strike through
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
text.doubleStrike();
|
const text = new TextRun({
|
||||||
|
text: "doubleStrike",
|
||||||
|
doubleStrike: true,
|
||||||
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
### Superscript
|
### Superscript
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
text.superScript();
|
const text = new TextRun({
|
||||||
|
text: "superScript",
|
||||||
|
superScript: true,
|
||||||
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
### Subscript
|
### Subscript
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
text.subScript();
|
const text = new TextRun({
|
||||||
|
text: "subScript",
|
||||||
|
subScript: true,
|
||||||
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
### All Capitals
|
### All Capitals
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
text.allCaps();
|
const text = new TextRun({
|
||||||
|
text: "allCaps",
|
||||||
|
allCaps: true,
|
||||||
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
### Small Capitals
|
### Small Capitals
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
text.smallCaps();
|
const text = new TextRun({
|
||||||
|
text: "smallCaps",
|
||||||
|
smallCaps: true,
|
||||||
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
## Break
|
## Break
|
||||||
@ -109,13 +156,8 @@ text.smallCaps();
|
|||||||
Sometimes you would want to put text underneath another line of text but inside the same paragraph.
|
Sometimes you would want to put text underneath another line of text but inside the same paragraph.
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
text.break();
|
const text = new TextRun({
|
||||||
```
|
text: "break",
|
||||||
|
break: true,
|
||||||
## Chaining
|
});
|
||||||
|
|
||||||
What if you want to create a paragraph which is **_bold_** and **_italic_**?
|
|
||||||
|
|
||||||
```ts
|
|
||||||
paragraph.bold().italics();
|
|
||||||
```
|
```
|
||||||
|
9088
package-lock.json
generated
Normal file
9088
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
31
package.json
31
package.json
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "docx",
|
"name": "docx",
|
||||||
"version": "5.0.0-rc6",
|
"version": "5.4.0",
|
||||||
"description": "Generate .docx documents with JavaScript (formerly Office-Clippy)",
|
"description": "Easily generate .docx files with JS/TS with a nice declarative API. Works for Node and on the Browser.",
|
||||||
"main": "build/index.js",
|
"main": "build/index.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"pretest": "rimraf ./build",
|
"pretest": "rimraf ./build",
|
||||||
@ -50,7 +50,9 @@
|
|||||||
"types": "./build/index.d.ts",
|
"types": "./build/index.d.ts",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@types/jszip": "^3.1.4",
|
"@types/jszip": "^3.1.4",
|
||||||
|
"@types/node": "^14.0.5",
|
||||||
"jszip": "^3.1.5",
|
"jszip": "^3.1.5",
|
||||||
|
"shortid": "^2.2.15",
|
||||||
"xml": "^1.0.1",
|
"xml": "^1.0.1",
|
||||||
"xml-js": "^1.6.8"
|
"xml-js": "^1.6.8"
|
||||||
},
|
},
|
||||||
@ -62,9 +64,10 @@
|
|||||||
"homepage": "https://github.com/dolanmiu/docx#readme",
|
"homepage": "https://github.com/dolanmiu/docx#readme",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/chai": "^3.4.35",
|
"@types/chai": "^3.4.35",
|
||||||
"@types/mocha": "^2.2.39",
|
"@types/mocha": "^8.0.0",
|
||||||
"@types/request-promise": "^4.1.42",
|
"@types/request-promise": "^4.1.42",
|
||||||
"@types/sinon": "^4.3.1",
|
"@types/shortid": "0.0.29",
|
||||||
|
"@types/sinon": "^9.0.4",
|
||||||
"@types/webpack": "^4.4.24",
|
"@types/webpack": "^4.4.24",
|
||||||
"awesome-typescript-loader": "^3.4.1",
|
"awesome-typescript-loader": "^3.4.1",
|
||||||
"chai": "^3.5.0",
|
"chai": "^3.5.0",
|
||||||
@ -74,24 +77,24 @@
|
|||||||
"jszip": "^3.1.5",
|
"jszip": "^3.1.5",
|
||||||
"mocha": "^5.2.0",
|
"mocha": "^5.2.0",
|
||||||
"mocha-webpack": "^1.0.1",
|
"mocha-webpack": "^1.0.1",
|
||||||
"nyc": "^13.1.0",
|
"nyc": "^15.1.0",
|
||||||
"pre-commit": "^1.2.2",
|
"pre-commit": "^1.2.2",
|
||||||
"prettier": "^1.15.2",
|
"prettier": "^2.1.2",
|
||||||
"prompt": "^1.0.0",
|
"prompt": "^1.0.0",
|
||||||
"replace-in-file": "^3.1.0",
|
"replace-in-file": "^3.1.0",
|
||||||
"request": "^2.88.0",
|
"request": "^2.88.0",
|
||||||
"request-promise": "^4.2.2",
|
"request-promise": "^4.2.2",
|
||||||
"rimraf": "^2.5.2",
|
"rimraf": "^3.0.2",
|
||||||
"shelljs": "^0.7.7",
|
"shelljs": "^0.8.4",
|
||||||
"sinon": "^5.0.7",
|
"sinon": "^9.0.2",
|
||||||
"ts-node": "^7.0.1",
|
"ts-node": "^9.0.0",
|
||||||
"tslint": "^5.11.0",
|
"tslint": "^6.1.3",
|
||||||
"tslint-immutable": "^4.9.0",
|
"tslint-immutable": "^6.0.1",
|
||||||
"typedoc": "^0.11.1",
|
"typedoc": "^0.16.11",
|
||||||
"typescript": "2.9.2",
|
"typescript": "2.9.2",
|
||||||
"webpack": "^3.10.0"
|
"webpack": "^3.10.0"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=8"
|
"node": ">=10"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -28,15 +28,52 @@ describe("Formatter", () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it("should format simple paragraph with bold text", () => {
|
it("should format simple paragraph with bold text", () => {
|
||||||
const paragraph = new Paragraph("");
|
const paragraph = new Paragraph({
|
||||||
paragraph.addRun(
|
children: [
|
||||||
new TextRun({
|
new TextRun({
|
||||||
text: "test",
|
text: "test",
|
||||||
bold: true,
|
bold: true,
|
||||||
}),
|
}),
|
||||||
);
|
],
|
||||||
const newJson = formatter.format(paragraph);
|
});
|
||||||
assert.isDefined(newJson["w:p"][1]["w:r"][0]["w:rPr"][0]["w:b"]._attr["w:val"]);
|
|
||||||
|
const tree = formatter.format(paragraph);
|
||||||
|
expect(tree).to.deep.equal({
|
||||||
|
"w:p": [
|
||||||
|
{
|
||||||
|
"w:r": [
|
||||||
|
{
|
||||||
|
"w:rPr": [
|
||||||
|
{
|
||||||
|
"w:b": {
|
||||||
|
_attr: {
|
||||||
|
"w:val": true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:bCs": {
|
||||||
|
_attr: {
|
||||||
|
"w:val": true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:t": [
|
||||||
|
{
|
||||||
|
_attr: {
|
||||||
|
"xml:space": "preserve",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"test",
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should format attributes (rsidSect)", () => {
|
it("should format attributes (rsidSect)", () => {
|
||||||
|
@ -1,8 +1,9 @@
|
|||||||
import { BaseXmlComponent, IXmlableObject } from "file/xml-components";
|
import { BaseXmlComponent, IXmlableObject } from "file/xml-components";
|
||||||
|
import { File } from "../file";
|
||||||
|
|
||||||
export class Formatter {
|
export class Formatter {
|
||||||
public format(input: BaseXmlComponent): IXmlableObject {
|
public format(input: BaseXmlComponent, file?: File): IXmlableObject {
|
||||||
const output = input.prepForXml();
|
const output = input.prepForXml(file);
|
||||||
|
|
||||||
if (output) {
|
if (output) {
|
||||||
return output;
|
return output;
|
||||||
|
@ -5,7 +5,7 @@ export class ImageReplacer {
|
|||||||
let currentXmlData = xmlData;
|
let currentXmlData = xmlData;
|
||||||
|
|
||||||
mediaData.forEach((image, i) => {
|
mediaData.forEach((image, i) => {
|
||||||
currentXmlData = currentXmlData.replace(`{${image.fileName}}`, (offset + i).toString());
|
currentXmlData = currentXmlData.replace(new RegExp(`{${image.fileName}}`, "g"), (offset + i).toString());
|
||||||
});
|
});
|
||||||
|
|
||||||
return currentXmlData;
|
return currentXmlData;
|
||||||
|
@ -16,7 +16,7 @@ describe("Compiler", () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
describe("#compile()", () => {
|
describe("#compile()", () => {
|
||||||
it("should pack all the content", async function() {
|
it("should pack all the content", async function () {
|
||||||
this.timeout(99999999);
|
this.timeout(99999999);
|
||||||
const zipFile = compiler.compile(file);
|
const zipFile = compiler.compile(file);
|
||||||
const fileNames = Object.keys(zipFile.files).map((f) => zipFile.files[f].name);
|
const fileNames = Object.keys(zipFile.files).map((f) => zipFile.files[f].name);
|
||||||
@ -35,7 +35,7 @@ describe("Compiler", () => {
|
|||||||
expect(fileNames).to.include("_rels/.rels");
|
expect(fileNames).to.include("_rels/.rels");
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should pack all additional headers and footers", async function() {
|
it("should pack all additional headers and footers", async function () {
|
||||||
file.addSection({
|
file.addSection({
|
||||||
headers: {
|
headers: {
|
||||||
default: new Header(),
|
default: new Header(),
|
||||||
|
@ -4,6 +4,7 @@ import * as xml from "xml";
|
|||||||
import { File } from "file";
|
import { File } from "file";
|
||||||
import { Formatter } from "../formatter";
|
import { Formatter } from "../formatter";
|
||||||
import { ImageReplacer } from "./image-replacer";
|
import { ImageReplacer } from "./image-replacer";
|
||||||
|
import { NumberingReplacer } from "./numbering-replacer";
|
||||||
|
|
||||||
interface IXmlifyedFile {
|
interface IXmlifyedFile {
|
||||||
readonly data: string;
|
readonly data: string;
|
||||||
@ -30,10 +31,12 @@ interface IXmlifyedFileMapping {
|
|||||||
export class Compiler {
|
export class Compiler {
|
||||||
private readonly formatter: Formatter;
|
private readonly formatter: Formatter;
|
||||||
private readonly imageReplacer: ImageReplacer;
|
private readonly imageReplacer: ImageReplacer;
|
||||||
|
private readonly numberingReplacer: NumberingReplacer;
|
||||||
|
|
||||||
constructor() {
|
constructor() {
|
||||||
this.formatter = new Formatter();
|
this.formatter = new Formatter();
|
||||||
this.imageReplacer = new ImageReplacer();
|
this.imageReplacer = new ImageReplacer();
|
||||||
|
this.numberingReplacer = new NumberingReplacer();
|
||||||
}
|
}
|
||||||
|
|
||||||
public compile(file: File, prettifyXml?: boolean): JSZip {
|
public compile(file: File, prettifyXml?: boolean): JSZip {
|
||||||
@ -68,7 +71,7 @@ export class Compiler {
|
|||||||
file.verifyUpdateFields();
|
file.verifyUpdateFields();
|
||||||
const documentRelationshipCount = file.DocumentRelationships.RelationshipCount + 1;
|
const documentRelationshipCount = file.DocumentRelationships.RelationshipCount + 1;
|
||||||
|
|
||||||
const documentXmlData = xml(this.formatter.format(file.Document), prettify);
|
const documentXmlData = xml(this.formatter.format(file.Document, file), prettify);
|
||||||
const documentMediaDatas = this.imageReplacer.getMediaData(documentXmlData, file.Media);
|
const documentMediaDatas = this.imageReplacer.getMediaData(documentXmlData, file.Media);
|
||||||
|
|
||||||
return {
|
return {
|
||||||
@ -82,24 +85,25 @@ export class Compiler {
|
|||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
return xml(this.formatter.format(file.DocumentRelationships), prettify);
|
return xml(this.formatter.format(file.DocumentRelationships, file), prettify);
|
||||||
})(),
|
})(),
|
||||||
path: "word/_rels/document.xml.rels",
|
path: "word/_rels/document.xml.rels",
|
||||||
},
|
},
|
||||||
Document: {
|
Document: {
|
||||||
data: (() => {
|
data: (() => {
|
||||||
const xmlData = this.imageReplacer.replace(documentXmlData, documentMediaDatas, documentRelationshipCount);
|
const xmlData = this.imageReplacer.replace(documentXmlData, documentMediaDatas, documentRelationshipCount);
|
||||||
|
const referenedXmlData = this.numberingReplacer.replace(xmlData, file.Numbering.ConcreteNumbering);
|
||||||
|
|
||||||
return xmlData;
|
return referenedXmlData;
|
||||||
})(),
|
})(),
|
||||||
path: "word/document.xml",
|
path: "word/document.xml",
|
||||||
},
|
},
|
||||||
Styles: {
|
Styles: {
|
||||||
data: xml(this.formatter.format(file.Styles), prettify),
|
data: xml(this.formatter.format(file.Styles, file), prettify),
|
||||||
path: "word/styles.xml",
|
path: "word/styles.xml",
|
||||||
},
|
},
|
||||||
Properties: {
|
Properties: {
|
||||||
data: xml(this.formatter.format(file.CoreProperties), {
|
data: xml(this.formatter.format(file.CoreProperties, file), {
|
||||||
declaration: {
|
declaration: {
|
||||||
standalone: "yes",
|
standalone: "yes",
|
||||||
encoding: "UTF-8",
|
encoding: "UTF-8",
|
||||||
@ -108,15 +112,15 @@ export class Compiler {
|
|||||||
path: "docProps/core.xml",
|
path: "docProps/core.xml",
|
||||||
},
|
},
|
||||||
Numbering: {
|
Numbering: {
|
||||||
data: xml(this.formatter.format(file.Numbering), prettify),
|
data: xml(this.formatter.format(file.Numbering, file), prettify),
|
||||||
path: "word/numbering.xml",
|
path: "word/numbering.xml",
|
||||||
},
|
},
|
||||||
FileRelationships: {
|
FileRelationships: {
|
||||||
data: xml(this.formatter.format(file.FileRelationships), prettify),
|
data: xml(this.formatter.format(file.FileRelationships, file), prettify),
|
||||||
path: "_rels/.rels",
|
path: "_rels/.rels",
|
||||||
},
|
},
|
||||||
HeaderRelationships: file.Headers.map((headerWrapper, index) => {
|
HeaderRelationships: file.Headers.map((headerWrapper, index) => {
|
||||||
const xmlData = xml(this.formatter.format(headerWrapper.Header), prettify);
|
const xmlData = xml(this.formatter.format(headerWrapper.Header, file), prettify);
|
||||||
const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media);
|
const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media);
|
||||||
|
|
||||||
mediaDatas.forEach((mediaData, i) => {
|
mediaDatas.forEach((mediaData, i) => {
|
||||||
@ -128,12 +132,12 @@ export class Compiler {
|
|||||||
});
|
});
|
||||||
|
|
||||||
return {
|
return {
|
||||||
data: xml(this.formatter.format(headerWrapper.Relationships), prettify),
|
data: xml(this.formatter.format(headerWrapper.Relationships, file), prettify),
|
||||||
path: `word/_rels/header${index + 1}.xml.rels`,
|
path: `word/_rels/header${index + 1}.xml.rels`,
|
||||||
};
|
};
|
||||||
}),
|
}),
|
||||||
FooterRelationships: file.Footers.map((footerWrapper, index) => {
|
FooterRelationships: file.Footers.map((footerWrapper, index) => {
|
||||||
const xmlData = xml(this.formatter.format(footerWrapper.Footer), prettify);
|
const xmlData = xml(this.formatter.format(footerWrapper.Footer, file), prettify);
|
||||||
const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media);
|
const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media);
|
||||||
|
|
||||||
mediaDatas.forEach((mediaData, i) => {
|
mediaDatas.forEach((mediaData, i) => {
|
||||||
@ -145,12 +149,12 @@ export class Compiler {
|
|||||||
});
|
});
|
||||||
|
|
||||||
return {
|
return {
|
||||||
data: xml(this.formatter.format(footerWrapper.Relationships), prettify),
|
data: xml(this.formatter.format(footerWrapper.Relationships, file), prettify),
|
||||||
path: `word/_rels/footer${index + 1}.xml.rels`,
|
path: `word/_rels/footer${index + 1}.xml.rels`,
|
||||||
};
|
};
|
||||||
}),
|
}),
|
||||||
Headers: file.Headers.map((headerWrapper, index) => {
|
Headers: file.Headers.map((headerWrapper, index) => {
|
||||||
const tempXmlData = xml(this.formatter.format(headerWrapper.Header), prettify);
|
const tempXmlData = xml(this.formatter.format(headerWrapper.Header, file), prettify);
|
||||||
const mediaDatas = this.imageReplacer.getMediaData(tempXmlData, file.Media);
|
const mediaDatas = this.imageReplacer.getMediaData(tempXmlData, file.Media);
|
||||||
// TODO: 0 needs to be changed when headers get relationships of their own
|
// TODO: 0 needs to be changed when headers get relationships of their own
|
||||||
const xmlData = this.imageReplacer.replace(tempXmlData, mediaDatas, 0);
|
const xmlData = this.imageReplacer.replace(tempXmlData, mediaDatas, 0);
|
||||||
@ -161,7 +165,7 @@ export class Compiler {
|
|||||||
};
|
};
|
||||||
}),
|
}),
|
||||||
Footers: file.Footers.map((footerWrapper, index) => {
|
Footers: file.Footers.map((footerWrapper, index) => {
|
||||||
const tempXmlData = xml(this.formatter.format(footerWrapper.Footer), prettify);
|
const tempXmlData = xml(this.formatter.format(footerWrapper.Footer, file), prettify);
|
||||||
const mediaDatas = this.imageReplacer.getMediaData(tempXmlData, file.Media);
|
const mediaDatas = this.imageReplacer.getMediaData(tempXmlData, file.Media);
|
||||||
// TODO: 0 needs to be changed when headers get relationships of their own
|
// TODO: 0 needs to be changed when headers get relationships of their own
|
||||||
const xmlData = this.imageReplacer.replace(tempXmlData, mediaDatas, 0);
|
const xmlData = this.imageReplacer.replace(tempXmlData, mediaDatas, 0);
|
||||||
@ -172,19 +176,19 @@ export class Compiler {
|
|||||||
};
|
};
|
||||||
}),
|
}),
|
||||||
ContentTypes: {
|
ContentTypes: {
|
||||||
data: xml(this.formatter.format(file.ContentTypes), prettify),
|
data: xml(this.formatter.format(file.ContentTypes, file), prettify),
|
||||||
path: "[Content_Types].xml",
|
path: "[Content_Types].xml",
|
||||||
},
|
},
|
||||||
AppProperties: {
|
AppProperties: {
|
||||||
data: xml(this.formatter.format(file.AppProperties), prettify),
|
data: xml(this.formatter.format(file.AppProperties, file), prettify),
|
||||||
path: "docProps/app.xml",
|
path: "docProps/app.xml",
|
||||||
},
|
},
|
||||||
FootNotes: {
|
FootNotes: {
|
||||||
data: xml(this.formatter.format(file.FootNotes), prettify),
|
data: xml(this.formatter.format(file.FootNotes, file), prettify),
|
||||||
path: "word/footnotes.xml",
|
path: "word/footnotes.xml",
|
||||||
},
|
},
|
||||||
Settings: {
|
Settings: {
|
||||||
data: xml(this.formatter.format(file.Settings), prettify),
|
data: xml(this.formatter.format(file.Settings, file), prettify),
|
||||||
path: "word/settings.xml",
|
path: "word/settings.xml",
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
17
src/export/packer/numbering-replacer.ts
Normal file
17
src/export/packer/numbering-replacer.ts
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
import { ConcreteNumbering } from "file";
|
||||||
|
|
||||||
|
export class NumberingReplacer {
|
||||||
|
public replace(xmlData: string, concreteNumberings: ConcreteNumbering[]): string {
|
||||||
|
let currentXmlData = xmlData;
|
||||||
|
|
||||||
|
for (const concreteNumbering of concreteNumberings) {
|
||||||
|
if (!concreteNumbering.reference) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
currentXmlData = currentXmlData.replace(new RegExp(`{${concreteNumbering.reference}}`, "g"), concreteNumbering.id.toString());
|
||||||
|
}
|
||||||
|
|
||||||
|
return currentXmlData;
|
||||||
|
}
|
||||||
|
}
|
@ -36,7 +36,7 @@ describe("Packer", () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
describe("#toBuffer()", () => {
|
describe("#toBuffer()", () => {
|
||||||
it("should create a standard docx file", async function() {
|
it("should create a standard docx file", async function () {
|
||||||
this.timeout(99999999);
|
this.timeout(99999999);
|
||||||
const buffer = await Packer.toBuffer(file);
|
const buffer = await Packer.toBuffer(file);
|
||||||
|
|
||||||
@ -61,7 +61,7 @@ describe("Packer", () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
describe("#toBase64String()", () => {
|
describe("#toBase64String()", () => {
|
||||||
it("should create a standard docx file", async function() {
|
it("should create a standard docx file", async function () {
|
||||||
this.timeout(99999999);
|
this.timeout(99999999);
|
||||||
const str = await Packer.toBase64String(file);
|
const str = await Packer.toBase64String(file);
|
||||||
|
|
||||||
|
@ -1,7 +1,23 @@
|
|||||||
import { XmlComponent } from "file/xml-components";
|
import { XmlComponent } from "file/xml-components";
|
||||||
|
import { IDocumentBackgroundOptions } from "../document";
|
||||||
|
|
||||||
import { DocumentAttributes } from "../document/document-attributes";
|
import { DocumentAttributes } from "../document/document-attributes";
|
||||||
|
import { INumberingOptions } from "../numbering";
|
||||||
|
import { HyperlinkType, Paragraph } from "../paragraph";
|
||||||
|
import { IStylesOptions } from "../styles";
|
||||||
import { Created, Creator, Description, Keywords, LastModifiedBy, Modified, Revision, Subject, Title } from "./components";
|
import { Created, Creator, Description, Keywords, LastModifiedBy, Modified, Revision, Subject, Title } from "./components";
|
||||||
|
|
||||||
|
export interface IInternalHyperlinkDefinition {
|
||||||
|
readonly text: string;
|
||||||
|
readonly type: HyperlinkType.INTERNAL;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IExternalHyperlinkDefinition {
|
||||||
|
readonly link: string;
|
||||||
|
readonly text: string;
|
||||||
|
readonly type: HyperlinkType.EXTERNAL;
|
||||||
|
}
|
||||||
|
|
||||||
export interface IPropertiesOptions {
|
export interface IPropertiesOptions {
|
||||||
readonly title?: string;
|
readonly title?: string;
|
||||||
readonly subject?: string;
|
readonly subject?: string;
|
||||||
@ -11,6 +27,16 @@ export interface IPropertiesOptions {
|
|||||||
readonly lastModifiedBy?: string;
|
readonly lastModifiedBy?: string;
|
||||||
readonly revision?: string;
|
readonly revision?: string;
|
||||||
readonly externalStyles?: string;
|
readonly externalStyles?: string;
|
||||||
|
readonly styles?: IStylesOptions;
|
||||||
|
readonly numbering?: INumberingOptions;
|
||||||
|
readonly footnotes?: Paragraph[];
|
||||||
|
readonly hyperlinks?: {
|
||||||
|
readonly [key: string]: IInternalHyperlinkDefinition | IExternalHyperlinkDefinition;
|
||||||
|
};
|
||||||
|
readonly background?: IDocumentBackgroundOptions;
|
||||||
|
readonly features?: {
|
||||||
|
readonly trackRevisions?: boolean;
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
export class CoreProperties extends XmlComponent {
|
export class CoreProperties extends XmlComponent {
|
||||||
|
@ -1,5 +1,6 @@
|
|||||||
import { IXmlableObject, XmlComponent } from "file/xml-components";
|
import { IXmlableObject, XmlComponent } from "file/xml-components";
|
||||||
import { TableOfContents } from "../..";
|
import { Paragraph, ParagraphProperties, TableOfContents } from "../..";
|
||||||
|
import { File } from "../../../file";
|
||||||
import { SectionProperties, SectionPropertiesOptions } from "./section-properties/section-properties";
|
import { SectionProperties, SectionPropertiesOptions } from "./section-properties/section-properties";
|
||||||
|
|
||||||
export class Body extends XmlComponent {
|
export class Body extends XmlComponent {
|
||||||
@ -18,15 +19,19 @@ export class Body extends XmlComponent {
|
|||||||
* @param options new section options
|
* @param options new section options
|
||||||
*/
|
*/
|
||||||
public addSection(options: SectionPropertiesOptions): void {
|
public addSection(options: SectionPropertiesOptions): void {
|
||||||
|
const currentSection = this.sections.pop() as SectionProperties;
|
||||||
|
this.root.push(this.createSectionParagraph(currentSection));
|
||||||
|
|
||||||
this.sections.push(new SectionProperties(options));
|
this.sections.push(new SectionProperties(options));
|
||||||
}
|
}
|
||||||
|
|
||||||
public prepForXml(): IXmlableObject | undefined {
|
public prepForXml(file?: File): IXmlableObject | undefined {
|
||||||
if (this.sections.length === 1) {
|
if (this.sections.length === 1) {
|
||||||
|
this.root.splice(0, 1);
|
||||||
this.root.push(this.sections.pop() as SectionProperties);
|
this.root.push(this.sections.pop() as SectionProperties);
|
||||||
}
|
}
|
||||||
|
|
||||||
return super.prepForXml();
|
return super.prepForXml(file);
|
||||||
}
|
}
|
||||||
|
|
||||||
public push(component: XmlComponent): void {
|
public push(component: XmlComponent): void {
|
||||||
@ -36,4 +41,12 @@ export class Body extends XmlComponent {
|
|||||||
public getTablesOfContents(): TableOfContents[] {
|
public getTablesOfContents(): TableOfContents[] {
|
||||||
return this.root.filter((child) => child instanceof TableOfContents) as TableOfContents[];
|
return this.root.filter((child) => child instanceof TableOfContents) as TableOfContents[];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private createSectionParagraph(section: SectionProperties): Paragraph {
|
||||||
|
const paragraph = new Paragraph({});
|
||||||
|
const properties = new ParagraphProperties({});
|
||||||
|
properties.push(section);
|
||||||
|
paragraph.addChildElement(properties);
|
||||||
|
return paragraph;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@ -5,3 +5,4 @@ export * from "./page-size";
|
|||||||
export * from "./page-number";
|
export * from "./page-number";
|
||||||
export * from "./page-border";
|
export * from "./page-border";
|
||||||
export * from "./line-number";
|
export * from "./line-number";
|
||||||
|
export * from "./vertical-align";
|
||||||
|
@ -14,6 +14,7 @@ export enum PageNumberFormat {
|
|||||||
ORDINAL_TEXT = "ordinalText",
|
ORDINAL_TEXT = "ordinalText",
|
||||||
UPPER_LETTER = "upperLetter",
|
UPPER_LETTER = "upperLetter",
|
||||||
UPPER_ROMAN = "upperRoman",
|
UPPER_ROMAN = "upperRoman",
|
||||||
|
DECIMAL_FULL_WIDTH = "decimalFullWidth",
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface IPageNumberTypeAttributes {
|
export interface IPageNumberTypeAttributes {
|
||||||
|
@ -8,6 +8,7 @@ import { Media } from "file/media";
|
|||||||
import { PageBorderOffsetFrom } from "./page-border";
|
import { PageBorderOffsetFrom } from "./page-border";
|
||||||
import { PageNumberFormat } from "./page-number";
|
import { PageNumberFormat } from "./page-number";
|
||||||
import { SectionProperties } from "./section-properties";
|
import { SectionProperties } from "./section-properties";
|
||||||
|
import { SectionVerticalAlignValue } from "./vertical-align";
|
||||||
|
|
||||||
describe("SectionProperties", () => {
|
describe("SectionProperties", () => {
|
||||||
describe("#constructor()", () => {
|
describe("#constructor()", () => {
|
||||||
@ -39,6 +40,7 @@ describe("SectionProperties", () => {
|
|||||||
pageNumberStart: 10,
|
pageNumberStart: 10,
|
||||||
pageNumberFormatType: PageNumberFormat.CARDINAL_TEXT,
|
pageNumberFormatType: PageNumberFormat.CARDINAL_TEXT,
|
||||||
titlePage: true,
|
titlePage: true,
|
||||||
|
verticalAlign: SectionVerticalAlignValue.TOP,
|
||||||
});
|
});
|
||||||
const tree = new Formatter().format(properties);
|
const tree = new Formatter().format(properties);
|
||||||
expect(Object.keys(tree)).to.deep.equal(["w:sectPr"]);
|
expect(Object.keys(tree)).to.deep.equal(["w:sectPr"]);
|
||||||
|
@ -18,6 +18,7 @@ import { IPageNumberTypeAttributes, PageNumberType } from "./page-number";
|
|||||||
import { PageSize } from "./page-size/page-size";
|
import { PageSize } from "./page-size/page-size";
|
||||||
import { IPageSizeAttributes, PageOrientation } from "./page-size/page-size-attributes";
|
import { IPageSizeAttributes, PageOrientation } from "./page-size/page-size-attributes";
|
||||||
import { TitlePage } from "./title-page/title-page";
|
import { TitlePage } from "./title-page/title-page";
|
||||||
|
import { ISectionVerticalAlignAttributes, SectionVerticalAlign } from "./vertical-align";
|
||||||
|
|
||||||
export interface IHeaderFooterGroup<T> {
|
export interface IHeaderFooterGroup<T> {
|
||||||
readonly default?: T;
|
readonly default?: T;
|
||||||
@ -45,7 +46,8 @@ export type SectionPropertiesOptions = IPageSizeAttributes &
|
|||||||
IPageNumberTypeAttributes &
|
IPageNumberTypeAttributes &
|
||||||
ILineNumberAttributes &
|
ILineNumberAttributes &
|
||||||
IPageBordersOptions &
|
IPageBordersOptions &
|
||||||
ITitlePageOptions & {
|
ITitlePageOptions &
|
||||||
|
ISectionVerticalAlignAttributes & {
|
||||||
readonly column?: {
|
readonly column?: {
|
||||||
readonly space?: number;
|
readonly space?: number;
|
||||||
readonly count?: number;
|
readonly count?: number;
|
||||||
@ -87,6 +89,7 @@ export class SectionProperties extends XmlComponent {
|
|||||||
pageBorderBottom,
|
pageBorderBottom,
|
||||||
pageBorderLeft,
|
pageBorderLeft,
|
||||||
titlePage = false,
|
titlePage = false,
|
||||||
|
verticalAlign,
|
||||||
} = options;
|
} = options;
|
||||||
|
|
||||||
this.options = options;
|
this.options = options;
|
||||||
@ -121,6 +124,10 @@ export class SectionProperties extends XmlComponent {
|
|||||||
if (titlePage) {
|
if (titlePage) {
|
||||||
this.root.push(new TitlePage());
|
this.root.push(new TitlePage());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (verticalAlign) {
|
||||||
|
this.root.push(new SectionVerticalAlign(verticalAlign));
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private addHeaders(headers?: IHeaderFooterGroup<HeaderWrapper>): void {
|
private addHeaders(headers?: IHeaderFooterGroup<HeaderWrapper>): void {
|
||||||
|
@ -0,0 +1,2 @@
|
|||||||
|
export * from "./vertical-align";
|
||||||
|
export * from "./vertical-align-attributes";
|
@ -0,0 +1,12 @@
|
|||||||
|
import { XmlAttributeComponent } from "file/xml-components";
|
||||||
|
import { SectionVerticalAlignValue } from "./vertical-align";
|
||||||
|
|
||||||
|
export interface ISectionVerticalAlignAttributes {
|
||||||
|
readonly verticalAlign?: SectionVerticalAlignValue;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class SectionVerticalAlignAttributes extends XmlAttributeComponent<ISectionVerticalAlignAttributes> {
|
||||||
|
protected readonly xmlKeys = {
|
||||||
|
verticalAlign: "w:val",
|
||||||
|
};
|
||||||
|
}
|
@ -0,0 +1,18 @@
|
|||||||
|
// http://officeopenxml.com/WPsection.php
|
||||||
|
|
||||||
|
import { XmlComponent } from "file/xml-components";
|
||||||
|
import { SectionVerticalAlignAttributes } from "./vertical-align-attributes";
|
||||||
|
|
||||||
|
export enum SectionVerticalAlignValue {
|
||||||
|
BOTH = "both",
|
||||||
|
BOTTOM = "bottom",
|
||||||
|
CENTER = "center",
|
||||||
|
TOP = "top",
|
||||||
|
}
|
||||||
|
|
||||||
|
export class SectionVerticalAlign extends XmlComponent {
|
||||||
|
constructor(value: SectionVerticalAlignValue) {
|
||||||
|
super("w:vAlign");
|
||||||
|
this.root.push(new SectionVerticalAlignAttributes({ verticalAlign: value }));
|
||||||
|
}
|
||||||
|
}
|
@ -0,0 +1,53 @@
|
|||||||
|
import { expect } from "chai";
|
||||||
|
|
||||||
|
import { Formatter } from "export/formatter";
|
||||||
|
|
||||||
|
import { DocumentBackground } from "./document-background";
|
||||||
|
|
||||||
|
describe("DocumentBackground", () => {
|
||||||
|
describe("#constructor()", () => {
|
||||||
|
it("should create a DocumentBackground with no options and set color to auto", () => {
|
||||||
|
const documentBackground = new DocumentBackground({});
|
||||||
|
const tree = new Formatter().format(documentBackground);
|
||||||
|
expect(tree).to.deep.equal({
|
||||||
|
"w:background": {
|
||||||
|
_attr: {
|
||||||
|
"w:color": "FFFFFF",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should create a DocumentBackground with no options and set color to value", () => {
|
||||||
|
const documentBackground = new DocumentBackground({ color: "ffff00" });
|
||||||
|
const tree = new Formatter().format(documentBackground);
|
||||||
|
expect(tree).to.deep.equal({
|
||||||
|
"w:background": {
|
||||||
|
_attr: {
|
||||||
|
"w:color": "ffff00",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should create a DocumentBackground with no options and set other values", () => {
|
||||||
|
const documentBackground = new DocumentBackground({
|
||||||
|
color: "ffff00",
|
||||||
|
themeColor: "test",
|
||||||
|
themeShade: "test",
|
||||||
|
themeTint: "test",
|
||||||
|
});
|
||||||
|
const tree = new Formatter().format(documentBackground);
|
||||||
|
expect(tree).to.deep.equal({
|
||||||
|
"w:background": {
|
||||||
|
_attr: {
|
||||||
|
"w:color": "ffff00",
|
||||||
|
"w:themeColor": "test",
|
||||||
|
"w:themeShade": "test",
|
||||||
|
"w:themeTint": "test",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
39
src/file/document/document-background/document-background.ts
Normal file
39
src/file/document/document-background/document-background.ts
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
// http://officeopenxml.com/WPdocument.php
|
||||||
|
// http://www.datypic.com/sc/ooxml/e-w_background-1.html
|
||||||
|
import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
|
||||||
|
|
||||||
|
export class DocumentBackgroundAttributes extends XmlAttributeComponent<{
|
||||||
|
readonly color: string;
|
||||||
|
readonly themeColor?: string;
|
||||||
|
readonly themeShade?: string;
|
||||||
|
readonly themeTint?: string;
|
||||||
|
}> {
|
||||||
|
protected readonly xmlKeys = {
|
||||||
|
color: "w:color",
|
||||||
|
themeColor: "w:themeColor",
|
||||||
|
themeShade: "w:themeShade",
|
||||||
|
themeTint: "w:themeTint",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IDocumentBackgroundOptions {
|
||||||
|
readonly color?: string;
|
||||||
|
readonly themeColor?: string;
|
||||||
|
readonly themeShade?: string;
|
||||||
|
readonly themeTint?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class DocumentBackground extends XmlComponent {
|
||||||
|
constructor(options: IDocumentBackgroundOptions) {
|
||||||
|
super("w:background");
|
||||||
|
|
||||||
|
this.root.push(
|
||||||
|
new DocumentBackgroundAttributes({
|
||||||
|
color: options.color ? options.color : "FFFFFF",
|
||||||
|
themeColor: options.themeColor,
|
||||||
|
themeShade: options.themeShade,
|
||||||
|
themeTint: options.themeTint,
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
1
src/file/document/document-background/index.ts
Normal file
1
src/file/document/document-background/index.ts
Normal file
@ -0,0 +1 @@
|
|||||||
|
export * from "./document-background";
|
@ -8,7 +8,7 @@ describe("Document", () => {
|
|||||||
let document: Document;
|
let document: Document;
|
||||||
|
|
||||||
beforeEach(() => {
|
beforeEach(() => {
|
||||||
document = new Document();
|
document = new Document({ background: {} });
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("#constructor()", () => {
|
describe("#constructor()", () => {
|
||||||
@ -38,6 +38,13 @@ describe("Document", () => {
|
|||||||
"mc:Ignorable": "w14 w15 wp14",
|
"mc:Ignorable": "w14 w15 wp14",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"w:background": {
|
||||||
|
_attr: {
|
||||||
|
"w:color": "FFFFFF",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
{ "w:body": {} },
|
{ "w:body": {} },
|
||||||
],
|
],
|
||||||
});
|
});
|
||||||
|
@ -1,15 +1,20 @@
|
|||||||
// http://officeopenxml.com/WPdocument.php
|
// http://officeopenxml.com/WPdocument.php
|
||||||
import { XmlComponent } from "file/xml-components";
|
import { XmlComponent } from "file/xml-components";
|
||||||
import { Paragraph } from "../paragraph";
|
import { Hyperlink, Paragraph } from "../paragraph";
|
||||||
import { Table } from "../table";
|
import { Table } from "../table";
|
||||||
import { TableOfContents } from "../table-of-contents";
|
import { TableOfContents } from "../table-of-contents";
|
||||||
import { Body } from "./body";
|
import { Body } from "./body";
|
||||||
import { DocumentAttributes } from "./document-attributes";
|
import { DocumentAttributes } from "./document-attributes";
|
||||||
|
import { DocumentBackground, IDocumentBackgroundOptions } from "./document-background";
|
||||||
|
|
||||||
|
interface IDocumentOptions {
|
||||||
|
readonly background: IDocumentBackgroundOptions;
|
||||||
|
}
|
||||||
|
|
||||||
export class Document extends XmlComponent {
|
export class Document extends XmlComponent {
|
||||||
private readonly body: Body;
|
private readonly body: Body;
|
||||||
|
|
||||||
constructor() {
|
constructor(options: IDocumentOptions) {
|
||||||
super("w:document");
|
super("w:document");
|
||||||
this.root.push(
|
this.root.push(
|
||||||
new DocumentAttributes({
|
new DocumentAttributes({
|
||||||
@ -33,10 +38,11 @@ export class Document extends XmlComponent {
|
|||||||
}),
|
}),
|
||||||
);
|
);
|
||||||
this.body = new Body();
|
this.body = new Body();
|
||||||
|
this.root.push(new DocumentBackground(options.background));
|
||||||
this.root.push(this.body);
|
this.root.push(this.body);
|
||||||
}
|
}
|
||||||
|
|
||||||
public add(item: Paragraph | Table | TableOfContents): Document {
|
public add(item: Paragraph | Table | TableOfContents | Hyperlink): Document {
|
||||||
this.body.push(item);
|
this.body.push(item);
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
export * from "./document";
|
export * from "./document";
|
||||||
export * from "./document-attributes";
|
export * from "./document-attributes";
|
||||||
export * from "./body";
|
export * from "./body";
|
||||||
|
export * from "./document-background";
|
||||||
|
@ -12,7 +12,7 @@ export class Inline extends XmlComponent {
|
|||||||
private readonly extent: Extent;
|
private readonly extent: Extent;
|
||||||
private readonly graphic: Graphic;
|
private readonly graphic: Graphic;
|
||||||
|
|
||||||
constructor(readonly mediaData: IMediaData, private readonly dimensions: IMediaDataDimensions) {
|
constructor(mediaData: IMediaData, private readonly dimensions: IMediaDataDimensions) {
|
||||||
super("wp:inline");
|
super("wp:inline");
|
||||||
|
|
||||||
this.root.push(
|
this.root.push(
|
||||||
|
@ -5,7 +5,7 @@ import { Formatter } from "export/formatter";
|
|||||||
|
|
||||||
import { File } from "./file";
|
import { File } from "./file";
|
||||||
import { Footer, Header } from "./header";
|
import { Footer, Header } from "./header";
|
||||||
import { Paragraph } from "./paragraph";
|
import { HyperlinkRef, HyperlinkType, Paragraph } from "./paragraph";
|
||||||
import { Table, TableCell, TableRow } from "./table";
|
import { Table, TableCell, TableRow } from "./table";
|
||||||
import { TableOfContents } from "./table-of-contents";
|
import { TableOfContents } from "./table-of-contents";
|
||||||
|
|
||||||
@ -89,6 +89,91 @@ describe("File", () => {
|
|||||||
expect(tree["w:body"][0]["w:sectPr"][8]["w:footerReference"]._attr["w:type"]).to.equal("first");
|
expect(tree["w:body"][0]["w:sectPr"][8]["w:footerReference"]._attr["w:type"]).to.equal("first");
|
||||||
expect(tree["w:body"][0]["w:sectPr"][9]["w:footerReference"]._attr["w:type"]).to.equal("even");
|
expect(tree["w:body"][0]["w:sectPr"][9]["w:footerReference"]._attr["w:type"]).to.equal("even");
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("should add child", () => {
|
||||||
|
const doc = new File(undefined, undefined, [
|
||||||
|
{
|
||||||
|
children: [new Paragraph("test")],
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
const tree = new Formatter().format(doc.Document.Body);
|
||||||
|
|
||||||
|
expect(tree).to.deep.equal({
|
||||||
|
"w:body": [
|
||||||
|
{
|
||||||
|
"w:p": [
|
||||||
|
{
|
||||||
|
"w:r": [
|
||||||
|
{
|
||||||
|
"w:t": [
|
||||||
|
{
|
||||||
|
_attr: {
|
||||||
|
"xml:space": "preserve",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"test",
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:sectPr": [
|
||||||
|
{
|
||||||
|
"w:pgSz": {
|
||||||
|
_attr: {
|
||||||
|
"w:h": 16838,
|
||||||
|
"w:orient": "portrait",
|
||||||
|
"w:w": 11906,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:pgMar": {
|
||||||
|
_attr: {
|
||||||
|
"w:bottom": 1440,
|
||||||
|
"w:footer": 708,
|
||||||
|
"w:gutter": 0,
|
||||||
|
"w:header": 708,
|
||||||
|
"w:left": 1440,
|
||||||
|
"w:mirrorMargins": false,
|
||||||
|
"w:right": 1440,
|
||||||
|
"w:top": 1440,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:cols": {
|
||||||
|
_attr: {
|
||||||
|
"w:num": 1,
|
||||||
|
"w:space": 708,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:docGrid": {
|
||||||
|
_attr: {
|
||||||
|
"w:linePitch": 360,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should add hyperlink child", () => {
|
||||||
|
const doc = new File(undefined, undefined, [
|
||||||
|
{
|
||||||
|
children: [new HyperlinkRef("test")],
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
expect(doc.HyperlinkCache).to.deep.equal({});
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("#addSection", () => {
|
describe("#addSection", () => {
|
||||||
@ -102,6 +187,16 @@ describe("File", () => {
|
|||||||
expect(spy.called).to.equal(true);
|
expect(spy.called).to.equal(true);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("should add hyperlink child", () => {
|
||||||
|
const doc = new File();
|
||||||
|
|
||||||
|
doc.addSection({
|
||||||
|
children: [new HyperlinkRef("test")],
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(doc.HyperlinkCache).to.deep.equal({});
|
||||||
|
});
|
||||||
|
|
||||||
it("should call the underlying document's add when adding a Table", () => {
|
it("should call the underlying document's add when adding a Table", () => {
|
||||||
const file = new File();
|
const file = new File();
|
||||||
const spy = sinon.spy(file.Document, "add");
|
const spy = sinon.spy(file.Document, "add");
|
||||||
@ -148,13 +243,224 @@ describe("File", () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("#createFootnote", () => {
|
describe("#addTrackRevisionsFeature", () => {
|
||||||
it("should call the underlying document's createFootnote", () => {
|
it("should call the underlying document's add", () => {
|
||||||
const wrapper = new File();
|
const file = new File({
|
||||||
const spy = sinon.spy(wrapper.FootNotes, "createFootNote");
|
features: {
|
||||||
wrapper.createFootnote(new Paragraph(""));
|
trackRevisions: true,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
expect(spy.called).to.equal(true);
|
// tslint:disable-next-line: no-unused-expression no-string-literal
|
||||||
|
expect(file.Settings["trackRevisions"]).to.exist;
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("#HyperlinkCache", () => {
|
||||||
|
it("should initially have empty hyperlink cache", () => {
|
||||||
|
const file = new File();
|
||||||
|
|
||||||
|
expect(file.HyperlinkCache).to.deep.equal({});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should have hyperlink cache when option is added", () => {
|
||||||
|
const file = new File({
|
||||||
|
hyperlinks: {
|
||||||
|
myCoolLink: {
|
||||||
|
link: "http://www.example.com",
|
||||||
|
text: "Hyperlink",
|
||||||
|
type: HyperlinkType.EXTERNAL,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// tslint:disable-next-line: no-unused-expression no-string-literal
|
||||||
|
expect(file.HyperlinkCache["myCoolLink"]).to.exist;
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("#createFootnote", () => {
|
||||||
|
it("should create footnote", () => {
|
||||||
|
const wrapper = new File({
|
||||||
|
footnotes: [new Paragraph("hello")],
|
||||||
|
});
|
||||||
|
|
||||||
|
const tree = new Formatter().format(wrapper.FootNotes);
|
||||||
|
|
||||||
|
expect(tree).to.deep.equal({
|
||||||
|
"w:footnotes": [
|
||||||
|
{
|
||||||
|
_attr: {
|
||||||
|
"mc:Ignorable": "w14 w15 wp14",
|
||||||
|
"xmlns:m": "http://schemas.openxmlformats.org/officeDocument/2006/math",
|
||||||
|
"xmlns:mc": "http://schemas.openxmlformats.org/markup-compatibility/2006",
|
||||||
|
"xmlns:o": "urn:schemas-microsoft-com:office:office",
|
||||||
|
"xmlns:r": "http://schemas.openxmlformats.org/officeDocument/2006/relationships",
|
||||||
|
"xmlns:v": "urn:schemas-microsoft-com:vml",
|
||||||
|
"xmlns:w": "http://schemas.openxmlformats.org/wordprocessingml/2006/main",
|
||||||
|
"xmlns:w10": "urn:schemas-microsoft-com:office:word",
|
||||||
|
"xmlns:w14": "http://schemas.microsoft.com/office/word/2010/wordml",
|
||||||
|
"xmlns:w15": "http://schemas.microsoft.com/office/word/2012/wordml",
|
||||||
|
"xmlns:wne": "http://schemas.microsoft.com/office/word/2006/wordml",
|
||||||
|
"xmlns:wp": "http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing",
|
||||||
|
"xmlns:wp14": "http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing",
|
||||||
|
"xmlns:wpc": "http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas",
|
||||||
|
"xmlns:wpg": "http://schemas.microsoft.com/office/word/2010/wordprocessingGroup",
|
||||||
|
"xmlns:wpi": "http://schemas.microsoft.com/office/word/2010/wordprocessingInk",
|
||||||
|
"xmlns:wps": "http://schemas.microsoft.com/office/word/2010/wordprocessingShape",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:footnote": [
|
||||||
|
{
|
||||||
|
_attr: {
|
||||||
|
"w:id": -1,
|
||||||
|
"w:type": "separator",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:p": [
|
||||||
|
{
|
||||||
|
"w:pPr": [
|
||||||
|
{
|
||||||
|
"w:spacing": {
|
||||||
|
_attr: {
|
||||||
|
"w:after": 0,
|
||||||
|
"w:line": 240,
|
||||||
|
"w:lineRule": "auto",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:r": [
|
||||||
|
{
|
||||||
|
"w:rPr": [
|
||||||
|
{
|
||||||
|
"w:rStyle": {
|
||||||
|
_attr: {
|
||||||
|
"w:val": "FootnoteReference",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:footnoteRef": {},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:r": [
|
||||||
|
{
|
||||||
|
"w:separator": {},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:footnote": [
|
||||||
|
{
|
||||||
|
_attr: {
|
||||||
|
"w:id": 0,
|
||||||
|
"w:type": "continuationSeparator",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:p": [
|
||||||
|
{
|
||||||
|
"w:pPr": [
|
||||||
|
{
|
||||||
|
"w:spacing": {
|
||||||
|
_attr: {
|
||||||
|
"w:after": 0,
|
||||||
|
"w:line": 240,
|
||||||
|
"w:lineRule": "auto",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:r": [
|
||||||
|
{
|
||||||
|
"w:rPr": [
|
||||||
|
{
|
||||||
|
"w:rStyle": {
|
||||||
|
_attr: {
|
||||||
|
"w:val": "FootnoteReference",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:footnoteRef": {},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:r": [
|
||||||
|
{
|
||||||
|
"w:continuationSeparator": {},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:footnote": [
|
||||||
|
{
|
||||||
|
_attr: {
|
||||||
|
"w:id": 1,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:p": [
|
||||||
|
{
|
||||||
|
"w:r": [
|
||||||
|
{
|
||||||
|
"w:rPr": [
|
||||||
|
{
|
||||||
|
"w:rStyle": {
|
||||||
|
_attr: {
|
||||||
|
"w:val": "FootnoteReference",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:footnoteRef": {},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:r": [
|
||||||
|
{
|
||||||
|
"w:t": [
|
||||||
|
{
|
||||||
|
_attr: {
|
||||||
|
"xml:space": "preserve",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"hello",
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
121
src/file/file.ts
121
src/file/file.ts
@ -1,3 +1,4 @@
|
|||||||
|
import * as shortid from "shortid";
|
||||||
import { AppProperties } from "./app-properties/app-properties";
|
import { AppProperties } from "./app-properties/app-properties";
|
||||||
import { ContentTypes } from "./content-types/content-types";
|
import { ContentTypes } from "./content-types/content-types";
|
||||||
import { CoreProperties, IPropertiesOptions } from "./core-properties";
|
import { CoreProperties, IPropertiesOptions } from "./core-properties";
|
||||||
@ -16,7 +17,7 @@ import { Footer, Header } from "./header";
|
|||||||
import { HeaderWrapper, IDocumentHeader } from "./header-wrapper";
|
import { HeaderWrapper, IDocumentHeader } from "./header-wrapper";
|
||||||
import { Media } from "./media";
|
import { Media } from "./media";
|
||||||
import { Numbering } from "./numbering";
|
import { Numbering } from "./numbering";
|
||||||
import { Bookmark, Hyperlink, Paragraph } from "./paragraph";
|
import { Hyperlink, HyperlinkRef, HyperlinkType, Paragraph } from "./paragraph";
|
||||||
import { Relationships } from "./relationships";
|
import { Relationships } from "./relationships";
|
||||||
import { TargetModeType } from "./relationships/relationship/relationship";
|
import { TargetModeType } from "./relationships/relationship/relationship";
|
||||||
import { Settings } from "./settings";
|
import { Settings } from "./settings";
|
||||||
@ -40,14 +41,12 @@ export interface ISectionOptions {
|
|||||||
readonly size?: IPageSizeAttributes;
|
readonly size?: IPageSizeAttributes;
|
||||||
readonly margins?: IPageMarginAttributes;
|
readonly margins?: IPageMarginAttributes;
|
||||||
readonly properties?: SectionPropertiesOptions;
|
readonly properties?: SectionPropertiesOptions;
|
||||||
readonly children: Array<Paragraph | Table | TableOfContents>;
|
readonly children: (Paragraph | Table | TableOfContents | HyperlinkRef)[];
|
||||||
}
|
}
|
||||||
|
|
||||||
export class File {
|
export class File {
|
||||||
// tslint:disable-next-line:readonly-keyword
|
// tslint:disable-next-line:readonly-keyword
|
||||||
private currentRelationshipId: number = 1;
|
private currentRelationshipId: number = 1;
|
||||||
// tslint:disable-next-line:readonly-keyword
|
|
||||||
private styles: Styles;
|
|
||||||
|
|
||||||
private readonly document: Document;
|
private readonly document: Document;
|
||||||
private readonly headers: IDocumentHeader[] = [];
|
private readonly headers: IDocumentHeader[] = [];
|
||||||
@ -61,6 +60,8 @@ export class File {
|
|||||||
private readonly settings: Settings;
|
private readonly settings: Settings;
|
||||||
private readonly contentTypes: ContentTypes;
|
private readonly contentTypes: ContentTypes;
|
||||||
private readonly appProperties: AppProperties;
|
private readonly appProperties: AppProperties;
|
||||||
|
private readonly styles: Styles;
|
||||||
|
private readonly hyperlinkCache: { readonly [key: string]: Hyperlink } = {};
|
||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
options: IPropertiesOptions = {
|
options: IPropertiesOptions = {
|
||||||
@ -72,13 +73,19 @@ export class File {
|
|||||||
sections: ISectionOptions[] = [],
|
sections: ISectionOptions[] = [],
|
||||||
) {
|
) {
|
||||||
this.coreProperties = new CoreProperties(options);
|
this.coreProperties = new CoreProperties(options);
|
||||||
this.numbering = new Numbering();
|
this.numbering = new Numbering(
|
||||||
|
options.numbering
|
||||||
|
? options.numbering
|
||||||
|
: {
|
||||||
|
config: [],
|
||||||
|
},
|
||||||
|
);
|
||||||
this.docRelationships = new Relationships();
|
this.docRelationships = new Relationships();
|
||||||
this.fileRelationships = new Relationships();
|
this.fileRelationships = new Relationships();
|
||||||
this.appProperties = new AppProperties();
|
this.appProperties = new AppProperties();
|
||||||
this.footNotes = new FootNotes();
|
this.footNotes = new FootNotes();
|
||||||
this.contentTypes = new ContentTypes();
|
this.contentTypes = new ContentTypes();
|
||||||
this.document = new Document();
|
this.document = new Document({ background: options.background || {} });
|
||||||
this.settings = new Settings();
|
this.settings = new Settings();
|
||||||
|
|
||||||
this.media = fileProperties.template && fileProperties.template.media ? fileProperties.template.media : new Media();
|
this.media = fileProperties.template && fileProperties.template.media ? fileProperties.template.media : new Media();
|
||||||
@ -97,9 +104,16 @@ export class File {
|
|||||||
} else if (options.externalStyles) {
|
} else if (options.externalStyles) {
|
||||||
const stylesFactory = new ExternalStylesFactory();
|
const stylesFactory = new ExternalStylesFactory();
|
||||||
this.styles = stylesFactory.newInstance(options.externalStyles);
|
this.styles = stylesFactory.newInstance(options.externalStyles);
|
||||||
|
} else if (options.styles) {
|
||||||
|
const stylesFactory = new DefaultStylesFactory();
|
||||||
|
const defaultStyles = stylesFactory.newInstance();
|
||||||
|
this.styles = new Styles({
|
||||||
|
...defaultStyles,
|
||||||
|
...options.styles,
|
||||||
|
});
|
||||||
} else {
|
} else {
|
||||||
const stylesFactory = new DefaultStylesFactory();
|
const stylesFactory = new DefaultStylesFactory();
|
||||||
this.styles = stylesFactory.newInstance();
|
this.styles = new Styles(stylesFactory.newInstance());
|
||||||
}
|
}
|
||||||
|
|
||||||
this.addDefaultRelationships();
|
this.addDefaultRelationships();
|
||||||
@ -120,33 +134,48 @@ export class File {
|
|||||||
this.document.Body.addSection(section.properties ? section.properties : {});
|
this.document.Body.addSection(section.properties ? section.properties : {});
|
||||||
|
|
||||||
for (const child of section.children) {
|
for (const child of section.children) {
|
||||||
|
if (child instanceof HyperlinkRef) {
|
||||||
|
const hyperlink = this.hyperlinkCache[child.id];
|
||||||
|
this.document.add(hyperlink);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
this.document.add(child);
|
this.document.add(child);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
public createHyperlink(link: string, text?: string): Hyperlink {
|
if (options.footnotes) {
|
||||||
const newText = text === undefined ? link : text;
|
for (const paragraph of options.footnotes) {
|
||||||
const hyperlink = new Hyperlink(newText, this.docRelationships.RelationshipCount);
|
this.footNotes.createFootNote(paragraph);
|
||||||
this.docRelationships.createRelationship(
|
}
|
||||||
hyperlink.linkId,
|
}
|
||||||
"http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink",
|
|
||||||
link,
|
|
||||||
TargetModeType.EXTERNAL,
|
|
||||||
);
|
|
||||||
return hyperlink;
|
|
||||||
}
|
|
||||||
|
|
||||||
public createInternalHyperLink(anchor: string, text?: string): Hyperlink {
|
if (options.hyperlinks) {
|
||||||
const newText = text === undefined ? anchor : text;
|
const cache = {};
|
||||||
const hyperlink = new Hyperlink(newText, this.docRelationships.RelationshipCount, anchor);
|
|
||||||
// NOTE: unlike File#createHyperlink(), since the link is to an internal bookmark
|
|
||||||
// we don't need to create a new relationship.
|
|
||||||
return hyperlink;
|
|
||||||
}
|
|
||||||
|
|
||||||
public createBookmark(name: string, text: string = name): Bookmark {
|
for (const key in options.hyperlinks) {
|
||||||
return new Bookmark(name, text, this.docRelationships.RelationshipCount);
|
if (!options.hyperlinks[key]) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
const hyperlinkRef = options.hyperlinks[key];
|
||||||
|
|
||||||
|
const hyperlink =
|
||||||
|
hyperlinkRef.type === HyperlinkType.EXTERNAL
|
||||||
|
? this.createHyperlink(hyperlinkRef.link, hyperlinkRef.text)
|
||||||
|
: this.createInternalHyperLink(key, hyperlinkRef.text);
|
||||||
|
|
||||||
|
cache[key] = hyperlink;
|
||||||
|
}
|
||||||
|
|
||||||
|
this.hyperlinkCache = cache;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (options.features) {
|
||||||
|
if (options.features.trackRevisions) {
|
||||||
|
this.settings.addTrackRevisions();
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public addSection({
|
public addSection({
|
||||||
@ -174,20 +203,40 @@ export class File {
|
|||||||
});
|
});
|
||||||
|
|
||||||
for (const child of children) {
|
for (const child of children) {
|
||||||
|
if (child instanceof HyperlinkRef) {
|
||||||
|
const hyperlink = this.hyperlinkCache[child.id];
|
||||||
|
this.document.add(hyperlink);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
this.document.add(child);
|
this.document.add(child);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public createFootnote(paragraph: Paragraph): void {
|
|
||||||
this.footNotes.createFootNote(paragraph);
|
|
||||||
}
|
|
||||||
|
|
||||||
public verifyUpdateFields(): void {
|
public verifyUpdateFields(): void {
|
||||||
if (this.document.getTablesOfContents().length) {
|
if (this.document.getTablesOfContents().length) {
|
||||||
this.settings.addUpdateFields();
|
this.settings.addUpdateFields();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private createHyperlink(link: string, text: string = link): Hyperlink {
|
||||||
|
const hyperlink = new Hyperlink(text, shortid.generate().toLowerCase());
|
||||||
|
this.docRelationships.createRelationship(
|
||||||
|
hyperlink.linkId,
|
||||||
|
"http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink",
|
||||||
|
link,
|
||||||
|
TargetModeType.EXTERNAL,
|
||||||
|
);
|
||||||
|
return hyperlink;
|
||||||
|
}
|
||||||
|
|
||||||
|
private createInternalHyperLink(anchor: string, text: string = anchor): Hyperlink {
|
||||||
|
const hyperlink = new Hyperlink(text, shortid.generate().toLowerCase(), anchor);
|
||||||
|
// NOTE: unlike File#createHyperlink(), since the link is to an internal bookmark
|
||||||
|
// we don't need to create a new relationship.
|
||||||
|
return hyperlink;
|
||||||
|
}
|
||||||
|
|
||||||
private createHeader(header: Header): HeaderWrapper {
|
private createHeader(header: Header): HeaderWrapper {
|
||||||
const wrapper = new HeaderWrapper(this.media, this.currentRelationshipId++);
|
const wrapper = new HeaderWrapper(this.media, this.currentRelationshipId++);
|
||||||
|
|
||||||
@ -277,10 +326,6 @@ export class File {
|
|||||||
return this.styles;
|
return this.styles;
|
||||||
}
|
}
|
||||||
|
|
||||||
public set Styles(styles: Styles) {
|
|
||||||
this.styles = styles;
|
|
||||||
}
|
|
||||||
|
|
||||||
public get CoreProperties(): CoreProperties {
|
public get CoreProperties(): CoreProperties {
|
||||||
return this.coreProperties;
|
return this.coreProperties;
|
||||||
}
|
}
|
||||||
@ -324,4 +369,8 @@ export class File {
|
|||||||
public get Settings(): Settings {
|
public get Settings(): Settings {
|
||||||
return this.settings;
|
return this.settings;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public get HyperlinkCache(): { readonly [key: string]: Hyperlink } {
|
||||||
|
return this.hyperlinkCache;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
1
src/file/footnotes/footnote/index.ts
Normal file
1
src/file/footnotes/footnote/index.ts
Normal file
@ -0,0 +1 @@
|
|||||||
|
export * from "./run";
|
1
src/file/footnotes/footnote/run/index.ts
Normal file
1
src/file/footnotes/footnote/run/index.ts
Normal file
@ -0,0 +1 @@
|
|||||||
|
export * from "./reference-run";
|
@ -44,7 +44,8 @@ export class FootNotes extends XmlComponent {
|
|||||||
line: 240,
|
line: 240,
|
||||||
lineRule: "auto",
|
lineRule: "auto",
|
||||||
},
|
},
|
||||||
}).addRun(new SeperatorRun()),
|
children: [new SeperatorRun()],
|
||||||
|
}),
|
||||||
);
|
);
|
||||||
this.root.push(begin);
|
this.root.push(begin);
|
||||||
|
|
||||||
@ -56,7 +57,8 @@ export class FootNotes extends XmlComponent {
|
|||||||
line: 240,
|
line: 240,
|
||||||
lineRule: "auto",
|
lineRule: "auto",
|
||||||
},
|
},
|
||||||
}).addRun(new ContinuationSeperatorRun()),
|
children: [new ContinuationSeperatorRun()],
|
||||||
|
}),
|
||||||
);
|
);
|
||||||
this.root.push(spacing);
|
this.root.push(spacing);
|
||||||
}
|
}
|
||||||
|
@ -1 +1,2 @@
|
|||||||
export * from "./footnotes";
|
export * from "./footnotes";
|
||||||
|
export * from "./footnote";
|
||||||
|
@ -2,7 +2,7 @@ import { Paragraph } from "./paragraph";
|
|||||||
import { Table } from "./table";
|
import { Table } from "./table";
|
||||||
|
|
||||||
export interface IHeaderOptions {
|
export interface IHeaderOptions {
|
||||||
readonly children: Array<Paragraph | Table>;
|
readonly children: (Paragraph | Table)[];
|
||||||
}
|
}
|
||||||
|
|
||||||
export class Header {
|
export class Header {
|
||||||
|
@ -12,3 +12,5 @@ export * from "./xml-components";
|
|||||||
export * from "./header-wrapper";
|
export * from "./header-wrapper";
|
||||||
export * from "./footer-wrapper";
|
export * from "./footer-wrapper";
|
||||||
export * from "./header";
|
export * from "./header";
|
||||||
|
export * from "./footnotes";
|
||||||
|
export * from "./track-revision";
|
||||||
|
@ -21,14 +21,7 @@ export class Media {
|
|||||||
|
|
||||||
private static generateId(): string {
|
private static generateId(): string {
|
||||||
// https://gist.github.com/6174/6062387
|
// https://gist.github.com/6174/6062387
|
||||||
return (
|
return Math.random().toString(36).substring(2, 15) + Math.random().toString(36).substring(2, 15);
|
||||||
Math.random()
|
|
||||||
.toString(36)
|
|
||||||
.substring(2, 15) +
|
|
||||||
Math.random()
|
|
||||||
.toString(36)
|
|
||||||
.substring(2, 15)
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
private readonly map: Map<string, IMediaData>;
|
private readonly map: Map<string, IMediaData>;
|
||||||
|
823
src/file/numbering/abstract-numbering.spec.ts
Normal file
823
src/file/numbering/abstract-numbering.spec.ts
Normal file
@ -0,0 +1,823 @@
|
|||||||
|
import { expect } from "chai";
|
||||||
|
|
||||||
|
import { Formatter } from "export/formatter";
|
||||||
|
import { EMPTY_OBJECT } from "file/xml-components";
|
||||||
|
|
||||||
|
import { AlignmentType, EmphasisMarkType, TabStopPosition } from "../paragraph";
|
||||||
|
import { UnderlineType } from "../paragraph/run/underline";
|
||||||
|
import { ShadingType } from "../table";
|
||||||
|
import { AbstractNumbering } from "./abstract-numbering";
|
||||||
|
import { LevelSuffix } from "./level";
|
||||||
|
|
||||||
|
describe("AbstractNumbering", () => {
|
||||||
|
it("stores its ID at its .id property", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(5, []);
|
||||||
|
expect(abstractNumbering.id).to.equal(5);
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("#createLevel", () => {
|
||||||
|
it("creates a level with the given characteristics", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 3,
|
||||||
|
format: "lowerLetter",
|
||||||
|
text: "%1)",
|
||||||
|
alignment: AlignmentType.END,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({ _attr: { "w:ilvl": 3, "w15:tentative": 1 } });
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({ "w:start": { _attr: { "w:val": 1 } } });
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({ "w:lvlJc": { _attr: { "w:val": "end" } } });
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({ "w:numFmt": { _attr: { "w:val": "lowerLetter" } } });
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({ "w:lvlText": { _attr: { "w:val": "%1)" } } });
|
||||||
|
});
|
||||||
|
|
||||||
|
it("uses 'start' as the default alignment", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 3,
|
||||||
|
format: "lowerLetter",
|
||||||
|
text: "%1)",
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({ _attr: { "w:ilvl": 3, "w15:tentative": 1 } });
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({ "w:start": { _attr: { "w:val": 1 } } });
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({ "w:lvlJc": { _attr: { "w:val": "start" } } });
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({ "w:numFmt": { _attr: { "w:val": "lowerLetter" } } });
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({ "w:lvlText": { _attr: { "w:val": "%1)" } } });
|
||||||
|
});
|
||||||
|
|
||||||
|
it("has suffix", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 3,
|
||||||
|
format: "lowerLetter",
|
||||||
|
text: "%1)",
|
||||||
|
alignment: AlignmentType.END,
|
||||||
|
suffix: LevelSuffix.SPACE,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({ "w:suff": { _attr: { "w:val": "space" } } });
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("formatting methods: paragraph properties", () => {
|
||||||
|
it("#indent", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
indent: { left: 720 },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:pPr": [{ "w:ind": { _attr: { "w:left": 720 } } }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("#spacing", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
spacing: { before: 50, after: 150 },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:pPr": [{ "w:spacing": { _attr: { "w:before": 50, "w:after": 150 } } }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("#center", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
alignment: AlignmentType.CENTER,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:pPr": [{ "w:jc": { _attr: { "w:val": "center" } } }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("#left", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
alignment: AlignmentType.LEFT,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:pPr": [{ "w:jc": { _attr: { "w:val": "left" } } }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("#right", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
alignment: AlignmentType.RIGHT,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:pPr": [{ "w:jc": { _attr: { "w:val": "right" } } }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("#justified", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
alignment: AlignmentType.JUSTIFIED,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:pPr": [{ "w:jc": { _attr: { "w:val": "both" } } }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("#thematicBreak", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
thematicBreak: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:pPr": [
|
||||||
|
{
|
||||||
|
"w:pBdr": [
|
||||||
|
{
|
||||||
|
"w:bottom": {
|
||||||
|
_attr: {
|
||||||
|
"w:color": "auto",
|
||||||
|
"w:space": 1,
|
||||||
|
"w:val": "single",
|
||||||
|
"w:sz": 6,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("#leftTabStop", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
leftTabStop: 1200,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:pPr": [
|
||||||
|
{
|
||||||
|
"w:tabs": [{ "w:tab": { _attr: { "w:val": "left", "w:pos": 1200 } } }],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("#maxRightTabStop", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
rightTabStop: TabStopPosition.MAX,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:pPr": [
|
||||||
|
{
|
||||||
|
"w:tabs": [{ "w:tab": { _attr: { "w:val": "right", "w:pos": 9026 } } }],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("#keepLines", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
keepLines: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:pPr": [{ "w:keepLines": EMPTY_OBJECT }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("#keepNext", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
keepNext: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:pPr": [{ "w:keepNext": EMPTY_OBJECT }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("formatting methods: run properties", () => {
|
||||||
|
const sizeTests = [
|
||||||
|
{
|
||||||
|
size: 24,
|
||||||
|
expected: [{ "w:sz": { _attr: { "w:val": 24 } } }, { "w:szCs": { _attr: { "w:val": 24 } } }],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
size: 24,
|
||||||
|
sizeComplexScript: true,
|
||||||
|
expected: [{ "w:sz": { _attr: { "w:val": 24 } } }, { "w:szCs": { _attr: { "w:val": 24 } } }],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
size: 24,
|
||||||
|
sizeComplexScript: false,
|
||||||
|
expected: [{ "w:sz": { _attr: { "w:val": 24 } } }],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
size: 24,
|
||||||
|
sizeComplexScript: 26,
|
||||||
|
expected: [{ "w:sz": { _attr: { "w:val": 24 } } }, { "w:szCs": { _attr: { "w:val": 26 } } }],
|
||||||
|
},
|
||||||
|
];
|
||||||
|
sizeTests.forEach(({ size, sizeComplexScript, expected }) => {
|
||||||
|
it(`#size ${size} cs ${sizeComplexScript}`, () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
run: { size, sizeComplexScript },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({ "w:rPr": expected });
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("#smallCaps", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
run: {
|
||||||
|
smallCaps: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:rPr": [{ "w:smallCaps": { _attr: { "w:val": true } } }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("#allCaps", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
run: {
|
||||||
|
allCaps: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:rPr": [{ "w:caps": { _attr: { "w:val": true } } }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("#strike", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
run: {
|
||||||
|
strike: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:rPr": [{ "w:strike": { _attr: { "w:val": true } } }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("#doubleStrike", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
run: {
|
||||||
|
doubleStrike: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:rPr": [{ "w:dstrike": { _attr: { "w:val": true } } }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("#subScript", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
run: {
|
||||||
|
subScript: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:rPr": [{ "w:vertAlign": { _attr: { "w:val": "subscript" } } }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("#superScript", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
run: {
|
||||||
|
superScript: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:rPr": [{ "w:vertAlign": { _attr: { "w:val": "superscript" } } }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("#font by name", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
run: {
|
||||||
|
font: "Times",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:rPr": [
|
||||||
|
{
|
||||||
|
"w:rFonts": {
|
||||||
|
_attr: {
|
||||||
|
"w:ascii": "Times",
|
||||||
|
"w:cs": "Times",
|
||||||
|
"w:eastAsia": "Times",
|
||||||
|
"w:hAnsi": "Times",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("#font for ascii and eastAsia", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
run: {
|
||||||
|
font: {
|
||||||
|
ascii: "Times",
|
||||||
|
eastAsia: "KaiTi",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:rPr": [
|
||||||
|
{
|
||||||
|
"w:rFonts": {
|
||||||
|
_attr: {
|
||||||
|
"w:ascii": "Times",
|
||||||
|
"w:eastAsia": "KaiTi",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
const boldTests = [
|
||||||
|
{
|
||||||
|
bold: true,
|
||||||
|
expected: [{ "w:b": { _attr: { "w:val": true } } }, { "w:bCs": { _attr: { "w:val": true } } }],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
bold: true,
|
||||||
|
boldComplexScript: true,
|
||||||
|
expected: [{ "w:b": { _attr: { "w:val": true } } }, { "w:bCs": { _attr: { "w:val": true } } }],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
bold: true,
|
||||||
|
boldComplexScript: false,
|
||||||
|
expected: [{ "w:b": { _attr: { "w:val": true } } }],
|
||||||
|
},
|
||||||
|
];
|
||||||
|
boldTests.forEach(({ bold, boldComplexScript, expected }) => {
|
||||||
|
it(`#bold ${bold} cs ${boldComplexScript}`, () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
run: { bold, boldComplexScript },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({ "w:rPr": expected });
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
const italicsTests = [
|
||||||
|
{
|
||||||
|
italics: true,
|
||||||
|
expected: [{ "w:i": { _attr: { "w:val": true } } }, { "w:iCs": { _attr: { "w:val": true } } }],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
italics: true,
|
||||||
|
italicsComplexScript: true,
|
||||||
|
expected: [{ "w:i": { _attr: { "w:val": true } } }, { "w:iCs": { _attr: { "w:val": true } } }],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
italics: true,
|
||||||
|
italicsComplexScript: false,
|
||||||
|
expected: [{ "w:i": { _attr: { "w:val": true } } }],
|
||||||
|
},
|
||||||
|
];
|
||||||
|
italicsTests.forEach(({ italics, italicsComplexScript, expected }) => {
|
||||||
|
it(`#italics ${italics} cs ${italicsComplexScript}`, () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
run: { italics, italicsComplexScript },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({ "w:rPr": expected });
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
const highlightTests = [
|
||||||
|
{
|
||||||
|
highlight: "005599",
|
||||||
|
expected: [{ "w:highlight": { _attr: { "w:val": "005599" } } }, { "w:highlightCs": { _attr: { "w:val": "005599" } } }],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
highlight: "005599",
|
||||||
|
highlightComplexScript: true,
|
||||||
|
expected: [{ "w:highlight": { _attr: { "w:val": "005599" } } }, { "w:highlightCs": { _attr: { "w:val": "005599" } } }],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
highlight: "005599",
|
||||||
|
highlightComplexScript: false,
|
||||||
|
expected: [{ "w:highlight": { _attr: { "w:val": "005599" } } }],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
highlight: "005599",
|
||||||
|
highlightComplexScript: "550099",
|
||||||
|
expected: [{ "w:highlight": { _attr: { "w:val": "005599" } } }, { "w:highlightCs": { _attr: { "w:val": "550099" } } }],
|
||||||
|
},
|
||||||
|
];
|
||||||
|
highlightTests.forEach(({ highlight, highlightComplexScript, expected }) => {
|
||||||
|
it(`#highlight ${highlight} cs ${highlightComplexScript}`, () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
run: { highlight, highlightComplexScript },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({ "w:rPr": expected });
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
const shadingTests = [
|
||||||
|
{
|
||||||
|
shadow: {
|
||||||
|
type: ShadingType.PERCENT_10,
|
||||||
|
fill: "00FFFF",
|
||||||
|
color: "FF0000",
|
||||||
|
},
|
||||||
|
expected: [
|
||||||
|
{ "w:shd": { _attr: { "w:val": "pct10", "w:fill": "00FFFF", "w:color": "FF0000" } } },
|
||||||
|
{ "w:shdCs": { _attr: { "w:val": "pct10", "w:fill": "00FFFF", "w:color": "FF0000" } } },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
shading: {
|
||||||
|
type: ShadingType.PERCENT_10,
|
||||||
|
fill: "00FFFF",
|
||||||
|
color: "FF0000",
|
||||||
|
},
|
||||||
|
expected: [
|
||||||
|
{ "w:shd": { _attr: { "w:val": "pct10", "w:fill": "00FFFF", "w:color": "FF0000" } } },
|
||||||
|
{ "w:shdCs": { _attr: { "w:val": "pct10", "w:fill": "00FFFF", "w:color": "FF0000" } } },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
shading: {
|
||||||
|
type: ShadingType.PERCENT_10,
|
||||||
|
fill: "00FFFF",
|
||||||
|
color: "FF0000",
|
||||||
|
},
|
||||||
|
shadingComplexScript: true,
|
||||||
|
expected: [
|
||||||
|
{ "w:shd": { _attr: { "w:val": "pct10", "w:fill": "00FFFF", "w:color": "FF0000" } } },
|
||||||
|
{ "w:shdCs": { _attr: { "w:val": "pct10", "w:fill": "00FFFF", "w:color": "FF0000" } } },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
shading: {
|
||||||
|
type: ShadingType.PERCENT_10,
|
||||||
|
fill: "00FFFF",
|
||||||
|
color: "FF0000",
|
||||||
|
},
|
||||||
|
shadingComplexScript: false,
|
||||||
|
expected: [{ "w:shd": { _attr: { "w:val": "pct10", "w:fill": "00FFFF", "w:color": "FF0000" } } }],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
shading: {
|
||||||
|
type: ShadingType.PERCENT_10,
|
||||||
|
fill: "00FFFF",
|
||||||
|
color: "FF0000",
|
||||||
|
},
|
||||||
|
shadingComplexScript: {
|
||||||
|
type: ShadingType.PERCENT_10,
|
||||||
|
fill: "00FFFF",
|
||||||
|
color: "00FF00",
|
||||||
|
},
|
||||||
|
expected: [
|
||||||
|
{ "w:shd": { _attr: { "w:val": "pct10", "w:fill": "00FFFF", "w:color": "FF0000" } } },
|
||||||
|
{ "w:shdCs": { _attr: { "w:val": "pct10", "w:fill": "00FFFF", "w:color": "00FF00" } } },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
];
|
||||||
|
shadingTests.forEach(({ shadow, shading, shadingComplexScript, expected }) => {
|
||||||
|
it("#shadow correctly", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
run: { shadow, shading, shadingComplexScript },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({ "w:rPr": expected });
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("#underline", () => {
|
||||||
|
it("should set underline to 'single' if no arguments are given", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
run: {
|
||||||
|
underline: {},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:rPr": [{ "w:u": { _attr: { "w:val": "single" } } }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should set the style if given", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
run: {
|
||||||
|
underline: {
|
||||||
|
type: UnderlineType.DOUBLE,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:rPr": [{ "w:u": { _attr: { "w:val": "double" } } }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should set the style and color if given", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
run: {
|
||||||
|
underline: {
|
||||||
|
type: UnderlineType.DOUBLE,
|
||||||
|
color: "005599",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:rPr": [{ "w:u": { _attr: { "w:val": "double", "w:color": "005599" } } }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("#emphasisMark", () => {
|
||||||
|
it("should set emphasisMark to 'dot' if no arguments are given", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
run: {
|
||||||
|
emphasisMark: {},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:rPr": [{ "w:em": { _attr: { "w:val": "dot" } } }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should set the style if given", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
run: {
|
||||||
|
emphasisMark: {
|
||||||
|
type: EmphasisMarkType.DOT,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:rPr": [{ "w:em": { _attr: { "w:val": "dot" } } }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("#color", () => {
|
||||||
|
const abstractNumbering = new AbstractNumbering(1, [
|
||||||
|
{
|
||||||
|
level: 0,
|
||||||
|
format: "lowerRoman",
|
||||||
|
text: "%0.",
|
||||||
|
style: {
|
||||||
|
run: {
|
||||||
|
color: "123456",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
const tree = new Formatter().format(abstractNumbering);
|
||||||
|
expect(tree["w:abstractNum"][2]["w:lvl"]).to.include({
|
||||||
|
"w:rPr": [{ "w:color": { _attr: { "w:val": "123456" } } }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
@ -1,5 +1,6 @@
|
|||||||
import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
|
import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
|
||||||
import { Level } from "./level";
|
|
||||||
|
import { ILevelsOptions, Level } from "./level";
|
||||||
import { MultiLevelType } from "./multi-level-type";
|
import { MultiLevelType } from "./multi-level-type";
|
||||||
|
|
||||||
interface IAbstractNumberingAttributesProperties {
|
interface IAbstractNumberingAttributesProperties {
|
||||||
@ -17,7 +18,7 @@ class AbstractNumberingAttributes extends XmlAttributeComponent<IAbstractNumberi
|
|||||||
export class AbstractNumbering extends XmlComponent {
|
export class AbstractNumbering extends XmlComponent {
|
||||||
public readonly id: number;
|
public readonly id: number;
|
||||||
|
|
||||||
constructor(id: number) {
|
constructor(id: number, levelOptions: ILevelsOptions[]) {
|
||||||
super("w:abstractNum");
|
super("w:abstractNum");
|
||||||
this.root.push(
|
this.root.push(
|
||||||
new AbstractNumberingAttributes({
|
new AbstractNumberingAttributes({
|
||||||
@ -27,15 +28,9 @@ export class AbstractNumbering extends XmlComponent {
|
|||||||
);
|
);
|
||||||
this.root.push(new MultiLevelType("hybridMultilevel"));
|
this.root.push(new MultiLevelType("hybridMultilevel"));
|
||||||
this.id = id;
|
this.id = id;
|
||||||
}
|
|
||||||
|
|
||||||
public addLevel(level: Level): void {
|
for (const option of levelOptions) {
|
||||||
this.root.push(level);
|
this.root.push(new Level(option));
|
||||||
}
|
}
|
||||||
|
|
||||||
public createLevel(num: number, format: string, text: string, align: string = "start"): Level {
|
|
||||||
const level = new Level(num, format, text, align);
|
|
||||||
this.addLevel(level);
|
|
||||||
return level;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
79
src/file/numbering/concrete-numbering.spec.ts
Normal file
79
src/file/numbering/concrete-numbering.spec.ts
Normal file
@ -0,0 +1,79 @@
|
|||||||
|
import { expect } from "chai";
|
||||||
|
|
||||||
|
import { Formatter } from "export/formatter";
|
||||||
|
|
||||||
|
import { LevelForOverride } from "./level";
|
||||||
|
import { ConcreteNumbering } from "./num";
|
||||||
|
|
||||||
|
describe("ConcreteNumbering", () => {
|
||||||
|
describe("#overrideLevel", () => {
|
||||||
|
let concreteNumbering: ConcreteNumbering;
|
||||||
|
beforeEach(() => {
|
||||||
|
concreteNumbering = new ConcreteNumbering(0, 1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("sets a new override level for the given level number", () => {
|
||||||
|
concreteNumbering.overrideLevel(3);
|
||||||
|
const tree = new Formatter().format(concreteNumbering);
|
||||||
|
expect(tree["w:num"]).to.include({
|
||||||
|
"w:lvlOverride": [
|
||||||
|
{ _attr: { "w:ilvl": 3 } },
|
||||||
|
{
|
||||||
|
"w:lvl": [
|
||||||
|
{ _attr: { "w:ilvl": 3, "w15:tentative": 1 } },
|
||||||
|
{ "w:start": { _attr: { "w:val": 1 } } },
|
||||||
|
{ "w:lvlJc": { _attr: { "w:val": "start" } } },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("sets the startOverride element if start is given", () => {
|
||||||
|
concreteNumbering.overrideLevel(1, 9);
|
||||||
|
const tree = new Formatter().format(concreteNumbering);
|
||||||
|
expect(tree["w:num"]).to.include({
|
||||||
|
"w:lvlOverride": [
|
||||||
|
{
|
||||||
|
_attr: {
|
||||||
|
"w:ilvl": 1,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:startOverride": {
|
||||||
|
_attr: {
|
||||||
|
"w:val": 9,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"w:lvl": [
|
||||||
|
{ _attr: { "w:ilvl": 1, "w15:tentative": 1 } },
|
||||||
|
{ "w:start": { _attr: { "w:val": 1 } } },
|
||||||
|
{ "w:lvlJc": { _attr: { "w:val": "start" } } },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("sets the lvl element if overrideLevel.Level is accessed", () => {
|
||||||
|
const ol = concreteNumbering.overrideLevel(1);
|
||||||
|
expect(ol.Level).to.be.instanceof(LevelForOverride);
|
||||||
|
const tree = new Formatter().format(concreteNumbering);
|
||||||
|
|
||||||
|
expect(tree["w:num"]).to.include({
|
||||||
|
"w:lvlOverride": [
|
||||||
|
{ _attr: { "w:ilvl": 1 } },
|
||||||
|
{
|
||||||
|
"w:lvl": [
|
||||||
|
{ _attr: { "w:ilvl": 1, "w15:tentative": 1 } },
|
||||||
|
{ "w:start": { _attr: { "w:val": 1 } } },
|
||||||
|
{ "w:lvlJc": { _attr: { "w:val": "start" } } },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
@ -1,20 +1,7 @@
|
|||||||
import { Attributes, XmlAttributeComponent, XmlComponent } from "file/xml-components";
|
import { Attributes, XmlAttributeComponent, XmlComponent } from "file/xml-components";
|
||||||
import {
|
import { AlignmentType } from "../paragraph/formatting";
|
||||||
Alignment,
|
import { IParagraphStylePropertiesOptions, ParagraphProperties } from "../paragraph/properties";
|
||||||
AlignmentType,
|
import { IRunStylePropertiesOptions, RunProperties } from "../paragraph/run/properties";
|
||||||
IIndentAttributesProperties,
|
|
||||||
Indent,
|
|
||||||
ISpacingProperties,
|
|
||||||
KeepLines,
|
|
||||||
KeepNext,
|
|
||||||
LeftTabStop,
|
|
||||||
MaxRightTabStop,
|
|
||||||
Spacing,
|
|
||||||
ThematicBreak,
|
|
||||||
} from "../paragraph/formatting";
|
|
||||||
import { ParagraphProperties } from "../paragraph/properties";
|
|
||||||
import * as formatting from "../paragraph/run/formatting";
|
|
||||||
import { RunProperties } from "../paragraph/run/properties";
|
|
||||||
|
|
||||||
interface ILevelAttributesProperties {
|
interface ILevelAttributesProperties {
|
||||||
readonly ilvl?: number;
|
readonly ilvl?: number;
|
||||||
@ -62,7 +49,7 @@ class LevelText extends XmlComponent {
|
|||||||
}
|
}
|
||||||
|
|
||||||
class LevelJc extends XmlComponent {
|
class LevelJc extends XmlComponent {
|
||||||
constructor(value: string) {
|
constructor(value: AlignmentType) {
|
||||||
super("w:lvlJc");
|
super("w:lvlJc");
|
||||||
this.root.push(
|
this.root.push(
|
||||||
new Attributes({
|
new Attributes({
|
||||||
@ -78,6 +65,19 @@ export enum LevelSuffix {
|
|||||||
TAB = "tab",
|
TAB = "tab",
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface ILevelsOptions {
|
||||||
|
readonly level: number;
|
||||||
|
readonly format?: string;
|
||||||
|
readonly text?: string;
|
||||||
|
readonly alignment?: AlignmentType;
|
||||||
|
readonly start?: number;
|
||||||
|
readonly suffix?: LevelSuffix;
|
||||||
|
readonly style?: {
|
||||||
|
readonly run?: IRunStylePropertiesOptions;
|
||||||
|
readonly paragraph?: IParagraphStylePropertiesOptions;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
class Suffix extends XmlComponent {
|
class Suffix extends XmlComponent {
|
||||||
constructor(value: LevelSuffix) {
|
constructor(value: LevelSuffix) {
|
||||||
super("w:suff");
|
super("w:suff");
|
||||||
@ -93,7 +93,7 @@ export class LevelBase extends XmlComponent {
|
|||||||
private readonly paragraphProperties: ParagraphProperties;
|
private readonly paragraphProperties: ParagraphProperties;
|
||||||
private readonly runProperties: RunProperties;
|
private readonly runProperties: RunProperties;
|
||||||
|
|
||||||
constructor(level: number, start?: number, numberFormat?: string, levelText?: string, lvlJc?: string) {
|
constructor({ level, format, text, alignment = AlignmentType.START, start = 1, style, suffix }: ILevelsOptions) {
|
||||||
super("w:lvl");
|
super("w:lvl");
|
||||||
this.root.push(
|
this.root.push(
|
||||||
new LevelAttributes({
|
new LevelAttributes({
|
||||||
@ -102,175 +102,34 @@ export class LevelBase extends XmlComponent {
|
|||||||
}),
|
}),
|
||||||
);
|
);
|
||||||
|
|
||||||
if (start !== undefined) {
|
this.root.push(new Start(start));
|
||||||
this.root.push(new Start(start));
|
this.root.push(new LevelJc(alignment));
|
||||||
}
|
|
||||||
if (numberFormat !== undefined) {
|
if (format) {
|
||||||
this.root.push(new NumberFormat(numberFormat));
|
this.root.push(new NumberFormat(format));
|
||||||
}
|
|
||||||
if (levelText !== undefined) {
|
|
||||||
this.root.push(new LevelText(levelText));
|
|
||||||
}
|
|
||||||
if (lvlJc !== undefined) {
|
|
||||||
this.root.push(new LevelJc(lvlJc));
|
|
||||||
}
|
}
|
||||||
|
|
||||||
this.paragraphProperties = new ParagraphProperties({});
|
if (text) {
|
||||||
this.runProperties = new RunProperties();
|
this.root.push(new LevelText(text));
|
||||||
|
}
|
||||||
|
|
||||||
|
this.paragraphProperties = new ParagraphProperties(style && style.paragraph);
|
||||||
|
this.runProperties = new RunProperties(style && style.run);
|
||||||
|
|
||||||
this.root.push(this.paragraphProperties);
|
this.root.push(this.paragraphProperties);
|
||||||
this.root.push(this.runProperties);
|
this.root.push(this.runProperties);
|
||||||
}
|
|
||||||
|
|
||||||
public setSuffix(value: LevelSuffix): LevelBase {
|
if (suffix) {
|
||||||
this.root.push(new Suffix(value));
|
this.root.push(new Suffix(suffix));
|
||||||
return this;
|
}
|
||||||
}
|
|
||||||
|
|
||||||
public addParagraphProperty(property: XmlComponent): Level {
|
|
||||||
this.paragraphProperties.push(property);
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public addRunProperty(property: XmlComponent): Level {
|
|
||||||
this.runProperties.push(property);
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
// ---------- Run formatting ---------------------- //
|
|
||||||
|
|
||||||
public size(twips: number): Level {
|
|
||||||
this.addRunProperty(new formatting.Size(twips));
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public bold(): Level {
|
|
||||||
this.addRunProperty(new formatting.Bold());
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public italics(): Level {
|
|
||||||
this.addRunProperty(new formatting.Italics());
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public smallCaps(): Level {
|
|
||||||
this.addRunProperty(new formatting.SmallCaps());
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public allCaps(): Level {
|
|
||||||
this.addRunProperty(new formatting.Caps());
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public strike(): Level {
|
|
||||||
this.addRunProperty(new formatting.Strike());
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public doubleStrike(): Level {
|
|
||||||
this.addRunProperty(new formatting.DoubleStrike());
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public subScript(): Level {
|
|
||||||
this.addRunProperty(new formatting.SubScript());
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public superScript(): Level {
|
|
||||||
this.addRunProperty(new formatting.SuperScript());
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public underline(underlineType?: string, color?: string): Level {
|
|
||||||
this.addRunProperty(new formatting.Underline(underlineType, color));
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public color(color: string): Level {
|
|
||||||
this.addRunProperty(new formatting.Color(color));
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public font(fontName: string): Level {
|
|
||||||
this.addRunProperty(new formatting.RunFonts(fontName));
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public highlight(color: string): Level {
|
|
||||||
this.addRunProperty(new formatting.Highlight(color));
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public shadow(value: string, fill: string, color: string): Level {
|
|
||||||
this.addRunProperty(new formatting.Shading(value, fill, color));
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
// --------------------- Paragraph formatting ------------------------ //
|
|
||||||
|
|
||||||
public center(): Level {
|
|
||||||
this.addParagraphProperty(new Alignment(AlignmentType.CENTER));
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public left(): Level {
|
|
||||||
this.addParagraphProperty(new Alignment(AlignmentType.LEFT));
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public right(): Level {
|
|
||||||
this.addParagraphProperty(new Alignment(AlignmentType.RIGHT));
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public justified(): Level {
|
|
||||||
this.addParagraphProperty(new Alignment(AlignmentType.BOTH));
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public thematicBreak(): Level {
|
|
||||||
this.addParagraphProperty(new ThematicBreak());
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public maxRightTabStop(): Level {
|
|
||||||
this.addParagraphProperty(new MaxRightTabStop());
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public leftTabStop(position: number): Level {
|
|
||||||
this.addParagraphProperty(new LeftTabStop(position));
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public indent(attrs: IIndentAttributesProperties): Level {
|
|
||||||
this.addParagraphProperty(new Indent(attrs));
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public spacing(params: ISpacingProperties): Level {
|
|
||||||
this.addParagraphProperty(new Spacing(params));
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public keepNext(): Level {
|
|
||||||
this.addParagraphProperty(new KeepNext());
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public keepLines(): Level {
|
|
||||||
this.addParagraphProperty(new KeepLines());
|
|
||||||
return this;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export class Level extends LevelBase {
|
export class Level extends LevelBase {
|
||||||
// This is the level that sits under abstractNum. We make a
|
// This is the level that sits under abstractNum. We make a
|
||||||
// handful of properties required
|
// handful of properties required
|
||||||
constructor(level: number, numberFormat: string, levelText: string, lvlJc: string) {
|
constructor(options: ILevelsOptions) {
|
||||||
super(level, 1, numberFormat, levelText, lvlJc);
|
super(options);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -20,10 +20,10 @@ class NumAttributes extends XmlAttributeComponent<INumAttributesProperties> {
|
|||||||
protected readonly xmlKeys = { numId: "w:numId" };
|
protected readonly xmlKeys = { numId: "w:numId" };
|
||||||
}
|
}
|
||||||
|
|
||||||
export class Num extends XmlComponent {
|
export class ConcreteNumbering extends XmlComponent {
|
||||||
public readonly id: number;
|
public readonly id: number;
|
||||||
|
|
||||||
constructor(numId: number, abstractNumId: number) {
|
constructor(numId: number, abstractNumId: number, public readonly reference?: string) {
|
||||||
super("w:num");
|
super("w:num");
|
||||||
this.root.push(
|
this.root.push(
|
||||||
new NumAttributes({
|
new NumAttributes({
|
||||||
@ -55,7 +55,9 @@ export class LevelOverride extends XmlComponent {
|
|||||||
this.root.push(new StartOverride(start));
|
this.root.push(new StartOverride(start));
|
||||||
}
|
}
|
||||||
|
|
||||||
this.lvl = new LevelForOverride(this.levelNum);
|
this.lvl = new LevelForOverride({
|
||||||
|
level: this.levelNum,
|
||||||
|
});
|
||||||
this.root.push(this.lvl);
|
this.root.push(this.lvl);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -2,22 +2,15 @@ import { expect } from "chai";
|
|||||||
|
|
||||||
import { Formatter } from "export/formatter";
|
import { Formatter } from "export/formatter";
|
||||||
|
|
||||||
import { AbstractNumbering } from "./abstract-numbering";
|
|
||||||
import { LevelForOverride } from "./level";
|
|
||||||
import { Num } from "./num";
|
|
||||||
import { Numbering } from "./numbering";
|
import { Numbering } from "./numbering";
|
||||||
|
|
||||||
import { EMPTY_OBJECT } from "file/xml-components";
|
|
||||||
|
|
||||||
describe("Numbering", () => {
|
describe("Numbering", () => {
|
||||||
let numbering: Numbering;
|
|
||||||
|
|
||||||
beforeEach(() => {
|
|
||||||
numbering = new Numbering();
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("#constructor", () => {
|
describe("#constructor", () => {
|
||||||
it("creates a default numbering with one abstract and one concrete instance", () => {
|
it("creates a default numbering with one abstract and one concrete instance", () => {
|
||||||
|
const numbering = new Numbering({
|
||||||
|
config: [],
|
||||||
|
});
|
||||||
|
|
||||||
const tree = new Formatter().format(numbering);
|
const tree = new Formatter().format(numbering);
|
||||||
expect(Object.keys(tree)).to.deep.equal(["w:numbering"]);
|
expect(Object.keys(tree)).to.deep.equal(["w:numbering"]);
|
||||||
const abstractNums = tree["w:numbering"].filter((el) => el["w:abstractNum"]);
|
const abstractNums = tree["w:numbering"].filter((el) => el["w:abstractNum"]);
|
||||||
@ -46,418 +39,4 @@ describe("Numbering", () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("#createAbstractNumbering", () => {
|
|
||||||
it("returns a new AbstractNumbering instance", () => {
|
|
||||||
const a2 = numbering.createAbstractNumbering();
|
|
||||||
expect(a2).to.be.instanceof(AbstractNumbering);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("assigns a unique ID to each abstract numbering it creates", () => {
|
|
||||||
const a2 = numbering.createAbstractNumbering();
|
|
||||||
const a3 = numbering.createAbstractNumbering();
|
|
||||||
expect(a2.id).not.to.equal(a3.id);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("#createConcreteNumbering", () => {
|
|
||||||
it("returns a new Num instance with its abstract ID set to the AbstractNumbering's ID", () => {
|
|
||||||
const a2 = numbering.createAbstractNumbering();
|
|
||||||
const n = numbering.createConcreteNumbering(a2);
|
|
||||||
expect(n).to.be.instanceof(Num);
|
|
||||||
const tree = new Formatter().format(numbering);
|
|
||||||
const serializedN = tree["w:numbering"].find((obj) => obj["w:num"] && obj["w:num"][0]._attr["w:numId"] === n.id);
|
|
||||||
expect(serializedN["w:num"][1]["w:abstractNumId"]._attr["w:val"]).to.equal(a2.id);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("assigns a unique ID to each concrete numbering it creates", () => {
|
|
||||||
const a2 = numbering.createAbstractNumbering();
|
|
||||||
const n = numbering.createConcreteNumbering(a2);
|
|
||||||
const n2 = numbering.createConcreteNumbering(a2);
|
|
||||||
expect(n.id).not.to.equal(n2.id);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("AbstractNumbering", () => {
|
|
||||||
it("stores its ID at its .id property", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(5);
|
|
||||||
expect(abstractNumbering.id).to.equal(5);
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("#createLevel", () => {
|
|
||||||
it("creates a level with the given characteristics", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(3, "lowerLetter", "%1)", "end");
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({ _attr: { "w:ilvl": 3, "w15:tentative": 1 } });
|
|
||||||
expect(tree["w:lvl"]).to.include({ "w:start": { _attr: { "w:val": 1 } } });
|
|
||||||
expect(tree["w:lvl"]).to.include({ "w:lvlJc": { _attr: { "w:val": "end" } } });
|
|
||||||
expect(tree["w:lvl"]).to.include({ "w:numFmt": { _attr: { "w:val": "lowerLetter" } } });
|
|
||||||
expect(tree["w:lvl"]).to.include({ "w:lvlText": { _attr: { "w:val": "%1)" } } });
|
|
||||||
});
|
|
||||||
|
|
||||||
it("uses 'start' as the default alignment", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(3, "lowerLetter", "%1)");
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({ _attr: { "w:ilvl": 3, "w15:tentative": 1 } });
|
|
||||||
expect(tree["w:lvl"]).to.include({ "w:start": { _attr: { "w:val": 1 } } });
|
|
||||||
expect(tree["w:lvl"]).to.include({ "w:lvlJc": { _attr: { "w:val": "start" } } });
|
|
||||||
expect(tree["w:lvl"]).to.include({ "w:numFmt": { _attr: { "w:val": "lowerLetter" } } });
|
|
||||||
expect(tree["w:lvl"]).to.include({ "w:lvlText": { _attr: { "w:val": "%1)" } } });
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("formatting methods: paragraph properties", () => {
|
|
||||||
it("#indent", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerLetter", "%0.").indent({ left: 720 });
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:pPr": [{ "w:ind": { _attr: { "w:left": 720 } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#spacing", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerLetter", "%0.").spacing({ before: 50, after: 150 });
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:pPr": [{ "w:spacing": { _attr: { "w:before": 50, "w:after": 150 } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#center", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerLetter", "%0.").center();
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:pPr": [{ "w:jc": { _attr: { "w:val": "center" } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#left", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.", "left").left();
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:pPr": [{ "w:jc": { _attr: { "w:val": "left" } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#right", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").right();
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:pPr": [{ "w:jc": { _attr: { "w:val": "right" } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#justified", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").justified();
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:pPr": [{ "w:jc": { _attr: { "w:val": "both" } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#thematicBreak", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").thematicBreak();
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:pPr": [
|
|
||||||
{
|
|
||||||
"w:pBdr": [
|
|
||||||
{
|
|
||||||
"w:bottom": {
|
|
||||||
_attr: {
|
|
||||||
"w:color": "auto",
|
|
||||||
"w:space": 1,
|
|
||||||
"w:val": "single",
|
|
||||||
"w:sz": 6,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#leftTabStop", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").leftTabStop(1200);
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:pPr": [
|
|
||||||
{
|
|
||||||
"w:tabs": [{ "w:tab": { _attr: { "w:val": "left", "w:pos": 1200 } } }],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#maxRightTabStop", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").maxRightTabStop();
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:pPr": [
|
|
||||||
{
|
|
||||||
"w:tabs": [{ "w:tab": { _attr: { "w:val": "right", "w:pos": 9026 } } }],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#keepLines", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").keepLines();
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:pPr": [{ "w:keepLines": EMPTY_OBJECT }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#keepNext", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").keepNext();
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:pPr": [{ "w:keepNext": EMPTY_OBJECT }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("formatting methods: run properties", () => {
|
|
||||||
it("#size", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").size(24);
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:rPr": [{ "w:sz": { _attr: { "w:val": 24 } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#smallCaps", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").smallCaps();
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:rPr": [{ "w:smallCaps": { _attr: { "w:val": true } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#allCaps", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").allCaps();
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:rPr": [{ "w:caps": { _attr: { "w:val": true } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#strike", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").strike();
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:rPr": [{ "w:strike": { _attr: { "w:val": true } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#doubleStrike", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").doubleStrike();
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:rPr": [{ "w:dstrike": { _attr: { "w:val": true } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#subScript", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").subScript();
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:rPr": [{ "w:vertAlign": { _attr: { "w:val": "subscript" } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#superScript", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").superScript();
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:rPr": [{ "w:vertAlign": { _attr: { "w:val": "superscript" } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#font", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").font("Times");
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:rPr": [
|
|
||||||
{ "w:rFonts": { _attr: { "w:ascii": "Times", "w:cs": "Times", "w:eastAsia": "Times", "w:hAnsi": "Times" } } },
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#bold", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").bold();
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:rPr": [{ "w:b": { _attr: { "w:val": true } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#italics", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").italics();
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:rPr": [{ "w:i": { _attr: { "w:val": true } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#highlight", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").highlight("005599");
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:rPr": [{ "w:highlight": { _attr: { "w:val": "005599" } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#shadow", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").shadow("pct10", "00FFFF", "FF0000");
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:rPr": [{ "w:shd": { _attr: { "w:val": "pct10", "w:fill": "00FFFF", "w:color": "FF0000" } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("#underline", () => {
|
|
||||||
it("should set underline to 'single' if no arguments are given", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").underline();
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:rPr": [{ "w:u": { _attr: { "w:val": "single" } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should set the style if given", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").underline("double");
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:rPr": [{ "w:u": { _attr: { "w:val": "double" } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should set the style and color if given", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").underline("double", "005599");
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:rPr": [{ "w:u": { _attr: { "w:val": "double", "w:color": "005599" } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("#color", () => {
|
|
||||||
const abstractNumbering = new AbstractNumbering(1);
|
|
||||||
const level = abstractNumbering.createLevel(0, "lowerRoman", "%0.").color("123456");
|
|
||||||
const tree = new Formatter().format(level);
|
|
||||||
expect(tree["w:lvl"]).to.include({
|
|
||||||
"w:rPr": [{ "w:color": { _attr: { "w:val": "123456" } } }],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("concrete numbering", () => {
|
|
||||||
describe("#overrideLevel", () => {
|
|
||||||
let numbering;
|
|
||||||
let abstractNumbering;
|
|
||||||
let concreteNumbering;
|
|
||||||
beforeEach(() => {
|
|
||||||
numbering = new Numbering();
|
|
||||||
abstractNumbering = numbering.createAbstractNumbering();
|
|
||||||
concreteNumbering = numbering.createConcreteNumbering(abstractNumbering);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("sets a new override level for the given level number", () => {
|
|
||||||
concreteNumbering.overrideLevel(3);
|
|
||||||
const tree = new Formatter().format(concreteNumbering);
|
|
||||||
expect(tree["w:num"]).to.include({
|
|
||||||
"w:lvlOverride": [
|
|
||||||
{
|
|
||||||
_attr: {
|
|
||||||
"w:ilvl": 3,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"w:lvl": {
|
|
||||||
_attr: {
|
|
||||||
"w:ilvl": 3,
|
|
||||||
"w15:tentative": 1,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("sets the startOverride element if start is given", () => {
|
|
||||||
concreteNumbering.overrideLevel(1, 9);
|
|
||||||
const tree = new Formatter().format(concreteNumbering);
|
|
||||||
expect(tree["w:num"]).to.include({
|
|
||||||
"w:lvlOverride": [
|
|
||||||
{
|
|
||||||
_attr: {
|
|
||||||
"w:ilvl": 1,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"w:startOverride": {
|
|
||||||
_attr: {
|
|
||||||
"w:val": 9,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"w:lvl": {
|
|
||||||
_attr: {
|
|
||||||
"w:ilvl": 1,
|
|
||||||
"w15:tentative": 1,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("sets the lvl element if overrideLevel.Level is accessed", () => {
|
|
||||||
const ol = concreteNumbering.overrideLevel(1);
|
|
||||||
expect(ol.Level).to.be.instanceof(LevelForOverride);
|
|
||||||
const tree = new Formatter().format(concreteNumbering);
|
|
||||||
expect(tree["w:num"]).to.include({
|
|
||||||
"w:lvlOverride": [
|
|
||||||
{ _attr: { "w:ilvl": 1 } },
|
|
||||||
{
|
|
||||||
"w:lvl": { _attr: { "w15:tentative": 1, "w:ilvl": 1 } },
|
|
||||||
},
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
@ -1,17 +1,27 @@
|
|||||||
import { Indent } from "file/paragraph";
|
// http://officeopenxml.com/WPnumbering.php
|
||||||
|
import { AlignmentType } from "file/paragraph";
|
||||||
import { IXmlableObject, XmlComponent } from "file/xml-components";
|
import { IXmlableObject, XmlComponent } from "file/xml-components";
|
||||||
|
|
||||||
import { DocumentAttributes } from "../document/document-attributes";
|
import { DocumentAttributes } from "../document/document-attributes";
|
||||||
import { AbstractNumbering } from "./abstract-numbering";
|
import { AbstractNumbering } from "./abstract-numbering";
|
||||||
import { Num } from "./num";
|
import { ILevelsOptions } from "./level";
|
||||||
|
import { ConcreteNumbering } from "./num";
|
||||||
|
|
||||||
|
export interface INumberingOptions {
|
||||||
|
readonly config: {
|
||||||
|
readonly levels: ILevelsOptions[];
|
||||||
|
readonly reference: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
|
||||||
export class Numbering extends XmlComponent {
|
export class Numbering extends XmlComponent {
|
||||||
// tslint:disable-next-line:readonly-keyword
|
// tslint:disable-next-line:readonly-keyword
|
||||||
private nextId: number;
|
private nextId: number;
|
||||||
|
|
||||||
private readonly abstractNumbering: XmlComponent[] = [];
|
private readonly abstractNumbering: AbstractNumbering[] = [];
|
||||||
private readonly concreteNumbering: XmlComponent[] = [];
|
private readonly concreteNumbering: ConcreteNumbering[] = [];
|
||||||
|
|
||||||
constructor() {
|
constructor(options: INumberingOptions) {
|
||||||
super("w:numbering");
|
super("w:numbering");
|
||||||
this.root.push(
|
this.root.push(
|
||||||
new DocumentAttributes({
|
new DocumentAttributes({
|
||||||
@ -37,39 +47,114 @@ export class Numbering extends XmlComponent {
|
|||||||
|
|
||||||
this.nextId = 0;
|
this.nextId = 0;
|
||||||
|
|
||||||
const abstractNumbering = this.createAbstractNumbering();
|
const abstractNumbering = this.createAbstractNumbering([
|
||||||
|
{
|
||||||
abstractNumbering.createLevel(0, "bullet", "\u25CF", "left").addParagraphProperty(new Indent({ left: 720, hanging: 360 }));
|
level: 0,
|
||||||
|
format: "bullet",
|
||||||
abstractNumbering.createLevel(1, "bullet", "\u25CB", "left").addParagraphProperty(new Indent({ left: 1440, hanging: 360 }));
|
text: "\u25CF",
|
||||||
|
alignment: AlignmentType.LEFT,
|
||||||
abstractNumbering.createLevel(2, "bullet", "\u25A0", "left").addParagraphProperty(new Indent({ left: 2160, hanging: 360 }));
|
style: {
|
||||||
|
paragraph: {
|
||||||
abstractNumbering.createLevel(3, "bullet", "\u25CF", "left").addParagraphProperty(new Indent({ left: 2880, hanging: 360 }));
|
indent: { left: 720, hanging: 360 },
|
||||||
|
},
|
||||||
abstractNumbering.createLevel(4, "bullet", "\u25CB", "left").addParagraphProperty(new Indent({ left: 3600, hanging: 360 }));
|
},
|
||||||
|
},
|
||||||
abstractNumbering.createLevel(5, "bullet", "\u25A0", "left").addParagraphProperty(new Indent({ left: 4320, hanging: 360 }));
|
{
|
||||||
|
level: 1,
|
||||||
abstractNumbering.createLevel(6, "bullet", "\u25CF", "left").addParagraphProperty(new Indent({ left: 5040, hanging: 360 }));
|
format: "bullet",
|
||||||
|
text: "\u25CB",
|
||||||
abstractNumbering.createLevel(7, "bullet", "\u25CB", "left").addParagraphProperty(new Indent({ left: 5760, hanging: 360 }));
|
alignment: AlignmentType.LEFT,
|
||||||
|
style: {
|
||||||
abstractNumbering.createLevel(8, "bullet", "\u25A0", "left").addParagraphProperty(new Indent({ left: 6480, hanging: 360 }));
|
paragraph: {
|
||||||
|
indent: { left: 1440, hanging: 360 },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
level: 2,
|
||||||
|
format: "bullet",
|
||||||
|
text: "\u25A0",
|
||||||
|
alignment: AlignmentType.LEFT,
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
indent: { left: 2160, hanging: 360 },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
level: 3,
|
||||||
|
format: "bullet",
|
||||||
|
text: "\u25CF",
|
||||||
|
alignment: AlignmentType.LEFT,
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
indent: { left: 2880, hanging: 360 },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
level: 4,
|
||||||
|
format: "bullet",
|
||||||
|
text: "\u25CB",
|
||||||
|
alignment: AlignmentType.LEFT,
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
indent: { left: 3600, hanging: 360 },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
level: 5,
|
||||||
|
format: "bullet",
|
||||||
|
text: "\u25A0",
|
||||||
|
alignment: AlignmentType.LEFT,
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
indent: { left: 4320, hanging: 360 },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
level: 6,
|
||||||
|
format: "bullet",
|
||||||
|
text: "\u25CF",
|
||||||
|
alignment: AlignmentType.LEFT,
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
indent: { left: 5040, hanging: 360 },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
level: 7,
|
||||||
|
format: "bullet",
|
||||||
|
text: "\u25CF",
|
||||||
|
alignment: AlignmentType.LEFT,
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
indent: { left: 5760, hanging: 360 },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
level: 8,
|
||||||
|
format: "bullet",
|
||||||
|
text: "\u25CF",
|
||||||
|
alignment: AlignmentType.LEFT,
|
||||||
|
style: {
|
||||||
|
paragraph: {
|
||||||
|
indent: { left: 6480, hanging: 360 },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
this.createConcreteNumbering(abstractNumbering);
|
this.createConcreteNumbering(abstractNumbering);
|
||||||
}
|
|
||||||
|
|
||||||
public createAbstractNumbering(): AbstractNumbering {
|
for (const con of options.config) {
|
||||||
const num = new AbstractNumbering(this.nextId++);
|
const currentAbstractNumbering = this.createAbstractNumbering(con.levels);
|
||||||
this.abstractNumbering.push(num);
|
this.createConcreteNumbering(currentAbstractNumbering, con.reference);
|
||||||
return num;
|
}
|
||||||
}
|
|
||||||
|
|
||||||
public createConcreteNumbering(abstractNumbering: AbstractNumbering): Num {
|
|
||||||
const num = new Num(this.nextId++, abstractNumbering.id);
|
|
||||||
this.concreteNumbering.push(num);
|
|
||||||
return num;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public prepForXml(): IXmlableObject | undefined {
|
public prepForXml(): IXmlableObject | undefined {
|
||||||
@ -77,4 +162,20 @@ export class Numbering extends XmlComponent {
|
|||||||
this.concreteNumbering.forEach((x) => this.root.push(x));
|
this.concreteNumbering.forEach((x) => this.root.push(x));
|
||||||
return super.prepForXml();
|
return super.prepForXml();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private createConcreteNumbering(abstractNumbering: AbstractNumbering, reference?: string): ConcreteNumbering {
|
||||||
|
const num = new ConcreteNumbering(this.nextId++, abstractNumbering.id, reference);
|
||||||
|
this.concreteNumbering.push(num);
|
||||||
|
return num;
|
||||||
|
}
|
||||||
|
|
||||||
|
private createAbstractNumbering(options: ILevelsOptions[]): AbstractNumbering {
|
||||||
|
const num = new AbstractNumbering(this.nextId++, options);
|
||||||
|
this.abstractNumbering.push(num);
|
||||||
|
return num;
|
||||||
|
}
|
||||||
|
|
||||||
|
public get ConcreteNumbering(): ConcreteNumbering[] {
|
||||||
|
return this.concreteNumbering;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
// http://officeopenxml.com/WPalignment.php
|
// http://officeopenxml.com/WPalignment.php
|
||||||
|
// http://officeopenxml.com/WPtableAlignment.php
|
||||||
import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
|
import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
|
||||||
|
|
||||||
export enum AlignmentType {
|
export enum AlignmentType {
|
||||||
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user