diff --git a/.travis.yml b/.travis.yml index 2fd9123e2a..3c015ad296 100644 --- a/.travis.yml +++ b/.travis.yml @@ -9,43 +9,43 @@ script: - npm run test.coverage - npm run style - npm run build - - npm run ts-node -- ./demo/demo1.ts + - npm run ts-node -- ./demo/1-basic.ts - npm run e2e "My Document.docx" - - npm run ts-node -- ./demo/demo2.ts - - npm run ts-node -- ./demo/demo3.ts - - npm run ts-node -- ./demo/demo4.ts - - npm run ts-node -- ./demo/demo5.ts - - npm run ts-node -- ./demo/demo6.ts - - npm run ts-node -- ./demo/demo7.ts - - npm run ts-node -- ./demo/demo8.ts - - npm run ts-node -- ./demo/demo9.ts - - npm run ts-node -- ./demo/demo10.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/4-basic-table.ts + - npm run ts-node -- ./demo/5-images.ts + - npm run ts-node -- ./demo/6-page-borders.ts + - npm run ts-node -- ./demo/7-landscape.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/10-my-cv.ts - npm run e2e "My Document.docx" - - npm run ts-node -- ./demo/demo11.ts - - npm run ts-node -- ./demo/demo12.ts - - npm run ts-node -- ./demo/demo13.ts - - npm run ts-node -- ./demo/demo14.ts - - npm run ts-node -- ./demo/demo15.ts - - npm run ts-node -- ./demo/demo16.ts - - npm run ts-node -- ./demo/demo17.ts - - npm run ts-node -- ./demo/demo18.ts - - npm run ts-node -- ./demo/demo19.ts - - npm run ts-node -- ./demo/demo20.ts - - npm run ts-node -- ./demo/demo21.ts - - npm run ts-node -- ./demo/demo22.ts - - npm run ts-node -- ./demo/demo23.ts - - npm run ts-node -- ./demo/demo24.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/13-xml-styles.ts + - npm run ts-node -- ./demo/14-page-numbers.ts + - npm run ts-node -- ./demo/15-page-break-before.ts + - npm run ts-node -- ./demo/16-multiple-sections.ts + - npm run ts-node -- ./demo/17-footnotes.ts + - npm run ts-node -- ./demo/18-image-from-buffer.ts + - npm run ts-node -- ./demo/19-export-to-base64.ts + - npm run ts-node -- ./demo/20-table-cell-borders.ts + - npm run ts-node -- ./demo/21-bookmarks.ts + - npm run ts-node -- ./demo/22-right-to-left-text.ts + - npm run ts-node -- ./demo/23-base64-images.ts + - npm run ts-node -- ./demo/24-images-to-table-cell.ts # - npm run ts-node -- ./demo/demo25.ts - - npm run ts-node -- ./demo/demo26.ts - - npm run ts-node -- ./demo/demo27.ts - - npm run ts-node -- ./demo/demo28.ts - - npm run ts-node -- ./demo/demo29.ts - - npm run ts-node -- ./demo/demo30.ts - - npm run ts-node -- ./demo/demo31.ts - - npm run ts-node -- ./demo/demo32.ts + - npm run ts-node -- ./demo/26-paragraph-borders.ts + - npm run ts-node -- ./demo/27-declaritive-styles-3.ts + - npm run ts-node -- ./demo/28-table-of-contents.ts + - npm run ts-node -- ./demo/29-numbered-lists.ts + - npm run ts-node -- ./demo/30-template-document.ts + - npm run ts-node -- ./demo/31-tables.ts + - npm run ts-node -- ./demo/32-merge-table-cells.ts # - npm run e2e "My Document.docx" // Need to fix - - npm run ts-node -- ./demo/demo33.ts - - npm run ts-node -- ./demo/demo34.ts + - npm run ts-node -- ./demo/33-sequential-captions.ts + - npm run ts-node -- ./demo/34-floating-tables.ts after_failure: - "cat /home/travis/builds/dolanmiu/docx/npm-debug.log" after_success: diff --git a/README.md b/README.md index e359e3627e..7cb5c93879 100644 --- a/README.md +++ b/README.md @@ -66,9 +66,15 @@ Read the contribution guidelines [here](https://docx.js.org/#/contribution-guide # Used by -[drawing](https://hfour.com/) -[drawing](https://fuzzproductions.com/) -[drawing](https://www.mettzer.com/) +[drawing](https://hfour.com/) +[drawing](https://fuzzproductions.com/) +[drawing](https://www.mettzer.com/) +[drawing](https://www.wisedoc.net/) +[drawing](https://www.dabblewriter.com/) +[drawing](https://turbopatent.com/) +[drawing](http://www.madisoncres.com/) + +...and many more! --- diff --git a/demo/1-basic.ts b/demo/1-basic.ts new file mode 100644 index 0000000000..7db8870259 --- /dev/null +++ b/demo/1-basic.ts @@ -0,0 +1,29 @@ +// 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, Packer, Paragraph, TextRun } from "../build"; + +const doc = new Document(); + +doc.addSection({ + properties: {}, + children: [ + new Paragraph({ + children: [ + new TextRun("Hello World"), + new TextRun({ + text: "Foo Bar", + bold: true, + }), + new TextRun({ + text: "Github is the best", + bold: true, + }).tab(), + ], + }), + ], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/demo10.ts b/demo/10-my-cv.ts similarity index 55% rename from demo/demo10.ts rename to demo/10-my-cv.ts index 7dcc1befab..6c60be4f48 100644 --- a/demo/demo10.ts +++ b/demo/10-my-cv.ts @@ -1,7 +1,7 @@ // Generate a CV // Import from 'docx' rather than '../build' if you install from npm import * as fs from "fs"; -import { Document, Packer, Paragraph, TextRun } from "../build"; +import { AlignmentType, Document, HeadingLevel, Packer, Paragraph, TextRun } from "../build"; // tslint:disable:no-shadowed-variable @@ -127,150 +127,165 @@ const achievements = [ ]; class DocumentCreator { - public create(data: object[]): Document { - // tslint:disable-next-line:no-any - const experiences = data[0] as any[]; - // tslint:disable-next-line:no-any - const educations = data[1] as any[]; - const skills = data[2] as object[]; - const achivements = data[3] as object[]; + // tslint:disable-next-line: typedef + public create([experiences, educations, skills, achivements]): Document { const document = new Document(); - document.addParagraph(new Paragraph("Dolan Miu").title()); - document.addParagraph(this.createContactInfo(PHONE_NUMBER, PROFILE_URL, EMAIL)); - document.addParagraph(this.createHeading("Education")); + document.addSection({ + children: [ + new Paragraph({ + text: "Dolan Miu", + heading: HeadingLevel.TITLE, + }), + this.createContactInfo(PHONE_NUMBER, PROFILE_URL, EMAIL), + this.createHeading("Education"), + ...educations + .map((education) => { + const arr: Paragraph[] = []; + arr.push( + this.createInstitutionHeader(education.schoolName, `${education.startDate.year} - ${education.endDate.year}`), + ); + arr.push(this.createRoleText(`${education.fieldOfStudy} - ${education.degree}`)); - for (const education of educations) { - document.addParagraph( - this.createInstitutionHeader(education.schoolName, `${education.startDate.year} - ${education.endDate.year}`), - ); - document.addParagraph(this.createRoleText(`${education.fieldOfStudy} - ${education.degree}`)); + const bulletPoints = this.splitParagraphIntoBullets(education.notes); + bulletPoints.forEach((bulletPoint) => { + arr.push(this.createBullet(bulletPoint)); + }); - const bulletPoints = this.splitParagraphIntoBullets(education.notes); - bulletPoints.forEach((bulletPoint) => { - document.addParagraph(this.createBullet(bulletPoint)); - }); - } + return arr; + }) + .reduce((prev, curr) => prev.concat(curr), []), + this.createHeading("Experience"), + ...experiences + .map((position) => { + const arr: Paragraph[] = []; - document.addParagraph(this.createHeading("Experience")); + arr.push( + this.createInstitutionHeader( + position.company.name, + this.createPositionDateText(position.startDate, position.endDate, position.isCurrent), + ), + ); + arr.push(this.createRoleText(position.title)); - for (const position of experiences) { - document.addParagraph( - this.createInstitutionHeader( - position.company.name, - this.createPositionDateText(position.startDate, position.endDate, position.isCurrent), + const bulletPoints = this.splitParagraphIntoBullets(position.summary); + + bulletPoints.forEach((bulletPoint) => { + arr.push(this.createBullet(bulletPoint)); + }); + + return arr; + }) + .reduce((prev, curr) => prev.concat(curr), []), + this.createHeading("Skills, Achievements and Interests"), + this.createSubHeading("Skills"), + this.createSkillList(skills), + this.createSubHeading("Achievements"), + ...this.createAchivementsList(achivements), + this.createSubHeading("Interests"), + this.createInterests("Programming, Technology, Music Production, Web Design, 3D Modelling, Dancing."), + this.createHeading("References"), + new Paragraph( + "Dr. Dean Mohamedally Director of Postgraduate Studies Department of Computer Science, University College London Malet Place, Bloomsbury, London WC1E d.mohamedally@ucl.ac.uk", ), - ); - document.addParagraph(this.createRoleText(position.title)); + new Paragraph("More references upon request"), + new Paragraph({ + text: "This CV was generated in real-time based on my Linked-In profile from my personal website www.dolan.bio.", + alignment: AlignmentType.CENTER, + }), + ], + }); - const bulletPoints = this.splitParagraphIntoBullets(position.summary); - - bulletPoints.forEach((bulletPoint) => { - document.addParagraph(this.createBullet(bulletPoint)); - }); - } - - document.addParagraph(this.createHeading("Skills, Achievements and Interests")); - - document.addParagraph(this.createSubHeading("Skills")); - document.addParagraph(this.createSkillList(skills)); - - document.addParagraph(this.createSubHeading("Achievements")); - - for (const achievementParagraph of this.createAchivementsList(achivements)) { - document.addParagraph(achievementParagraph); - } - - document.addParagraph(this.createSubHeading("Interests")); - - document.addParagraph(this.createInterests("Programming, Technology, Music Production, Web Design, 3D Modelling, Dancing.")); - - document.addParagraph(this.createHeading("References")); - - document.addParagraph( - new Paragraph( - "Dr. Dean Mohamedally Director of Postgraduate Studies Department of Computer Science, University College London Malet Place, Bloomsbury, London WC1E d.mohamedally@ucl.ac.uk", - ), - ); - document.addParagraph(new Paragraph("More references upon request")); - document.addParagraph( - new Paragraph( - "This CV was generated in real-time based on my Linked-In profile from my personal website www.dolan.bio.", - ).center(), - ); return document; } public createContactInfo(phoneNumber: string, profileUrl: string, email: string): Paragraph { - const paragraph = new Paragraph().center(); - const contactInfo = new TextRun(`Mobile: ${phoneNumber} | LinkedIn: ${profileUrl} | Email: ${email}`); - const address = new TextRun("Address: 58 Elm Avenue, Kent ME4 6ER, UK").break(); - - paragraph.addRun(contactInfo); - paragraph.addRun(address); - - return paragraph; + return new Paragraph({ + alignment: AlignmentType.CENTER, + children: [ + new TextRun(`Mobile: ${phoneNumber} | LinkedIn: ${profileUrl} | Email: ${email}`), + new TextRun("Address: 58 Elm Avenue, Kent ME4 6ER, UK").break(), + ], + }); } public createHeading(text: string): Paragraph { - return new Paragraph(text).heading1().thematicBreak(); + return new Paragraph({ + text: text, + heading: HeadingLevel.HEADING_1, + thematicBreak: true, + }); } public createSubHeading(text: string): Paragraph { - return new Paragraph(text).heading2(); + return new Paragraph({ + text: text, + heading: HeadingLevel.HEADING_2, + }); } public createInstitutionHeader(institutionName: string, dateText: string): Paragraph { - const paragraph = new Paragraph().maxRightTabStop(); - const institution = new TextRun(institutionName).bold(); - const date = new TextRun(dateText).tab().bold(); - - paragraph.addRun(institution); - paragraph.addRun(date); - - return paragraph; + return new Paragraph({ + tabStop: { + maxRight: {}, + }, + children: [ + new TextRun({ + text: institutionName, + bold: true, + }), + new TextRun({ + text: dateText, + bold: true, + }).tab(), + ], + }); } public createRoleText(roleText: string): Paragraph { - const paragraph = new Paragraph(); - const role = new TextRun(roleText).italics(); - - paragraph.addRun(role); - - return paragraph; + return new Paragraph({ + children: [ + new TextRun({ + text: roleText, + italics: true, + }), + ], + }); } public createBullet(text: string): Paragraph { - return new Paragraph(text).bullet(); + return new Paragraph({ + text: text, + bullet: { + level: 0, + }, + }); } // tslint:disable-next-line:no-any public createSkillList(skills: any[]): Paragraph { - const paragraph = new Paragraph(); - const skillConcat = skills.map((skill) => skill.name).join(", ") + "."; - - paragraph.addRun(new TextRun(skillConcat)); - - return paragraph; + return new Paragraph({ + children: [new TextRun(skills.map((skill) => skill.name).join(", ") + ".")], + }); } // tslint:disable-next-line:no-any public createAchivementsList(achivements: any[]): Paragraph[] { - const arr: Paragraph[] = []; - - for (const achievement of achivements) { - const paragraph = new Paragraph(achievement.name).bullet(); - arr.push(paragraph); - } - - return arr; + return achivements.map( + (achievement) => + new Paragraph({ + text: achievement.name, + bullet: { + level: 0, + }, + }), + ); } public createInterests(interests: string): Paragraph { - const paragraph = new Paragraph(); - - paragraph.addRun(new TextRun(interests)); - return paragraph; + return new Paragraph({ + children: [new TextRun(interests)], + }); } public splitParagraphIntoBullets(text: string): string[] { @@ -321,8 +336,6 @@ const documentCreator = new DocumentCreator(); const doc = documentCreator.create([experiences, education, skills, achievements]); -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { +Packer.toBuffer(doc).then((buffer) => { fs.writeFileSync("My Document.docx", buffer); }); diff --git a/demo/demo11.ts b/demo/11-declaritive-styles-2.ts similarity index 50% rename from demo/demo11.ts rename to demo/11-declaritive-styles-2.ts index 2b2e183c32..bb6428d518 100644 --- a/demo/demo11.ts +++ b/demo/11-declaritive-styles-2.ts @@ -1,14 +1,9 @@ // Setting styles with JavaScript configuration // Import from 'docx' rather than '../build' if you install from npm import * as fs from "fs"; -import { Document, Packer, Paragraph, Table } from "../build"; +import { AlignmentType, Document, Footer, HeadingLevel, Media, Packer, Paragraph, Table } from "../build"; -const doc = new Document(undefined, { - top: 700, - right: 700, - bottom: 700, - left: 700, -}); +const doc = new Document(); doc.Styles.createParagraphStyle("Heading1", "Heading 1") .basedOn("Normal") @@ -83,28 +78,7 @@ doc.Styles.createParagraphStyle("ListParagraph", "List Paragraph") .quickFormat() .basedOn("Normal"); -doc.createImage(fs.readFileSync("./demo/images/pizza.gif")); -doc.createParagraph("HEADING") - .heading1() - .center(); - -doc.Footer.createParagraph("1") - .style("normalPara") - .right(); - -doc.createParagraph("Ref. :").style("normalPara"); -doc.createParagraph("Date :").style("normalPara"); - -doc.createParagraph("To,").style("normalPara"); -doc.createParagraph("The Superindenting Engineer,(O &M)").style("normalPara"); - -doc.createParagraph("Sub : ").style("normalPara"); - -doc.createParagraph("Ref. : ").style("normalPara"); - -doc.createParagraph("Sir,").style("normalPara"); - -doc.createParagraph("BRIEF DESCRIPTION").style("normalPara"); +const image = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif")); const table = new Table({ rows: 4, @@ -113,28 +87,82 @@ const table = new Table({ table .getRow(0) .getCell(0) - .addParagraph(new Paragraph("Pole No.")); + .add(new Paragraph("Pole No.")); -doc.addTable(table); +const image1 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif")); +const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif")); -const arrboth = [ - { - image: "./demo/images/pizza.gif", - comment: "Test", +doc.addSection({ + properties: { + top: 700, + right: 700, + bottom: 700, + left: 700, }, - { - image: "./demo/images/pizza.gif", - comment: "Test 2", + footers: { + default: new Footer({ + children: [ + new Paragraph({ + text: "1", + style: "normalPara", + alignment: AlignmentType.RIGHT, + }), + ], + }), }, -]; - -arrboth.forEach((item) => { - doc.createImage(fs.readFileSync(item.image)); - doc.createParagraph(item.comment).style("normalPara2"); + children: [ + new Paragraph(image), + new Paragraph({ + text: "HEADING", + heading: HeadingLevel.HEADING_1, + alignment: AlignmentType.CENTER, + }), + new Paragraph({ + text: "Ref. :", + style: "normalPara", + }), + new Paragraph({ + text: "Date :", + style: "normalPara", + }), + new Paragraph({ + text: "To,", + style: "normalPara", + }), + new Paragraph({ + text: "The Superindenting Engineer,(O &M)", + style: "normalPara", + }), + new Paragraph({ + text: "Sub : ", + style: "normalPara", + }), + new Paragraph({ + text: "Ref. : ", + style: "normalPara", + }), + new Paragraph({ + text: "Sir,", + style: "normalPara", + }), + new Paragraph({ + text: "BRIEF DESCRIPTION", + style: "normalPara", + }), + table, + new Paragraph(image1), + new Paragraph({ + text: "Test", + style: "normalPara2", + }), + new Paragraph(image2), + new Paragraph({ + text: "Test 2", + style: "normalPara2", + }), + ], }); -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { +Packer.toBuffer(doc).then((buffer) => { fs.writeFileSync("My Document.docx", buffer); }); diff --git a/demo/12-scaling-images.ts b/demo/12-scaling-images.ts new file mode 100644 index 0000000000..6de5f49b92 --- /dev/null +++ b/demo/12-scaling-images.ts @@ -0,0 +1,19 @@ +// Scaling images +// Import from 'docx' rather than '../build' if you install from npm +import * as fs from "fs"; +import { Document, Media, Packer, Paragraph } from "../build"; + +const doc = new Document(); + +const image = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 50, 50); +const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 100, 100); +const image3 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 250, 250); +const image4 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 400, 400); + +doc.addSection({ + children: [new Paragraph("Hello World"), new Paragraph(image), new Paragraph(image2), new Paragraph(image3), new Paragraph(image4)], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/13-xml-styles.ts b/demo/13-xml-styles.ts new file mode 100644 index 0000000000..1a4f60c24a --- /dev/null +++ b/demo/13-xml-styles.ts @@ -0,0 +1,32 @@ +// This example shows 3 styles using XML styles +// Import from 'docx' rather than '../build' if you install from npm +import * as fs from "fs"; +import { Document, HeadingLevel, Packer, Paragraph } from "../build"; + +const styles = fs.readFileSync("./demo/assets/custom-styles.xml", "utf-8"); +const doc = new Document({ + title: "Title", + externalStyles: styles, +}); + +doc.addSection({ + children: [ + new Paragraph({ + text: "Cool Heading Text", + heading: HeadingLevel.HEADING_1, + }), + new Paragraph({ + text: 'This is a custom named style from the template "MyFancyStyle"', + style: "MyFancyStyle", + }), + new Paragraph("Some normal text"), + new Paragraph({ + text: "MyFancyStyle again", + style: "MyFancyStyle", + }), + ], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/14-page-numbers.ts b/demo/14-page-numbers.ts new file mode 100644 index 0000000000..fc9a20169d --- /dev/null +++ b/demo/14-page-numbers.ts @@ -0,0 +1,37 @@ +// Page numbers +// Import from 'docx' rather than '../build' if you install from npm +import * as fs from "fs"; +import { AlignmentType, Document, Header, Packer, Paragraph, TextRun } from "../build"; + +const doc = new Document(); + +doc.addSection({ + headers: { + default: new Header({ + children: [ + new Paragraph({ + alignment: AlignmentType.RIGHT, + children: [new TextRun("My Title "), new TextRun("Page ").pageNumber()], + }), + ], + }), + first: new Header({ + children: [ + new Paragraph({ + alignment: AlignmentType.RIGHT, + children: [new TextRun("First Page Header "), new TextRun("Page ").pageNumber()], + }), + ], + }), + }, + children: [ + new Paragraph({ + text: "First Page", + }).pageBreak(), + new Paragraph("Second Page"), + ], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/demo15.ts b/demo/15-page-break-before.ts similarity index 50% rename from demo/demo15.ts rename to demo/15-page-break-before.ts index 5da6c826b5..bfb56fd7dd 100644 --- a/demo/demo15.ts +++ b/demo/15-page-break-before.ts @@ -5,14 +5,16 @@ import { Document, Packer, Paragraph } from "../build"; const doc = new Document(); -const paragraph = new Paragraph("Hello World"); -const paragraph2 = new Paragraph("Hello World on another page").pageBreakBefore(); +doc.addSection({ + children: [ + new Paragraph("Hello World"), + new Paragraph({ + text: "Hello World on another page", + pageBreakBefore: true, + }), + ], +}); -doc.addParagraph(paragraph); -doc.addParagraph(paragraph2); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { +Packer.toBuffer(doc).then((buffer) => { fs.writeFileSync("My Document.docx", buffer); }); diff --git a/demo/16-multiple-sections.ts b/demo/16-multiple-sections.ts new file mode 100644 index 0000000000..10e2098704 --- /dev/null +++ b/demo/16-multiple-sections.ts @@ -0,0 +1,112 @@ +// Multiple sections and headers +// Import from 'docx' rather than '../build' if you install from npm +import * as fs from "fs"; +import { Document, Footer, Header, Packer, PageNumberFormat, PageOrientation, Paragraph, TextRun } from "../build"; + +const doc = new Document(); + +doc.addSection({ + children: [new Paragraph("Hello World").pageBreak()], +}); + +doc.addSection({ + headers: { + default: new Header({ + children: [new Paragraph("First Default Header on another page")], + }), + }, + footers: { + default: new Footer({ + children: [new Paragraph("Footer on another page")], + }), + }, + properties: { + pageNumberStart: 1, + pageNumberFormatType: PageNumberFormat.DECIMAL, + }, + children: [new Paragraph("hello")], +}); + +doc.addSection({ + headers: { + default: new Header({ + children: [new Paragraph("Second Default Header on another page")], + }), + }, + footers: { + default: new Footer({ + children: [new Paragraph("Footer on another page")], + }), + }, + size: { + orientation: PageOrientation.LANDSCAPE, + }, + properties: { + pageNumberStart: 1, + pageNumberFormatType: PageNumberFormat.DECIMAL, + }, + children: [new Paragraph("hello in landscape")], +}); + +doc.addSection({ + headers: { + default: new Header({ + children: [ + new Paragraph({ + children: [new TextRun("Page number: ").pageNumber()], + }), + ], + }), + }, + size: { + orientation: PageOrientation.PORTRAIT, + }, + children: [new Paragraph("Page number in the header must be 2, because it continues from the previous section.")], +}); + +doc.addSection({ + headers: { + default: new Header({ + children: [ + new Paragraph({ + children: [new TextRun("Page number: ").pageNumber()], + }), + ], + }), + }, + properties: { + pageNumberFormatType: PageNumberFormat.UPPER_ROMAN, + orientation: PageOrientation.PORTRAIT, + }, + children: [ + new Paragraph( + "Page number in the header must be III, because it continues from the previous section, but is defined as upper roman.", + ), + ], +}); + +doc.addSection({ + headers: { + default: new Header({ + children: [ + new Paragraph({ + children: [new TextRun("Page number: ").pageNumber()], + }), + ], + }), + }, + size: { + orientation: PageOrientation.PORTRAIT, + }, + properties: { + pageNumberFormatType: PageNumberFormat.DECIMAL, + pageNumberStart: 25, + }, + children: [ + new Paragraph("Page number in the header must be 25, because it is defined to start at 25 and to be decimal in this section."), + ], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/demo17.ts b/demo/17-footnotes.ts similarity index 56% rename from demo/demo17.ts rename to demo/17-footnotes.ts index c48a2e67e8..3920d0dce8 100644 --- a/demo/demo17.ts +++ b/demo/17-footnotes.ts @@ -5,17 +5,13 @@ import { Document, Packer, Paragraph } from "../build"; const doc = new Document(); -const paragraph = new Paragraph("Hello World").referenceFootnote(1); -const paragraph2 = new Paragraph("Hello World").referenceFootnote(2); - -doc.addParagraph(paragraph); -doc.addParagraph(paragraph2); +doc.addSection({ + children: [new Paragraph("Hello World").referenceFootnote(1), new Paragraph("Hello World").referenceFootnote(2)], +}); doc.createFootnote(new Paragraph("Test")); doc.createFootnote(new Paragraph("My amazing reference")); -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { +Packer.toBuffer(doc).then((buffer) => { fs.writeFileSync("My Document.docx", buffer); }); diff --git a/demo/demo18.ts b/demo/18-image-from-buffer.ts similarity index 92% rename from demo/demo18.ts rename to demo/18-image-from-buffer.ts index 4a61488c1f..146b1b421f 100644 --- a/demo/demo18.ts +++ b/demo/18-image-from-buffer.ts @@ -1,17 +1,22 @@ // Insert image from a buffer // Import from 'docx' rather than '../build' if you install from npm import * as fs from "fs"; -import { Document, Packer } from "../build"; +import { Document, Media, Packer, Paragraph } from "../build"; const doc = new Document(); const imageBase64Data = `iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAMAAAD04JH5AAACzVBMVEUAAAAAAAAAAAAAAAA/AD8zMzMqKiokJCQfHx8cHBwZGRkuFxcqFSonJyckJCQiIiIfHx8eHh4cHBwoGhomGSYkJCQhISEfHx8eHh4nHR0lHBwkGyQjIyMiIiIgICAfHx8mHh4lHh4kHR0jHCMiGyIhISEgICAfHx8lHx8kHh4jHR0hHCEhISEgICAlHx8kHx8jHh4jHh4iHSIhHCEhISElICAkHx8jHx8jHh4iHh4iHSIhHSElICAkICAjHx8jHx8iHh4iHh4hHiEhHSEkICAjHx8iHx8iHx8hHh4hHiEkHSEjHSAjHx8iHx8iHx8hHh4kHiEkHiEjHSAiHx8hHx8hHh4kHiEjHiAjHSAiHx8iHx8hHx8kHh4jHiEjHiAjHiAiICAiHx8kHx8jHh4jHiEjHiAiHiAiHSAiHx8jHx8jHx8jHiAiHiAiHiAiHSAiHx8jHx8jHx8iHiAiHiAiHiAjHx8jHx8jHx8jHx8iHiAiHiAiHiAjHx8jHx8jHx8iHx8iHSAiHiAjHiAjHx8jHx8hHx8iHx8iHyAiHiAjHiAjHiAjHh4hHx8iHx8iHx8iHyAjHSAjHiAjHiAjHh4hHx8iHx8iHx8jHyAjHiAhHh4iHx8iHx8jHyAjHSAjHSAhHiAhHh4iHx8iHx8jHx8jHyAjHSAjHSAiHh4iHh4jHx8jHx8jHyAjHyAhHSAhHSAiHh4iHh4jHx8jHx8jHyAhHyAhHSAiHSAiHh4jHh4jHx8jHx8jHyAhHyAhHSAiHSAjHR4jHh4jHx8jHx8hHyAhHyAiHSAjHSAjHR4jHh4jHx8hHx8hHyAhHyAiHyAjHSAjHR4jHR4hHh4hHx8hHyAiHyAjHyAjHSAjHR4jHR4hHh4hHx8hHyAjHyAjHyAjHSAjHR4hHR4hHR4hHx8iHyAjHyAjHyAjHSAhHR4hHR4hHR4hHx8jHyAjHyAjHyAjHyC9S2xeAAAA7nRSTlMAAQIDBAUGBwgJCgsMDQ4PEBESExQVFxgZGhscHR4fICEiIyQlJicoKSorLS4vMDEyMzQ1Njc4OTo7PD0+P0BBQkNERUZISUpLTE1OUFFSU1RVVllaW1xdXmBhYmNkZWZnaGprbG1ub3Byc3R1dnd4eXp8fn+AgYKDhIWGiImKi4yNj5CRkpOUlZaXmJmam5ydnp+goaKjpKaoqqusra6vsLGys7S1tri5uru8vb6/wMHCw8TFxsfIycrLzM3Oz9DR0tPU1dbX2Nna29zd3t/g4eLj5OXm5+jp6uvs7e7v8PHy8/T19vf4+fr7/P3+fkZpVQAABcBJREFUGBntwftjlQMcBvDnnLNL22qzJjWlKLHFVogyty3SiFq6EZliqZGyhnSxsLlMRahYoZKRFcul5dKFCatYqWZaNKvWtrPz/A2+7/b27qRzec/lPfvl/XxgMplMJpPJZDKZAtA9HJ3ppnIez0KnSdtC0RCNznHdJrbrh85wdSlVVRaEXuoGamYi5K5430HNiTiEWHKJg05eRWgNfKeV7RxbqUhGKPV/207VupQ8is0IoX5vtFC18SqEHaK4GyHTZ2kzVR8PBTCO4oANIZL4ShNVZcOhKKeYg9DoWdhI1ec3os2VFI0JCIUez5+i6st0qJZRrEAIJCw+QdW223BG/EmKwTBc/IJ/qfp2FDrkUnwFo8U9dZyqnaPhxLqfYjyM1S3vb6p+GGOBszsojoTDSDFz6qj66R4LzvYJxVMwUNRjf1H1ywQr/megg2RzLximy8waqvbda8M5iijegVEiHjlM1W/3h+FcXesphsMY4dMOUnUgOxyuPEzxPQwRNvV3qg5Nj4BreyimwADWe/dRVTMjEm6MoGLzGwtystL6RyOY3qSqdlYU3FpLZw1VW0sK5943MvUCKwJ1noNtjs6Ohge76Zq9ZkfpigU5WWkDYuCfbs1U5HWFR8/Qq4a9W0uK5k4ZmdrTCl8spGIePLPlbqqsc1Afe83O0hULc8alDYiBd7ZyitYMeBfR55rR2fOKP6ioPk2dGvZ+UVI0d8rtqT2tcCexlqK2F3wRn5Q+YVbBqrLKOupkr9lZujAOrmS0UpTb4JeIPkNHZ+cXr6uoPk2vyuBSPhWLEKj45PQJuQWryyqP0Z14uGLdROHIRNBEXDR09EP5r62rOHCazhrD4VKPwxTH+sIA3ZPTJ+YuWV22n+IruHFDC8X2CBjnPoolcGc2FYUwzmsUWXDHsoGKLBhmN0VvuBVfTVE/AAbpaid5CB4MbaLY1QXGuIViLTyZQcVyGGMuxWPwaA0Vk2GI9RRp8Ci2iuLkIBjhT5LNUfAspZFiTwyC72KK7+DNg1SsRvCNp3gZXq2k4iEEXSHFJHgVXUlxejCCbTvFAHiXdIJiXxyCK7KJ5FHoMZGK9xBcwyg2QpdlVMxEUM2iyIMuXXZQNF+HswxMsSAAJRQjoE//eoqDCXBSTO6f1xd+O0iyNRY6jaWi1ALNYCocZROj4JdEikroVkjFk9DcStXxpdfCD2MoXodu4RUU9ptxxmXssOfxnvDVcxRTod9FxyhqLoAqis5aPhwTDp9spRgEH2Q6KLbYoKqlaKTm6Isp0C/sJMnjFvhiERXPQvUNRe9p29lhR04CdBpC8Sl8YiuncIxEuzUUg4Dkgj+paVozygY9plPMh28SaymO9kabAopREGF3vt9MzeFFl8G7lRSZ8FFGK8XX4VA8QjEd7XrM3M0OXz8YCy+qKBLgq3wqnofiTorF0Ax56Rg1J1elW+BBAsVe+My6iYq7IK6keBdOIseV2qn5Pb8f3MqkWAXf9ThM8c8lAOIotuFsF875lRrH5klRcG0+xcPwQ1oLxfeRAP4heQTnGL78X2rqlw2DK59SXAV/zKaiGMAuko5InCt68mcOan5+ohf+z1pP8lQY/GHZQMV4YD3FpXDp4qerqbF/lBWBswyi+AL+ia+maLgcRRQj4IYlY/UpauqKBsPJAxQF8NM1TRQ/RudSPAD34rK3scOuR8/HGcspxsJfOVS8NZbiGXiUtPgINU3v3WFDmx8pEuG3EiqKKVbCC1vm2iZqap5LAtCtleQf8F9sFYWDohzeJczYyQ4V2bEZFGsQgJRGqqqhS2phHTWn9lDkIhBTqWqxQZ+IsRvtdHY9AvI2VX2hW68nfqGmuQsCEl3JdjfCF8OW1bPdtwhQ0gm2mQzfRE3a7KCYj0BNZJs8+Kxf/r6WtTEI2FIqlsMfFgRB5A6KUnSe/vUkX0AnuvUIt8SjM1m6wWQymUwmk8lkMgXRf5vi8rLQxtUhAAAAAElFTkSuQmCC`; -// doc.createImage(Buffer.from(imageBase64Data, 'base64')); -doc.createImage(Buffer.from(imageBase64Data, "base64"), 100, 100); +const image = Media.addImage(doc, Buffer.from(imageBase64Data, "base64"), 100, 100); -const packer = new Packer(); +doc.addSection({ + children: [ + new Paragraph({ + children: [image], + }), + ], +}); -packer.toBuffer(doc).then((buffer) => { +Packer.toBuffer(doc).then((buffer) => { fs.writeFileSync("My Document.docx", buffer); }); diff --git a/demo/19-export-to-base64.ts b/demo/19-export-to-base64.ts new file mode 100644 index 0000000000..676d844c8d --- /dev/null +++ b/demo/19-export-to-base64.ts @@ -0,0 +1,28 @@ +// Export to base64 string - Useful in a browser environment. +// 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(); + +doc.addSection({ + children: [ + new Paragraph({ + children: [ + new TextRun("Hello World"), + new TextRun({ + text: "Foo", + bold: true, + }), + new TextRun({ + text: "Bar", + bold: true, + }).tab(), + ], + }), + ], +}); + +Packer.toBase64String(doc).then((str) => { + fs.writeFileSync("My Document.docx", str); +}); diff --git a/demo/2-declaritive-styles.ts b/demo/2-declaritive-styles.ts new file mode 100644 index 0000000000..a854b04546 --- /dev/null +++ b/demo/2-declaritive-styles.ts @@ -0,0 +1,122 @@ +// Example on how to customise the look at feel using Styles +// 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({ + creator: "Clippy", + title: "Sample Document", + description: "A brief example of using docx", +}); + +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({ + children: [ + new Paragraph({ + text: "Test heading1, bold and italicized", + heading: HeadingLevel.HEADING_1, + }), + new Paragraph("Some simple content"), + new Paragraph({ + text: "Test heading2 with double red underline", + heading: HeadingLevel.HEADING_2, + }), + new Paragraph({ + text: "Option1", + numbering: { + num: letterNumbering, + level: 0, + }, + }), + new Paragraph({ + text: "Option5 -- override 2 to 5", + numbering: { + num: letterNumbering, + level: 0, + }, + }), + new Paragraph({ + text: "Option3", + numbering: { + num: letterNumbering, + level: 0, + }, + }), + new Paragraph({}).addRun( + new TextRun({ + text: "Some monospaced content", + font: { + name: "Monospace", + }, + }), + ), + new Paragraph({ + text: "An aside, in light gray italics and indented", + style: "aside", + }), + new Paragraph({ + text: "This is normal, but well-spaced text", + style: "wellSpaced", + }), + new Paragraph({ + children: [ + new TextRun({ + text: "This is a bold run,", + bold: true, + }), + new TextRun(" switching to normal "), + new TextRun({ + text: "and then underlined ", + underline: {}, + }), + new TextRun({ + text: "and back to normal.", + }), + ], + }), + ], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/demo20.ts b/demo/20-table-cell-borders.ts similarity index 70% rename from demo/demo20.ts rename to demo/20-table-cell-borders.ts index d80d23913b..13809a6164 100644 --- a/demo/demo20.ts +++ b/demo/20-table-cell-borders.ts @@ -1,24 +1,24 @@ // Add custom borders to table cell // Import from 'docx' rather than '../build' if you install from npm import * as fs from "fs"; -import { BorderStyle, Document, Packer, Paragraph } from "../build"; +import { BorderStyle, Document, Packer, Paragraph, Table } from "../build"; const doc = new Document(); -const table = doc.createTable({ +const table = new Table({ rows: 4, columns: 4, }); + +doc.addSection({ children: [table] }); table .getCell(2, 2) - .addParagraph(new Paragraph("Hello")) + .add(new Paragraph("Hello")) .Borders.addTopBorder(BorderStyle.DASH_DOT_STROKED, 3, "red") .addBottomBorder(BorderStyle.DOUBLE, 3, "blue") .addStartBorder(BorderStyle.DOT_DOT_DASH, 3, "green") .addEndBorder(BorderStyle.DOT_DOT_DASH, 3, "#ff8000"); -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { +Packer.toBuffer(doc).then((buffer) => { fs.writeFileSync("My Document.docx", buffer); }); diff --git a/demo/demo21.ts b/demo/21-bookmarks.ts similarity index 77% rename from demo/demo21.ts rename to demo/21-bookmarks.ts index b02da56065..7a8e7b523b 100644 --- a/demo/demo21.ts +++ b/demo/21-bookmarks.ts @@ -1,9 +1,9 @@ // 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 * as fs from "fs"; -import { Document, Packer } from "../build"; +import { Document, HeadingLevel, Packer, Paragraph } from "../build"; -const loremIpsum = +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."; const doc = new Document({ @@ -16,22 +16,20 @@ const anchorId = "anchorID"; // First create the bookmark const bookmark = doc.createBookmark(anchorId, "Lorem Ipsum"); -// That has header styling -doc - .createParagraph() - .addBookmark(bookmark) - .heading1(); -doc.createParagraph("\n"); - -doc.createParagraph(loremIpsum); -doc.createParagraph().pageBreak(); - -// Now the link back up to the bookmark const hyperlink = doc.createInternalHyperLink(anchorId, `Click me!`); -doc.createParagraph().addHyperLink(hyperlink); -const packer = new Packer(); +doc.addSection({ + children: [ + new Paragraph({ + heading: HeadingLevel.HEADING_1, + }).addBookmark(bookmark), + new Paragraph("\n"), + new Paragraph(LOREM_IPSUM), + new Paragraph({}).pageBreak(), + new Paragraph({}).addHyperLink(hyperlink), + ], +}); -packer.toBuffer(doc).then((buffer) => { +Packer.toBuffer(doc).then((buffer) => { fs.writeFileSync("My Document.docx", buffer); }); diff --git a/demo/22-right-to-left-text.ts b/demo/22-right-to-left-text.ts new file mode 100644 index 0000000000..2c3984fb46 --- /dev/null +++ b/demo/22-right-to-left-text.ts @@ -0,0 +1,44 @@ +// This demo shows right to left for special languages +// 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(); + +doc.addSection({ + children: [ + new Paragraph({ + bidirectional: true, + children: [ + new TextRun({ + text: "שלום עולם", + rightToLeft: true, + }), + ], + }), + new Paragraph({ + bidirectional: true, + children: [ + new TextRun({ + text: "שלום עולם", + bold: true, + rightToLeft: true, + }), + ], + }), + new Paragraph({ + bidirectional: true, + children: [ + new TextRun({ + text: "שלום עולם", + italics: true, + rightToLeft: true, + }), + ], + }), + ], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/demo23.ts b/demo/23-base64-images.ts similarity index 89% rename from demo/demo23.ts rename to demo/23-base64-images.ts index 2e230e0cb7..c927ba45ef 100644 --- a/demo/demo23.ts +++ b/demo/23-base64-images.ts @@ -1,13 +1,10 @@ // This demo adds an image to the Media cache, and then insert to the document afterwards // Import from 'docx' rather than '../build' if you install from npm import * as fs from "fs"; -import { Document, Media, Packer, Paragraph } from "../build"; +import { Document, Media, Packer, Paragraph, TextRun } from "../build"; const doc = new Document(); -const paragraph = new Paragraph("Hello World"); -doc.addParagraph(paragraph); - const image = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg")); const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/dog.png")); const image3 = Media.addImage(doc, fs.readFileSync("./demo/images/cat.jpg")); @@ -17,18 +14,19 @@ const image5 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif")); const imageBase64Data = `iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAMAAAD04JH5AAACzVBMVEUAAAAAAAAAAAAAAAA/AD8zMzMqKiokJCQfHx8cHBwZGRkuFxcqFSonJyckJCQiIiIfHx8eHh4cHBwoGhomGSYkJCQhISEfHx8eHh4nHR0lHBwkGyQjIyMiIiIgICAfHx8mHh4lHh4kHR0jHCMiGyIhISEgICAfHx8lHx8kHh4jHR0hHCEhISEgICAlHx8kHx8jHh4jHh4iHSIhHCEhISElICAkHx8jHx8jHh4iHh4iHSIhHSElICAkICAjHx8jHx8iHh4iHh4hHiEhHSEkICAjHx8iHx8iHx8hHh4hHiEkHSEjHSAjHx8iHx8iHx8hHh4kHiEkHiEjHSAiHx8hHx8hHh4kHiEjHiAjHSAiHx8iHx8hHx8kHh4jHiEjHiAjHiAiICAiHx8kHx8jHh4jHiEjHiAiHiAiHSAiHx8jHx8jHx8jHiAiHiAiHiAiHSAiHx8jHx8jHx8iHiAiHiAiHiAjHx8jHx8jHx8jHx8iHiAiHiAiHiAjHx8jHx8jHx8iHx8iHSAiHiAjHiAjHx8jHx8hHx8iHx8iHyAiHiAjHiAjHiAjHh4hHx8iHx8iHx8iHyAjHSAjHiAjHiAjHh4hHx8iHx8iHx8jHyAjHiAhHh4iHx8iHx8jHyAjHSAjHSAhHiAhHh4iHx8iHx8jHx8jHyAjHSAjHSAiHh4iHh4jHx8jHx8jHyAjHyAhHSAhHSAiHh4iHh4jHx8jHx8jHyAhHyAhHSAiHSAiHh4jHh4jHx8jHx8jHyAhHyAhHSAiHSAjHR4jHh4jHx8jHx8hHyAhHyAiHSAjHSAjHR4jHh4jHx8hHx8hHyAhHyAiHyAjHSAjHR4jHR4hHh4hHx8hHyAiHyAjHyAjHSAjHR4jHR4hHh4hHx8hHyAjHyAjHyAjHSAjHR4hHR4hHR4hHx8iHyAjHyAjHyAjHSAhHR4hHR4hHR4hHx8jHyAjHyAjHyAjHyC9S2xeAAAA7nRSTlMAAQIDBAUGBwgJCgsMDQ4PEBESExQVFxgZGhscHR4fICEiIyQlJicoKSorLS4vMDEyMzQ1Njc4OTo7PD0+P0BBQkNERUZISUpLTE1OUFFSU1RVVllaW1xdXmBhYmNkZWZnaGprbG1ub3Byc3R1dnd4eXp8fn+AgYKDhIWGiImKi4yNj5CRkpOUlZaXmJmam5ydnp+goaKjpKaoqqusra6vsLGys7S1tri5uru8vb6/wMHCw8TFxsfIycrLzM3Oz9DR0tPU1dbX2Nna29zd3t/g4eLj5OXm5+jp6uvs7e7v8PHy8/T19vf4+fr7/P3+fkZpVQAABcBJREFUGBntwftjlQMcBvDnnLNL22qzJjWlKLHFVogyty3SiFq6EZliqZGyhnSxsLlMRahYoZKRFcul5dKFCatYqWZaNKvWtrPz/A2+7/b27qRzec/lPfvl/XxgMplMJpPJZDKZAtA9HJ3ppnIez0KnSdtC0RCNznHdJrbrh85wdSlVVRaEXuoGamYi5K5430HNiTiEWHKJg05eRWgNfKeV7RxbqUhGKPV/207VupQ8is0IoX5vtFC18SqEHaK4GyHTZ2kzVR8PBTCO4oANIZL4ShNVZcOhKKeYg9DoWdhI1ec3os2VFI0JCIUez5+i6st0qJZRrEAIJCw+QdW223BG/EmKwTBc/IJ/qfp2FDrkUnwFo8U9dZyqnaPhxLqfYjyM1S3vb6p+GGOBszsojoTDSDFz6qj66R4LzvYJxVMwUNRjf1H1ywQr/megg2RzLximy8waqvbda8M5iijegVEiHjlM1W/3h+FcXesphsMY4dMOUnUgOxyuPEzxPQwRNvV3qg5Nj4BreyimwADWe/dRVTMjEm6MoGLzGwtystL6RyOY3qSqdlYU3FpLZw1VW0sK5943MvUCKwJ1noNtjs6Ohge76Zq9ZkfpigU5WWkDYuCfbs1U5HWFR8/Qq4a9W0uK5k4ZmdrTCl8spGIePLPlbqqsc1Afe83O0hULc8alDYiBd7ZyitYMeBfR55rR2fOKP6ioPk2dGvZ+UVI0d8rtqT2tcCexlqK2F3wRn5Q+YVbBqrLKOupkr9lZujAOrmS0UpTb4JeIPkNHZ+cXr6uoPk2vyuBSPhWLEKj45PQJuQWryyqP0Z14uGLdROHIRNBEXDR09EP5r62rOHCazhrD4VKPwxTH+sIA3ZPTJ+YuWV22n+IruHFDC8X2CBjnPoolcGc2FYUwzmsUWXDHsoGKLBhmN0VvuBVfTVE/AAbpaid5CB4MbaLY1QXGuIViLTyZQcVyGGMuxWPwaA0Vk2GI9RRp8Ci2iuLkIBjhT5LNUfAspZFiTwyC72KK7+DNg1SsRvCNp3gZXq2k4iEEXSHFJHgVXUlxejCCbTvFAHiXdIJiXxyCK7KJ5FHoMZGK9xBcwyg2QpdlVMxEUM2iyIMuXXZQNF+HswxMsSAAJRQjoE//eoqDCXBSTO6f1xd+O0iyNRY6jaWi1ALNYCocZROj4JdEikroVkjFk9DcStXxpdfCD2MoXodu4RUU9ptxxmXssOfxnvDVcxRTod9FxyhqLoAqis5aPhwTDp9spRgEH2Q6KLbYoKqlaKTm6Isp0C/sJMnjFvhiERXPQvUNRe9p29lhR04CdBpC8Sl8YiuncIxEuzUUg4Dkgj+paVozygY9plPMh28SaymO9kabAopREGF3vt9MzeFFl8G7lRSZ8FFGK8XX4VA8QjEd7XrM3M0OXz8YCy+qKBLgq3wqnofiTorF0Ax56Rg1J1elW+BBAsVe+My6iYq7IK6keBdOIseV2qn5Pb8f3MqkWAXf9ThM8c8lAOIotuFsF875lRrH5klRcG0+xcPwQ1oLxfeRAP4heQTnGL78X2rqlw2DK59SXAV/zKaiGMAuko5InCt68mcOan5+ohf+z1pP8lQY/GHZQMV4YD3FpXDp4qerqbF/lBWBswyi+AL+ia+maLgcRRQj4IYlY/UpauqKBsPJAxQF8NM1TRQ/RudSPAD34rK3scOuR8/HGcspxsJfOVS8NZbiGXiUtPgINU3v3WFDmx8pEuG3EiqKKVbCC1vm2iZqap5LAtCtleQf8F9sFYWDohzeJczYyQ4V2bEZFGsQgJRGqqqhS2phHTWn9lDkIhBTqWqxQZ+IsRvtdHY9AvI2VX2hW68nfqGmuQsCEl3JdjfCF8OW1bPdtwhQ0gm2mQzfRE3a7KCYj0BNZJs8+Kxf/r6WtTEI2FIqlsMfFgRB5A6KUnSe/vUkX0AnuvUIt8SjM1m6wWQymUwmk8lkMgXRf5vi8rLQxtUhAAAAAElFTkSuQmCC`; const image6 = Media.addImage(doc, Buffer.from(imageBase64Data, "base64"), 100, 100); -// I am adding an image to the paragraph rather than the document to make the image inline -paragraph.addImage(image5); +doc.addSection({ + children: [ + new Paragraph({ + children: [new TextRun("Hello World"), image5], + }), + new Paragraph(image), + new Paragraph(image2), + new Paragraph(image3), + new Paragraph(image4), + new Paragraph(image6), + ], +}); -doc.addImage(image); -doc.addImage(image2); -doc.addImage(image3); -doc.addImage(image4); -doc.addImage(image5); -doc.addImage(image6); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { +Packer.toBuffer(doc).then((buffer) => { fs.writeFileSync("My Document.docx", buffer); }); diff --git a/demo/demo24.ts b/demo/24-images-to-table-cell.ts similarity index 53% rename from demo/demo24.ts rename to demo/24-images-to-table-cell.ts index 831a4c29a8..114be5491e 100644 --- a/demo/demo24.ts +++ b/demo/24-images-to-table-cell.ts @@ -1,21 +1,24 @@ // Add image to table cell // Import from 'docx' rather than '../build' if you install from npm import * as fs from "fs"; -import { Document, Media, Packer, Paragraph } from "../build"; +import { Document, Media, Packer, Paragraph, Table } from "../build"; const doc = new Document(); -const table = doc.createTable({ +const table = new Table({ rows: 4, columns: 4, }); -table.getCell(2, 2).addParagraph(new Paragraph("Hello")); + +doc.addSection({ + children: [table], +}); + +table.getCell(2, 2).add(new Paragraph("Hello")); const image = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg")); -table.getCell(1, 1).addParagraph(image.Paragraph); +table.getCell(1, 1).add(new Paragraph(image)); -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { +Packer.toBuffer(doc).then((buffer) => { fs.writeFileSync("My Document.docx", buffer); }); diff --git a/demo/26-paragraph-borders.ts b/demo/26-paragraph-borders.ts new file mode 100644 index 0000000000..40057d756a --- /dev/null +++ b/demo/26-paragraph-borders.ts @@ -0,0 +1,33 @@ +// Creates two paragraphs, one with a border and one without +// Import from 'docx' rather than '../build' if you install from npm +import * as fs from "fs"; +import { Document, Packer, Paragraph } from "../build"; + +const doc = new Document(); + +doc.addSection({ + children: [ + new Paragraph("No border!"), + new Paragraph({ + text: "I have borders on my top and bottom sides!", + border: { + top: { + color: "auto", + space: 1, + value: "single", + size: 6, + }, + bottom: { + color: "auto", + space: 1, + value: "single", + size: 6, + }, + }, + }), + ], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/27-declaritive-styles-3.ts b/demo/27-declaritive-styles-3.ts new file mode 100644 index 0000000000..31994dfe4a --- /dev/null +++ b/demo/27-declaritive-styles-3.ts @@ -0,0 +1,42 @@ +// Custom styles using JavaScript configuration +// 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(); + +// The first argument is an ID you use to apply the style to paragraphs +// The second argument is a human-friendly name to show in the UI +doc.Styles.createParagraphStyle("myWonkyStyle", "My Wonky Style") + .basedOn("Normal") + .next("Normal") + .color("990000") + .italics() + .indent({ left: 720 }) // 720 TWIP === 720 / 20 pt === .5 in + .spacing({ line: 276 }); // 276 / 240 = 1.15x line spacing + +doc.Styles.createParagraphStyle("Heading2", "Heading 2") + .basedOn("Normal") + .next("Normal") + .quickFormat() + .size(26) // 26 half-points === 13pt font + .bold() + .underline("double", "FF0000") + .spacing({ before: 240, after: 120 }); // TWIP for both + +doc.addSection({ + children: [ + new Paragraph({ + text: "Hello", + style: "myWonkyStyle", + }), + new Paragraph({ + text: "World", + heading: HeadingLevel.HEADING_2, + }), + ], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/28-table-of-contents.ts b/demo/28-table-of-contents.ts new file mode 100644 index 0000000000..83160b0177 --- /dev/null +++ b/demo/28-table-of-contents.ts @@ -0,0 +1,56 @@ +// Table of contents +// Import from 'docx' rather than '../build' if you install from npm +import * as fs from "fs"; +import { File, HeadingLevel, Packer, Paragraph, StyleLevel, TableOfContents } from "../build"; + +const doc = new File(); + +// The first argument is an ID you use to apply the style to paragraphs +// The second argument is a human-friendly name to show in the UI +doc.Styles.createParagraphStyle("MySpectacularStyle", "My Spectacular Style") + .basedOn("Heading1") + .next("Heading1") + .color("990000") + .italics(); + +// WordprocessingML docs for TableOfContents can be found here: +// http://officeopenxml.com/WPtableOfContents.php + +// Let's define the properties for generate a TOC for heading 1-5 and MySpectacularStyle, +// making the entries be hyperlinks for the paragraph + +doc.addSection({ + children: [ + new TableOfContents("Summary", { + hyperlink: true, + headingStyleRange: "1-5", + stylesWithLevels: [new StyleLevel("MySpectacularStyle", 1)], + }), + new Paragraph({ + text: "Header #1", + heading: HeadingLevel.HEADING_1, + pageBreakBefore: true, + }), + new Paragraph("I'm a little text very nicely written.'"), + new Paragraph({ + text: "Header #2", + heading: HeadingLevel.HEADING_1, + pageBreakBefore: true, + }), + new Paragraph("I'm a other text very nicely written.'"), + new Paragraph({ + text: "Header #2.1", + heading: HeadingLevel.HEADING_2, + }), + new Paragraph("I'm a another text very nicely written.'"), + new Paragraph({ + text: "My Spectacular Style #1", + style: "MySpectacularStyle", + pageBreakBefore: true, + }), + ], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/29-numbered-lists.ts b/demo/29-numbered-lists.ts new file mode 100644 index 0000000000..740320e5f8 --- /dev/null +++ b/demo/29-numbered-lists.ts @@ -0,0 +1,66 @@ +// Numbered lists +// Import from 'docx' rather than '../build' if you install from npm +import * as fs from "fs"; +import { Document, Numbering, Packer, Paragraph } from "../build"; + +const doc = new Document(); + +const numbering = new Numbering(); + +const abstractNum = numbering.createAbstractNumbering(); +abstractNum.createLevel(0, "upperRoman", "%1", "start").indent({ left: 720, hanging: 260 }); + +const concrete = numbering.createConcreteNumbering(abstractNum); + +doc.addSection({ + children: [ + new Paragraph({ + text: "line with contextual spacing", + numbering: { + num: concrete, + level: 0, + }, + contextualSpacing: true, + spacing: { + before: 200, + }, + }), + new Paragraph({ + text: "line with contextual spacing", + numbering: { + num: concrete, + level: 0, + }, + contextualSpacing: true, + spacing: { + before: 200, + }, + }), + new Paragraph({ + text: "line without contextual spacing", + numbering: { + num: concrete, + level: 0, + }, + contextualSpacing: false, + spacing: { + before: 200, + }, + }), + new Paragraph({ + text: "line without contextual spacing", + numbering: { + num: concrete, + level: 0, + }, + contextualSpacing: false, + spacing: { + before: 200, + }, + }), + ], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/3-numbering-and-bullet-points.ts b/demo/3-numbering-and-bullet-points.ts new file mode 100644 index 0000000000..94d5665568 --- /dev/null +++ b/demo/3-numbering-and-bullet-points.ts @@ -0,0 +1,76 @@ +// Numbering and bullet points example +// Import from 'docx' rather than '../build' if you install from npm +import * as fs from "fs"; +import { Document, Numbering, Packer, Paragraph } from "../build"; + +const doc = new Document(); + +const numbering = new Numbering(); + +const abstractNum = numbering.createAbstractNumbering(); +abstractNum.createLevel(0, "upperRoman", "%1", "start").indent({ left: 720, hanging: 260 }); +abstractNum.createLevel(1, "decimal", "%2.", "start").indent({ left: 1440, hanging: 980 }); +abstractNum.createLevel(2, "lowerLetter", "%3)", "start").indent({ left: 14402160, hanging: 1700 }); + +const concrete = numbering.createConcreteNumbering(abstractNum); + +doc.addSection({ + children: [ + new Paragraph({ + text: "Hey you", + numbering: { + num: concrete, + level: 0, + }, + }), + new Paragraph({ + text: "What's up fam", + numbering: { + num: concrete, + level: 1, + }, + }), + new Paragraph({ + text: "Hello World 2", + numbering: { + num: concrete, + level: 1, + }, + }), + new Paragraph({ + text: "Yeah boi", + numbering: { + num: concrete, + level: 2, + }, + }), + new Paragraph({ + text: "Hey you", + bullet: { + level: 0, + }, + }), + new Paragraph({ + text: "What's up fam", + bullet: { + level: 1, + }, + }), + new Paragraph({ + text: "Hello World 2", + bullet: { + level: 2, + }, + }), + new Paragraph({ + text: "Yeah boi", + bullet: { + level: 3, + }, + }), + ], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/demo30.ts b/demo/30-template-document.ts similarity index 61% rename from demo/demo30.ts rename to demo/30-template-document.ts index ad7867a9c0..3b3c724b5c 100644 --- a/demo/demo30.ts +++ b/demo/30-template-document.ts @@ -12,19 +12,18 @@ fs.readFile(filePath, (err, data) => { } importDotx.extract(data).then((templateDocument) => { - // This any needs fixing - const sectionProps = { - titlePage: templateDocument.titlePageIsDefined, - } as any; - - const doc = new Document(undefined, sectionProps, { + const doc = new Document(undefined, { template: templateDocument, }); - const paragraph = new Paragraph("Hello World"); - doc.addParagraph(paragraph); - const packer = new Packer(); - packer.toBuffer(doc).then((buffer) => { + doc.addSection({ + properties: { + titlePage: templateDocument.titlePageIsDefined, + }, + children: [new Paragraph("Hello World")], + }); + + Packer.toBuffer(doc).then((buffer) => { fs.writeFileSync("My Document.docx", buffer); }); }); diff --git a/demo/demo31.ts b/demo/31-tables.ts similarity index 55% rename from demo/demo31.ts rename to demo/31-tables.ts index e05a20f454..050403bb99 100644 --- a/demo/demo31.ts +++ b/demo/31-tables.ts @@ -1,29 +1,32 @@ // 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 * as fs from "fs"; -import { Document, Packer, Paragraph, VerticalAlign } from "../build"; +import { Document, HeadingLevel, Packer, Paragraph, Table, VerticalAlign } from "../build"; const doc = new Document(); -const table = doc.createTable({ +const table = new Table({ rows: 2, columns: 2, }); + table .getCell(1, 1) - .addParagraph(new Paragraph("This text should be in the middle of the cell")) + .add(new Paragraph("This text should be in the middle of the cell")) .setVerticalAlign(VerticalAlign.CENTER); -table - .getCell(1, 0) - .addParagraph( - new Paragraph( +table.getCell(1, 0).add( + new Paragraph({ + text: "Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah", - ).heading1(), - ); + heading: HeadingLevel.HEADING_1, + }), +); -const packer = new Packer(); +doc.addSection({ + children: [table], +}); -packer.toBuffer(doc).then((buffer) => { +Packer.toBuffer(doc).then((buffer) => { fs.writeFileSync("My Document.docx", buffer); }); diff --git a/demo/demo32.ts b/demo/32-merge-table-cells.ts similarity index 58% rename from demo/demo32.ts rename to demo/32-merge-table-cells.ts index 7196058ec0..cd850067e5 100644 --- a/demo/demo32.ts +++ b/demo/32-merge-table-cells.ts @@ -1,30 +1,29 @@ // Example of how you would merge cells together // Import from 'docx' rather than '../build' if you install from npm import * as fs from "fs"; -import { Document, Packer, Paragraph, ShadingType, WidthType } from "../build"; +import { Document, HeadingLevel, Packer, Paragraph, ShadingType, Table, WidthType } from "../build"; const doc = new Document(); -let table = doc.createTable({ +const table = new Table({ rows: 2, columns: 2, }); -table.getCell(0, 0).addParagraph(new Paragraph("Hello")); +table.getCell(0, 0).add(new Paragraph("Hello")); table.getRow(0).mergeCells(0, 1); -doc.createParagraph("Another table").heading2(); - -table = doc.createTable({ +const table2 = new Table({ rows: 2, columns: 3, width: 100, widthUnitType: WidthType.AUTO, columnWidths: [1000, 1000, 1000], }); -table + +table2 .getCell(0, 0) - .addParagraph(new Paragraph("World")) + .add(new Paragraph("World")) .setMargins({ top: 1000, bottom: 1000, @@ -33,9 +32,7 @@ table }); table.getRow(0).mergeCells(0, 2); -doc.createParagraph("Another table").heading2(); - -table = doc.createTable({ +const table3 = new Table({ rows: 2, columns: 4, width: 7000, @@ -47,55 +44,70 @@ table = doc.createTable({ left: 400, }, }); -table.getCell(0, 0).addParagraph(new Paragraph("Foo")); -table.getCell(0, 1).addParagraph(new Paragraph("v")); -table +table3.getCell(0, 0).add(new Paragraph("Foo")); +table3.getCell(0, 1).add(new Paragraph("v")); + +table3 .getCell(1, 0) - .addParagraph(new Paragraph("Bar1")) + .add(new Paragraph("Bar1")) .setShading({ fill: "b79c2f", val: ShadingType.REVERSE_DIAGONAL_STRIPE, color: "auto", }); -table +table3 .getCell(1, 1) - .addParagraph(new Paragraph("Bar2")) + .add(new Paragraph("Bar2")) .setShading({ fill: "42c5f4", val: ShadingType.PERCENT_95, color: "auto", }); -table +table3 .getCell(1, 2) - .addParagraph(new Paragraph("Bar3")) + .add(new Paragraph("Bar3")) .setShading({ fill: "880aa8", val: ShadingType.PERCENT_10, color: "e2df0b", }); -table +table3 .getCell(1, 3) - .addParagraph(new Paragraph("Bar4")) + .add(new Paragraph("Bar4")) .setShading({ fill: "FF0000", val: ShadingType.CLEAR, color: "auto", }); -table.getRow(0).mergeCells(0, 3); +table3.getRow(0).mergeCells(0, 3); -doc.createParagraph("hi"); - -doc.createTable({ +const table4 = new Table({ rows: 2, columns: 2, width: 100, widthUnitType: WidthType.PERCENTAGE, }); -const packer = new Packer(); +doc.addSection({ + children: [ + table, + new Paragraph({ + text: "Another table", + heading: HeadingLevel.HEADING_2, + }), + table2, + new Paragraph({ + text: "Another table", + heading: HeadingLevel.HEADING_2, + }), + table3, + new Paragraph("hi"), + table4, + ], +}); -packer.toBuffer(doc).then((buffer) => { +Packer.toBuffer(doc).then((buffer) => { fs.writeFileSync("My Document.docx", buffer); }); diff --git a/demo/33-sequential-captions.ts b/demo/33-sequential-captions.ts new file mode 100644 index 0000000000..c06c3aa1cc --- /dev/null +++ b/demo/33-sequential-captions.ts @@ -0,0 +1,31 @@ +// Sequential Captions +// 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(); + +doc.addSection({ + children: [ + new Paragraph("Hello World 1->") + .addSequentialIdentifier("Caption") + .addRun(new TextRun(" text after sequencial caption 2->")) + .addSequentialIdentifier("Caption"), + new Paragraph("Hello World 1->") + .addSequentialIdentifier("Label") + .addRun(new TextRun(" text after sequencial caption 2->")) + .addSequentialIdentifier("Label"), + new Paragraph("Hello World 1->") + .addSequentialIdentifier("Another") + .addRun(new TextRun(" text after sequencial caption 3->")) + .addSequentialIdentifier("Label"), + new Paragraph("Hello World 2->") + .addSequentialIdentifier("Another") + .addRun(new TextRun(" text after sequencial caption 4->")) + .addSequentialIdentifier("Label"), + ], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/demo34.ts b/demo/34-floating-tables.ts similarity index 61% rename from demo/demo34.ts rename to demo/34-floating-tables.ts index 0899f26bfe..c5b8a18cf8 100644 --- a/demo/demo34.ts +++ b/demo/34-floating-tables.ts @@ -1,11 +1,21 @@ // Example of how you would create a table with float positions // Import from 'docx' rather than '../build' if you install from npm import * as fs from "fs"; -import { Document, Packer, Paragraph, RelativeHorizontalPosition, RelativeVerticalPosition, TableAnchorType, WidthType } from "../build"; +import { + Document, + Packer, + Paragraph, + RelativeHorizontalPosition, + RelativeVerticalPosition, + Table, + TableAnchorType, + TableLayoutType, + WidthType, +} from "../build"; const doc = new Document(); -const table = doc.createTable({ +const table = new Table({ rows: 2, columns: 2, float: { @@ -16,14 +26,16 @@ const table = doc.createTable({ }, width: 4535, widthUnitType: WidthType.DXA, + layout: TableLayoutType.FIXED, }); -table.setFixedWidthLayout(); -table.getCell(0, 0).addParagraph(new Paragraph("Hello")); +table.getCell(0, 0).add(new Paragraph("Hello")); table.getRow(0).mergeCells(0, 1); -const packer = new Packer(); +doc.addSection({ + children: [table], +}); -packer.toBuffer(doc).then((buffer) => { +Packer.toBuffer(doc).then((buffer) => { fs.writeFileSync("My Document.docx", buffer); }); diff --git a/demo/demo35.ts b/demo/35-hyperlinks.ts similarity index 72% rename from demo/demo35.ts rename to demo/35-hyperlinks.ts index 05ef010c1a..c547d93b36 100644 --- a/demo/demo35.ts +++ b/demo/35-hyperlinks.ts @@ -4,15 +4,14 @@ import * as fs from "fs"; import { Document, Packer, Paragraph } from "../build"; const doc = new Document(); -const paragraph = new Paragraph(); +const paragraph = new Paragraph({}); const link = doc.createHyperlink("http://www.example.com", "Hyperlink"); -link.bold(); paragraph.addHyperLink(link); -doc.addParagraph(paragraph); +doc.addSection({ + children: [paragraph], +}); -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { +Packer.toBuffer(doc).then((buffer) => { fs.writeFileSync("My Document.docx", buffer); }); diff --git a/demo/36-image-to-table-cell.ts b/demo/36-image-to-table-cell.ts new file mode 100644 index 0000000000..1c7897c558 --- /dev/null +++ b/demo/36-image-to-table-cell.ts @@ -0,0 +1,27 @@ +// Add image to table cell +// Import from 'docx' rather than '../build' if you install from npm +import * as fs from "fs"; +import { Document, Header, Media, Packer, Paragraph, Table } from "../build"; + +const doc = new Document(); +const image = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg")); + +const table = new Table({ + rows: 2, + columns: 2, +}); +table.getCell(1, 1).add(new Paragraph(image)); + +// Adding same table in the body and in the header +doc.addSection({ + headers: { + default: new Header({ + children: [table], + }), + }, + children: [table], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/37-images-to-header-and-footer.ts b/demo/37-images-to-header-and-footer.ts new file mode 100644 index 0000000000..86a8a20218 --- /dev/null +++ b/demo/37-images-to-header-and-footer.ts @@ -0,0 +1,22 @@ +// Add images to header and footer +// Import from 'docx' rather than '../build' if you install from npm +import * as fs from "fs"; +import { Document, Header, Media, Packer, Paragraph } from "../build"; + +const doc = new Document(); +const image = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg")); +const image1 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif")); +const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg")); + +doc.addSection({ + headers: { + default: new Header({ + children: [new Paragraph(image), new Paragraph(image1), new Paragraph(image2)], + }), + }, + children: [new Paragraph("Hello World")], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/38-text-wrapping.ts b/demo/38-text-wrapping.ts new file mode 100644 index 0000000000..9dac048e52 --- /dev/null +++ b/demo/38-text-wrapping.ts @@ -0,0 +1,45 @@ +// Example of how to "wrap" text around an image +// Import from 'docx' rather than '../build' if you install from npm +import * as fs from "fs"; +// import { Document, Packer, Paragraph } from "../build"; +import { Document, Media, Packer, Paragraph, TextWrappingSide, TextWrappingType } from "../build"; + +const doc = new Document(); + +const image = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 200, 200, { + floating: { + horizontalPosition: { + offset: 2014400, + }, + verticalPosition: { + offset: 2014400, + }, + wrap: { + type: TextWrappingType.SQUARE, + side: TextWrappingSide.BOTH_SIDES, + }, + margins: { + top: 201440, + bottom: 201440, + }, + }, +}); + +doc.addSection({ + children: [ + new Paragraph( + "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque vehicula nec nulla vitae efficitur. Ut interdum mauris eu ipsum rhoncus, nec pharetra velit placerat. Sed vehicula libero ac urna molestie, id pharetra est pellentesque. Praesent iaculis vehicula fringilla. Duis pretium gravida orci eu vestibulum. Mauris tincidunt ipsum dolor, ut ornare dolor pellentesque id. Integer in nulla gravida, lacinia ante non, commodo ex. Vivamus vulputate nisl id lectus finibus vulputate. Ut et nisl mi. Cras fermentum augue arcu, ac accumsan elit euismod id. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed ac posuere nisi. Pellentesque tincidunt vehicula bibendum. Phasellus eleifend viverra nisl.", + ), + new Paragraph( + "Proin ac purus faucibus, porttitor magna ut, cursus nisl. Vivamus ante purus, porta accumsan nibh eget, eleifend dignissim odio. Integer sed dictum est, aliquam lacinia justo. Donec ultrices auctor venenatis. Etiam interdum et elit nec elementum. Pellentesque nec viverra mauris. Etiam suscipit leo nec velit fringilla mattis. Pellentesque justo lacus, sodales eu condimentum in, dapibus finibus lacus. Morbi vitae nibh sit amet sem molestie feugiat. In non porttitor enim.", + ), + new Paragraph( + "Ut eget diam cursus quam accumsan interdum at id ante. Ut mollis mollis arcu, eu scelerisque dui tempus in. Quisque aliquam, augue quis ornare aliquam, ex purus ultrices mauris, ut porta dolor dolor nec justo. Nunc a tempus odio, eu viverra arcu. Suspendisse vitae nibh nec mi pharetra tempus. Mauris ut ullamcorper sapien, et sagittis sapien. Vestibulum in urna metus. In scelerisque, massa id bibendum tempus, quam orci rutrum turpis, a feugiat nisi ligula id metus. Praesent id dictum purus. Proin interdum ipsum nulla.", + ), + new Paragraph(image), + ], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/39-page-numbers.ts b/demo/39-page-numbers.ts new file mode 100644 index 0000000000..edc9c411f9 --- /dev/null +++ b/demo/39-page-numbers.ts @@ -0,0 +1,45 @@ +// Example how to display page numbers +// Import from 'docx' rather than '../build' if you install from npm +import * as fs from "fs"; +import { AlignmentType, Document, Footer, Header, Packer, PageNumberFormat, Paragraph, TextRun } from "../build"; + +const doc = new Document({}); + +doc.addSection({ + headers: { + default: new Header({ + children: [ + new Paragraph("Foo Bar corp. ") + .addRun(new TextRun("Page Number ").pageNumber()) + .addRun(new TextRun(" to ").numberOfTotalPages()), + ], + }), + }, + footers: { + default: new Footer({ + children: [ + new Paragraph({ + text: "Foo Bar corp. ", + alignment: AlignmentType.CENTER, + }) + .addRun(new TextRun("Page Number: ").pageNumber()) + .addRun(new TextRun(" to ").numberOfTotalPages()), + ], + }), + }, + properties: { + pageNumberStart: 1, + pageNumberFormatType: PageNumberFormat.DECIMAL, + }, + children: [ + new Paragraph("Hello World 1").pageBreak(), + new Paragraph("Hello World 2").pageBreak(), + new Paragraph("Hello World 3").pageBreak(), + new Paragraph("Hello World 4").pageBreak(), + new Paragraph("Hello World 5").pageBreak(), + ], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/demo4.ts b/demo/4-basic-table.ts similarity index 55% rename from demo/demo4.ts rename to demo/4-basic-table.ts index 805e7ed33f..78367caab9 100644 --- a/demo/demo4.ts +++ b/demo/4-basic-table.ts @@ -1,18 +1,21 @@ // 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 * as fs from "fs"; -import { Document, Packer, Paragraph } from "../build"; +import { Document, Packer, Paragraph, Table } from "../build"; const doc = new Document(); -const table = doc.createTable({ +const table = new Table({ rows: 4, columns: 4, }); -table.getCell(2, 2).addParagraph(new Paragraph("Hello")); -const packer = new Packer(); +table.getCell(2, 2).add(new Paragraph("Hello")); -packer.toBuffer(doc).then((buffer) => { +doc.addSection({ + children: [table], +}); + +Packer.toBuffer(doc).then((buffer) => { fs.writeFileSync("My Document.docx", buffer); }); diff --git a/demo/40-line-numbers.ts b/demo/40-line-numbers.ts new file mode 100644 index 0000000000..d8da6f3074 --- /dev/null +++ b/demo/40-line-numbers.ts @@ -0,0 +1,29 @@ +// Example demonstrating line numbers. +// Import from 'docx' rather than '../build' if you install from npm +import * as fs from "fs"; +import { Document, HeadingLevel, LineNumberRestartFormat, Packer, Paragraph } from "../build"; + +const doc = new Document(); + +doc.addSection({ + properties: { + lineNumberCountBy: 1, + lineNumberRestart: LineNumberRestartFormat.CONTINUOUS, + }, + children: [ + new Paragraph({ + text: "Hello", + heading: HeadingLevel.HEADING_1, + }), + new Paragraph( + "Himenaeos duis luctus nullam fermentum lobortis potenti vivamus non dis, sed facilisis ultricies scelerisque aenean risus hac senectus. Adipiscing id venenatis justo ante gravida placerat, ac curabitur dis pellentesque proin bibendum risus, aliquam porta taciti vulputate primis. Tortor ipsum fermentum quam vel convallis primis nisl praesent tincidunt, lobortis quisque felis vitae condimentum class ut sem nam, aenean potenti pretium ac amet lacinia himenaeos mi. Aliquam nisl turpis hendrerit est morbi malesuada, augue interdum mus inceptos curabitur tristique, parturient feugiat sodales nulla facilisi. Aliquam non pulvinar purus nulla ex integer, velit faucibus vitae at bibendum quam, risus elit aenean adipiscing posuere.", + ), + new Paragraph( + "Sed laoreet id mattis egestas nam mollis elit lacinia convallis dui tincidunt ultricies habitant, pharetra per maximus interdum neque tempor risus efficitur morbi imperdiet senectus. Lectus laoreet senectus finibus inceptos donec potenti fermentum, ultrices eleifend odio suscipit magnis tellus maximus nibh, ac sit nullam eget felis himenaeos. Diam class sem magnis aenean commodo faucibus id proin mi, nullam sodales nec mus parturient ornare ad inceptos velit hendrerit, bibendum placerat eleifend integer facilisis urna dictumst suspendisse.", + ), + ], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/41-merge-table-cells-2.ts b/demo/41-merge-table-cells-2.ts new file mode 100644 index 0000000000..1801eb4a6e --- /dev/null +++ b/demo/41-merge-table-cells-2.ts @@ -0,0 +1,54 @@ +// Multiple cells merging in the same table +// Import from 'docx' rather than '../build' if you install from npm +import * as fs from "fs"; +import { Document, Packer, Paragraph, Table } from "../build"; + +const doc = new Document(); + +const table = new Table({ + rows: 13, + columns: 6, +}); + +let row = 0; +table.getCell(row, 0).add(new Paragraph("0,0")); +table.getCell(row, 1).add(new Paragraph("0,1")); +table.getCell(row, 3).add(new Paragraph("0,3")); +table.getCell(row, 4).add(new Paragraph("0,4")); +table.getRow(row).mergeCells(4, 5); +table.getRow(row).mergeCells(1, 2); +row = 1; +table.getCell(row, 0).add(new Paragraph("1,0")); +table.getCell(row, 2).add(new Paragraph("1,2")); +table.getCell(row, 4).add(new Paragraph("1,4")); +table.getRow(row).mergeCells(4, 5); +table.getRow(row).mergeCells(2, 3); +table.getRow(row).mergeCells(0, 1); + +row = 2; +table.getCell(row, 0).add(new Paragraph("2,0")); +table.getCell(row, 1).add(new Paragraph("2,1")); +table.getCell(row, 2).add(new Paragraph("2,2")); +table.getCell(row, 3).add(new Paragraph("2,3")); +table.getCell(row, 4).add(new Paragraph("2,4")); +table.getRow(row).mergeCells(4, 5); +table.getRow(row).mergeCells(1, 2); +row = 3; +table.getCell(row, 0).add(new Paragraph("3,0")); +table.getCell(row, 1).add(new Paragraph("3,1")); +table.getCell(row, 2).add(new Paragraph("3,2")); +table.getCell(row, 3).add(new Paragraph("3,3")); +table.getCell(row, 4).add(new Paragraph("3,4")); +table.getCell(row, 5).add(new Paragraph("3,5")); +row = 4; +table.getCell(row, 0).add(new Paragraph("4,0")); +table.getCell(row, 5).add(new Paragraph("4,5")); +table.getRow(row).mergeCells(0, 4); + +doc.addSection({ + children: [table], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/demo43.ts b/demo/43-images-to-table-cell-2.ts similarity index 50% rename from demo/demo43.ts rename to demo/43-images-to-table-cell-2.ts index 65d34355aa..90d6322bb7 100644 --- a/demo/demo43.ts +++ b/demo/43-images-to-table-cell-2.ts @@ -1,20 +1,22 @@ // Add image to table cell // Import from 'docx' rather than '../build' if you install from npm import * as fs from "fs"; -import { Document, Packer, Paragraph } from "../build"; +import { Document, Packer, Paragraph, Table } from "../build"; const doc = new Document(); -const table = doc.createTable({ +const table = new Table({ rows: 4, columns: 4, }); -table.getCell(2, 2).addParagraph(new Paragraph("Hello")); + +table.getCell(2, 2).add(new Paragraph("Hello")); table.getColumn(3).mergeCells(1, 2); -// table.getCell(3, 2).addParagraph(new Paragraph("Hello")); -const packer = new Packer(); +doc.addSection({ + children: [table], +}); -packer.toBuffer(doc).then((buffer) => { +Packer.toBuffer(doc).then((buffer) => { fs.writeFileSync("My Document.docx", buffer); }); diff --git a/demo/44-multiple-columns.ts b/demo/44-multiple-columns.ts new file mode 100644 index 0000000000..3fdf328461 --- /dev/null +++ b/demo/44-multiple-columns.ts @@ -0,0 +1,40 @@ +// Sections with multiple columns +// Import from 'docx' rather than '../build' if you install from npm +import * as fs from "fs"; +import { Document, Packer, Paragraph } from "../build"; + +const doc = new Document(); + +doc.addSection({ + properties: { + column: { + width: 708, + count: 2, + }, + }, + children: [ + new Paragraph("This text will be split into 2 columns on a page."), + new Paragraph( + "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.", + ), + ], +}); + +doc.addSection({ + properties: { + column: { + width: 708, + count: 3, + }, + }, + children: [ + new Paragraph("This text will be split into 3 columns on a page."), + new Paragraph( + "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.", + ), + ], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/45-highlighting-text.ts b/demo/45-highlighting-text.ts new file mode 100644 index 0000000000..d33a99fb94 --- /dev/null +++ b/demo/45-highlighting-text.ts @@ -0,0 +1,35 @@ +// Highlighting text +// Import from 'docx' rather than '../build' if you install from npm +import * as fs from "fs"; +import { AlignmentType, Document, Header, Packer, Paragraph, TextRun } from "../build"; + +const doc = new Document(); + +doc.addSection({ + headers: { + default: new Header({ + children: [ + new Paragraph({ + alignment: AlignmentType.RIGHT, + children: [ + new TextRun({ + text: "Hello World", + color: "red", + bold: true, + size: 24, + font: { + name: "Garamond", + }, + highlight: "yellow", + }), + ], + }), + ], + }), + }, + children: [], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/46-shading-text.ts b/demo/46-shading-text.ts new file mode 100644 index 0000000000..61f3f3d984 --- /dev/null +++ b/demo/46-shading-text.ts @@ -0,0 +1,39 @@ +// Shading text +// Import from 'docx' rather than '../build' if you install from npm +import * as fs from "fs"; +import { AlignmentType, Document, Header, Packer, Paragraph, ShadingType, TextRun } from "../build"; + +const doc = new Document(); + +doc.addSection({ + headers: { + default: new Header({ + children: [ + new Paragraph({ + alignment: AlignmentType.RIGHT, + children: [ + new TextRun({ + text: "Hello World", + color: "red", + bold: true, + size: 24, + font: { + name: "Garamond", + }, + shading: { + type: ShadingType.REVERSE_DIAGONAL_STRIPE, + color: "00FFFF", + fill: "FF0000", + }, + }), + ], + }), + ], + }), + }, + children: [], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/5-images.ts b/demo/5-images.ts new file mode 100644 index 0000000000..260fd25f15 --- /dev/null +++ b/demo/5-images.ts @@ -0,0 +1,62 @@ +// Example of how to add images to the document - You can use Buffers, UInt8Arrays or Base64 strings +// Import from 'docx' rather than '../build' if you install from npm +import * as fs from "fs"; +// import { Document, Packer, Paragraph } from "../build"; +import { + Document, + HorizontalPositionAlign, + HorizontalPositionRelativeFrom, + Media, + Packer, + Paragraph, + VerticalPositionAlign, + VerticalPositionRelativeFrom, +} 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/dog.png").toString("base64")); +const image3 = Media.addImage(doc, fs.readFileSync("./demo/images/cat.jpg")); +const image4 = Media.addImage(doc, fs.readFileSync("./demo/images/parrots.bmp")); +const image5 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif")); +const image6 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 200, 200, { + floating: { + horizontalPosition: { + offset: 1014400, + }, + verticalPosition: { + offset: 1014400, + }, + }, +}); + +const image7 = Media.addImage(doc, fs.readFileSync("./demo/images/cat.jpg"), 200, 200, { + floating: { + horizontalPosition: { + relative: HorizontalPositionRelativeFrom.PAGE, + align: HorizontalPositionAlign.RIGHT, + }, + verticalPosition: { + relative: VerticalPositionRelativeFrom.PAGE, + align: VerticalPositionAlign.BOTTOM, + }, + }, +}); + +doc.addSection({ + children: [ + new Paragraph("Hello World"), + new Paragraph(image1), + new Paragraph(image2), + new Paragraph(image3), + new Paragraph(image4), + new Paragraph(image5), + new Paragraph(image6), + new Paragraph(image7), + ], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/6-page-borders.ts b/demo/6-page-borders.ts new file mode 100644 index 0000000000..d54aac9a94 --- /dev/null +++ b/demo/6-page-borders.ts @@ -0,0 +1,40 @@ +// Example of how to change page borders +// 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(); + +doc.addSection({ + margins: { + top: 0, + right: 0, + bottom: 0, + left: 0, + }, + children: [ + new Paragraph({ + children: [ + new TextRun("Hello World"), + new TextRun({ + text: "Foo bar", + bold: true, + }), + new TextRun({ + text: "Github is the best", + bold: true, + }).tab(), + ], + }), + new Paragraph({ + text: "Hello World", + heading: HeadingLevel.HEADING_1, + }), + new Paragraph("Foo bar"), + new Paragraph("Github is the best"), + ], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/demo7.ts b/demo/7-landscape.ts similarity index 54% rename from demo/demo7.ts rename to demo/7-landscape.ts index fe9fccf928..fa3e551728 100644 --- a/demo/demo7.ts +++ b/demo/7-landscape.ts @@ -3,16 +3,15 @@ import * as fs from "fs"; import { Document, Packer, PageOrientation, Paragraph } from "../build"; -const doc = new Document(undefined, { - orientation: PageOrientation.LANDSCAPE, +const doc = new Document(); + +doc.addSection({ + size: { + orientation: PageOrientation.LANDSCAPE, + }, + children: [new Paragraph("Hello World")], }); -const paragraph = new Paragraph("Hello World"); - -doc.addParagraph(paragraph); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { +Packer.toBuffer(doc).then((buffer) => { fs.writeFileSync("My Document.docx", buffer); }); diff --git a/demo/8-header-footer.ts b/demo/8-header-footer.ts new file mode 100644 index 0000000000..6455d94390 --- /dev/null +++ b/demo/8-header-footer.ts @@ -0,0 +1,24 @@ +// Add text to header and footer +// Import from 'docx' rather than '../build' if you install from npm +import * as fs from "fs"; +import { Document, Footer, Header, Packer, Paragraph } from "../build"; + +const doc = new Document(); + +doc.addSection({ + headers: { + default: new Header({ + children: [new Paragraph("Header text")], + }), + }, + footers: { + default: new Footer({ + children: [new Paragraph("Footer text")], + }), + }, + children: [new Paragraph("Hello World")], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/9-images-in-header-and-footer.ts b/demo/9-images-in-header-and-footer.ts new file mode 100644 index 0000000000..75acd4f07f --- /dev/null +++ b/demo/9-images-in-header-and-footer.ts @@ -0,0 +1,35 @@ +// Add images to header and footer +// Import from 'docx' rather than '../build' if you install from npm +import * as fs from "fs"; +import { Document, Footer, Header, Media, Packer, Paragraph } from "../build"; + +const doc = new Document(); + +const image1 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif")); +const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif")); + +doc.addSection({ + headers: { + default: new Header({ + children: [ + new Paragraph({ + children: [image1], + }), + ], + }), + }, + footers: { + default: new Footer({ + children: [ + new Paragraph({ + children: [image2], + }), + ], + }), + }, + children: [new Paragraph("Hello World")], +}); + +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); diff --git a/demo/browser-demo.html b/demo/browser-demo.html index fff5dc7989..22c7c821a5 100644 --- a/demo/browser-demo.html +++ b/demo/browser-demo.html @@ -1,39 +1,45 @@ + + + + - - - - + +

DOCX browser Word document generation

- + -

DOCX browser Word document generation

+ - - + Packer.toBlob(doc).then((blob) => { + console.log(blob); + saveAs(blob, "example.docx"); + console.log("Document created successfully"); + }); + } + + diff --git a/demo/demo1.ts b/demo/demo1.ts deleted file mode 100644 index ba3a0bcc2f..0000000000 --- a/demo/demo1.ts +++ /dev/null @@ -1,20 +0,0 @@ -// 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, Packer, Paragraph, TextRun } from "../build"; - -const doc = new Document(); - -const paragraph = new Paragraph("Hello World"); -const institutionText = new TextRun("Foo Bar").bold(); -const dateText = new TextRun("Github is the best").tab().bold(); -paragraph.addRun(institutionText); -paragraph.addRun(dateText); - -doc.addParagraph(paragraph); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo12.ts b/demo/demo12.ts deleted file mode 100644 index a3479c3cbf..0000000000 --- a/demo/demo12.ts +++ /dev/null @@ -1,25 +0,0 @@ -// Scaling images -// Import from 'docx' rather than '../build' if you install from npm -import * as fs from "fs"; -import { Document, Packer, Paragraph } from "../build"; - -const doc = new Document(); - -const paragraph = new Paragraph("Hello World"); -doc.addParagraph(paragraph); - -const image = doc.createImage(fs.readFileSync("./demo/images/pizza.gif")); -const image2 = doc.createImage(fs.readFileSync("./demo/images/pizza.gif")); -const image3 = doc.createImage(fs.readFileSync("./demo/images/pizza.gif")); -const image4 = doc.createImage(fs.readFileSync("./demo/images/pizza.gif")); - -image.scale(0.5); -image2.scale(1); -image3.scale(2.5); -image4.scale(4); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo13.ts b/demo/demo13.ts deleted file mode 100644 index b80b9fdc22..0000000000 --- a/demo/demo13.ts +++ /dev/null @@ -1,28 +0,0 @@ -// This example shows 3 styles using XML styles -// Import from 'docx' rather than '../build' if you install from npm -import * as fs from "fs"; -import { Document, Packer, Paragraph } from "../build"; - -const styles = fs.readFileSync("./demo/assets/custom-styles.xml", "utf-8"); -const doc = new Document({ - title: "Title", - externalStyles: styles, -}); - -doc.createParagraph("Cool Heading Text").heading1(); - -const paragraph = new Paragraph('This is a custom named style from the template "MyFancyStyle"'); -paragraph.style("MyFancyStyle"); -doc.addParagraph(paragraph); - -doc.createParagraph("Some normal text"); - -doc.createParagraph("MyFancyStyle again").style("MyFancyStyle"); -paragraph.style("MyFancyStyle"); -doc.addParagraph(paragraph); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo14.ts b/demo/demo14.ts deleted file mode 100644 index 94d45a66a6..0000000000 --- a/demo/demo14.ts +++ /dev/null @@ -1,28 +0,0 @@ -// Page numbers -// 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(); - -doc.createParagraph("First Page").pageBreak(); -doc.createParagraph("Second Page"); - -const pageNumber = new TextRun("Page ").pageNumber(); - -const pageoneheader = new Paragraph("First Page Header ").right(); - -pageoneheader.addRun(pageNumber); -const firstPageHeader = doc.createFirstPageHeader(); -firstPageHeader.addParagraph(pageoneheader); - -const pagetwoheader = new Paragraph("My Title ").right(); - -pagetwoheader.addRun(pageNumber); -doc.Header.addParagraph(pagetwoheader); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo16.ts b/demo/demo16.ts deleted file mode 100644 index 786b7bf081..0000000000 --- a/demo/demo16.ts +++ /dev/null @@ -1,84 +0,0 @@ -// Multiple sections and headers -// Import from 'docx' rather than '../build' if you install from npm -import * as fs from "fs"; -import { Document, Packer, PageNumberFormat, PageOrientation, Paragraph, TextRun } from "../build"; - -const doc = new Document(); - -const paragraph = new Paragraph("Hello World").pageBreak(); - -doc.addParagraph(paragraph); - -const header = doc.createHeader(); -header.createParagraph("Header on another page"); -const footer = doc.createFooter(); -footer.createParagraph("Footer on another page"); - -doc.addSection({ - headers: { - default: header, - }, - footers: { - default: footer, - }, - pageNumberStart: 1, - pageNumberFormatType: PageNumberFormat.DECIMAL, -}); - -doc.createParagraph("hello"); - -doc.addSection({ - headers: { - default: header, - }, - footers: { - default: footer, - }, - pageNumberStart: 1, - pageNumberFormatType: PageNumberFormat.DECIMAL, - orientation: PageOrientation.LANDSCAPE, -}); - -doc.createParagraph("hello in landscape"); - -const header2 = doc.createHeader(); -const pageNumber = new TextRun("Page number: ").pageNumber(); -header2.createParagraph().addRun(pageNumber); - -doc.addSection({ - headers: { - default: header2, - }, - orientation: PageOrientation.PORTRAIT, -}); - -doc.createParagraph("Page number in the header must be 2, because it continues from the previous section."); - -doc.addSection({ - headers: { - default: header2, - }, - pageNumberFormatType: PageNumberFormat.UPPER_ROMAN, - orientation: PageOrientation.PORTRAIT, -}); - -doc.createParagraph( - "Page number in the header must be III, because it continues from the previous section, but is defined as upper roman.", -); - -doc.addSection({ - headers: { - default: header2, - }, - pageNumberFormatType: PageNumberFormat.DECIMAL, - pageNumberStart: 25, - orientation: PageOrientation.PORTRAIT, -}); - -doc.createParagraph("Page number in the header must be 25, because it is defined to start at 25 and to be decimal in this section."); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo19.ts b/demo/demo19.ts deleted file mode 100644 index 52b5fd6694..0000000000 --- a/demo/demo19.ts +++ /dev/null @@ -1,20 +0,0 @@ -// Export to base64 string - Useful in a browser environment. -// 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(); - -const paragraph = new Paragraph("Hello World"); -const institutionText = new TextRun("Foo").bold(); -const dateText = new TextRun("Bar").tab().bold(); -paragraph.addRun(institutionText); -paragraph.addRun(dateText); - -doc.addParagraph(paragraph); - -const packer = new Packer(); - -packer.toBase64String(doc).then((str) => { - fs.writeFileSync("My Document.docx", str); -}); diff --git a/demo/demo2.ts b/demo/demo2.ts deleted file mode 100644 index f32779fa06..0000000000 --- a/demo/demo2.ts +++ /dev/null @@ -1,78 +0,0 @@ -// Example on how to customise the look at feel using Styles -// Import from 'docx' rather than '../build' if you install from npm -import * as fs from "fs"; -import { Document, Packer } from "../build"; - -const doc = new Document({ - creator: "Clippy", - title: "Sample Document", - description: "A brief example of using docx", -}); - -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"); - -doc.createParagraph("Test heading1, bold and italicized").heading1(); -doc.createParagraph("Some simple content"); -doc.createParagraph("Test heading2 with double red underline").heading2(); - -const letterNumbering = doc.Numbering.createConcreteNumbering(numberedAbstract); -const letterNumbering5 = doc.Numbering.createConcreteNumbering(numberedAbstract); -letterNumbering5.overrideLevel(0, 5); - -doc.createParagraph("Option1").setNumbering(letterNumbering, 0); -doc.createParagraph("Option5 -- override 2 to 5").setNumbering(letterNumbering5, 0); -doc.createParagraph("Option3").setNumbering(letterNumbering, 0); - -doc - .createParagraph() - .createTextRun("Some monospaced content") - .font("Monospace"); - -doc.createParagraph("An aside, in light gray italics and indented").style("aside"); -doc.createParagraph("This is normal, but well-spaced text").style("wellSpaced"); -const para = doc.createParagraph(); -para.createTextRun("This is a bold run,").bold(); -para.createTextRun(" switching to normal "); -para.createTextRun("and then underlined ").underline(); -para.createTextRun("and back to normal."); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo22.ts b/demo/demo22.ts deleted file mode 100644 index 6f5baa970c..0000000000 --- a/demo/demo22.ts +++ /dev/null @@ -1,27 +0,0 @@ -// This demo shows right to left for special languages -// 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(); - -const paragraph1 = new Paragraph().bidirectional(); -const textRun1 = new TextRun("שלום עולם").rightToLeft(); -paragraph1.addRun(textRun1); -doc.addParagraph(paragraph1); - -const paragraph2 = new Paragraph().bidirectional(); -const textRun2 = new TextRun("שלום עולם").bold().rightToLeft(); -paragraph2.addRun(textRun2); -doc.addParagraph(paragraph2); - -const paragraph3 = new Paragraph().bidirectional(); -const textRun3 = new TextRun("שלום עולם").italics().rightToLeft(); -paragraph3.addRun(textRun3); -doc.addParagraph(paragraph3); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo26.ts b/demo/demo26.ts deleted file mode 100644 index 9fa560d260..0000000000 --- a/demo/demo26.ts +++ /dev/null @@ -1,22 +0,0 @@ -// Creates two paragraphs, one with a border and one without -// Import from 'docx' rather than '../build' if you install from npm -import * as fs from "fs"; -import { Document, Packer, Paragraph } from "../build"; - -const doc = new Document(); - -const paragraph = new Paragraph("No border!"); - -doc.addParagraph(paragraph); - -const borderParagraph = new Paragraph("I have borders on my top and bottom sides!").createBorder(); -borderParagraph.Borders.addTopBorder(); -borderParagraph.Borders.addBottomBorder(); - -doc.addParagraph(borderParagraph); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo27.ts b/demo/demo27.ts deleted file mode 100644 index a5022a1d18..0000000000 --- a/demo/demo27.ts +++ /dev/null @@ -1,35 +0,0 @@ -// Custom styles using JavaScript configuration -// Import from 'docx' rather than '../build' if you install from npm -import * as fs from "fs"; -import { Document, Packer } from "../build"; - -const doc = new Document(); -const myStyles = doc.Styles; - -// The first argument is an ID you use to apply the style to paragraphs -// The second argument is a human-friendly name to show in the UI -myStyles.createParagraphStyle("myWonkyStyle", "My Wonky Style") - .basedOn("Normal") - .next("Normal") - .color("990000") - .italics() - .indent({left: 720}) // 720 TWIP === 720 / 20 pt === .5 in - .spacing({line: 276}); // 276 / 240 = 1.15x line spacing - -myStyles.createParagraphStyle("Heading2", "Heading 2") - .basedOn("Normal") - .next("Normal") - .quickFormat() - .size(26) // 26 half-points === 13pt font - .bold() - .underline("double", "FF0000") - .spacing({before: 240, after: 120}); // TWIP for both - -doc.createParagraph("Hello").style("myWonkyStyle"); -doc.createParagraph("World").heading2(); // Uses the Heading2 style - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo28.ts b/demo/demo28.ts deleted file mode 100644 index aec36f5bfd..0000000000 --- a/demo/demo28.ts +++ /dev/null @@ -1,43 +0,0 @@ -// Table of contents -// Import from 'docx' rather than '../build' if you install from npm -import * as fs from "fs"; -import { File, Packer, Paragraph, StyleLevel, TableOfContents } from "../build"; - -const doc = new File(); - -// The first argument is an ID you use to apply the style to paragraphs -// The second argument is a human-friendly name to show in the UI -doc.Styles.createParagraphStyle("MySpectacularStyle", "My Spectacular Style") - .basedOn("Heading1") - .next("Heading1") - .color("990000") - .italics(); - -// WordprocessingML docs for TableOfContents can be found here: -// http://officeopenxml.com/WPtableOfContents.php - -// Let's define the properties 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.addParagraph(new Paragraph("Header #1").heading1().pageBreakBefore()); -doc.addParagraph(new Paragraph("I'm a little text very nicely written.'")); - -doc.addParagraph(new Paragraph("Header #2").heading1().pageBreakBefore()); -doc.addParagraph(new Paragraph("I'm a other text very nicely written.'")); -doc.addParagraph(new Paragraph("Header #2.1").heading2()); -doc.addParagraph(new Paragraph("I'm a another text very nicely written.'")); - -doc.addParagraph(new Paragraph("My Spectacular Style #1").style("MySpectacularStyle").pageBreakBefore()); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo29.ts b/demo/demo29.ts deleted file mode 100644 index 0439d372d7..0000000000 --- a/demo/demo29.ts +++ /dev/null @@ -1,46 +0,0 @@ -// Numbered lists -// Import from 'docx' rather than '../build' if you install from npm -import * as fs from "fs"; -import { Document, Indent, Numbering, Packer, Paragraph } from "../build"; - -const doc = new Document(); - -const numbering = new Numbering(); - -const abstractNum = numbering.createAbstractNumbering(); -abstractNum.createLevel(0, "upperRoman", "%1", "start").addParagraphProperty(new Indent({ left: 720, hanging: 260 })); - -const concrete = numbering.createConcreteNumbering(abstractNum); - -const item1 = new Paragraph("line with contextual spacing"); -const item2 = new Paragraph("line with contextual spacing"); -const item3 = new Paragraph("line without contextual spacing"); -const item4 = new Paragraph("line without contextual spacing"); - -item1 - .setNumbering(concrete, 0) - .spacing({ before: 200 }) - .contextualSpacing(true); -item2 - .setNumbering(concrete, 0) - .spacing({ before: 200 }) - .contextualSpacing(true); -item3 - .setNumbering(concrete, 0) - .spacing({ before: 200 }) - .contextualSpacing(false); -item4 - .setNumbering(concrete, 0) - .spacing({ before: 200 }) - .contextualSpacing(false); - -doc.addParagraph(item1); -doc.addParagraph(item2); -doc.addParagraph(item3); -doc.addParagraph(item4); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo3.ts b/demo/demo3.ts deleted file mode 100644 index ac3680ef32..0000000000 --- a/demo/demo3.ts +++ /dev/null @@ -1,46 +0,0 @@ -// Numbering and bullet points example -// Import from 'docx' rather than '../build' if you install from npm -import * as fs from "fs"; -import { Document, Indent, Numbering, Packer, Paragraph } from "../build"; - -const doc = new Document(); - -const numbering = new Numbering(); - -const abstractNum = numbering.createAbstractNumbering(); -abstractNum.createLevel(0, "upperRoman", "%1", "start").addParagraphProperty(new Indent({ left: 720, hanging: 260 })); -abstractNum.createLevel(1, "decimal", "%2.", "start").addParagraphProperty(new Indent({ left: 1440, hanging: 980 })); -abstractNum.createLevel(2, "lowerLetter", "%3)", "start").addParagraphProperty(new Indent({ left: 14402160, hanging: 1700 })); - -const concrete = numbering.createConcreteNumbering(abstractNum); - -const topLevelP = new Paragraph("Hey you"); -const subP = new Paragraph("What's up fam"); -const secondSubP = new Paragraph("Hello World 2"); -const subSubP = new Paragraph("Yeah boi"); - -topLevelP.setNumbering(concrete, 0); -subP.setNumbering(concrete, 1); -secondSubP.setNumbering(concrete, 1); -subSubP.setNumbering(concrete, 2); - -doc.addParagraph(topLevelP); -doc.addParagraph(subP); -doc.addParagraph(secondSubP); -doc.addParagraph(subSubP); - -const bullet1 = new Paragraph("Hey you").bullet(); -const bullet2 = new Paragraph("What's up fam").bullet(1); -const bullet3 = new Paragraph("Hello World 2").bullet(2); -const bullet4 = new Paragraph("Yeah boi").bullet(3); - -doc.addParagraph(bullet1); -doc.addParagraph(bullet2); -doc.addParagraph(bullet3); -doc.addParagraph(bullet4); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo33.ts b/demo/demo33.ts deleted file mode 100644 index c6efe2ed0f..0000000000 --- a/demo/demo33.ts +++ /dev/null @@ -1,22 +0,0 @@ -// Sequential Captions -// 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(); - -const paragraph = new Paragraph("Hello World 1->").addSequentialIdentifier("Caption").addRun(new TextRun(" text after sequencial caption 2->")).addSequentialIdentifier("Caption"); -const paragraph2 = new Paragraph("Hello World 1->").addSequentialIdentifier("Label").addRun(new TextRun(" text after sequencial caption 2->")).addSequentialIdentifier("Label"); -const paragraph3 = new Paragraph("Hello World 1->").addSequentialIdentifier("Another").addRun(new TextRun(" text after sequencial caption 3->")).addSequentialIdentifier("Label"); -const paragraph4 = new Paragraph("Hello World 2->").addSequentialIdentifier("Another").addRun(new TextRun(" text after sequencial caption 4->")).addSequentialIdentifier("Label"); - -doc.addParagraph(paragraph); -doc.addParagraph(paragraph2); -doc.addParagraph(paragraph3); -doc.addParagraph(paragraph4); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo36.ts b/demo/demo36.ts deleted file mode 100644 index 5baa5086c3..0000000000 --- a/demo/demo36.ts +++ /dev/null @@ -1,26 +0,0 @@ -// Add image to table cell -// Import from 'docx' rather than '../build' if you install from npm -import * as fs from "fs"; -import { Document, Media, Packer, Table } from "../build"; - -const doc = new Document(); -const image = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg")); - -const table = new Table({ - rows: 2, - columns: 2, -}); -table.getCell(1, 1).addParagraph(image.Paragraph); - -// doc.createParagraph("Hello World"); -doc.addTable(table); - -// doc.Header.createImage(fs.readFileSync("./demo/images/pizza.gif")); -doc.Header.addTable(table); -// doc.Footer.createImage(fs.readFileSync("./demo/images/pizza.gif")); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo37.ts b/demo/demo37.ts deleted file mode 100644 index 0aaf380d51..0000000000 --- a/demo/demo37.ts +++ /dev/null @@ -1,18 +0,0 @@ -// Add images to header and footer -// Import from 'docx' rather than '../build' if you install from npm -import * as fs from "fs"; -import { Document, Media, Packer } from "../build"; - -const doc = new Document(); -const image = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg")); -doc.createParagraph("Hello World"); - -doc.Header.addImage(image); -doc.Header.createImage(fs.readFileSync("./demo/images/pizza.gif")); -doc.Header.createImage(fs.readFileSync("./demo/images/image1.jpeg")); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo38.ts b/demo/demo38.ts deleted file mode 100644 index d3e5fb2688..0000000000 --- a/demo/demo38.ts +++ /dev/null @@ -1,44 +0,0 @@ -// Example of how to "wrap" text around an image -// Import from 'docx' rather than '../build' if you install from npm -import * as fs from "fs"; -// import { Document, Packer, Paragraph } from "../build"; -import { Document, Packer, TextWrappingSide, TextWrappingType } from "../build"; - -const doc = new Document(); - -doc.createParagraph( - "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque vehicula nec nulla vitae efficitur. Ut interdum mauris eu ipsum rhoncus, nec pharetra velit placerat. Sed vehicula libero ac urna molestie, id pharetra est pellentesque. Praesent iaculis vehicula fringilla. Duis pretium gravida orci eu vestibulum. Mauris tincidunt ipsum dolor, ut ornare dolor pellentesque id. Integer in nulla gravida, lacinia ante non, commodo ex. Vivamus vulputate nisl id lectus finibus vulputate. Ut et nisl mi. Cras fermentum augue arcu, ac accumsan elit euismod id. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed ac posuere nisi. Pellentesque tincidunt vehicula bibendum. Phasellus eleifend viverra nisl.", -); - -doc.createParagraph( - "Proin ac purus faucibus, porttitor magna ut, cursus nisl. Vivamus ante purus, porta accumsan nibh eget, eleifend dignissim odio. Integer sed dictum est, aliquam lacinia justo. Donec ultrices auctor venenatis. Etiam interdum et elit nec elementum. Pellentesque nec viverra mauris. Etiam suscipit leo nec velit fringilla mattis. Pellentesque justo lacus, sodales eu condimentum in, dapibus finibus lacus. Morbi vitae nibh sit amet sem molestie feugiat. In non porttitor enim.", -); - -doc.createParagraph( - "Ut eget diam cursus quam accumsan interdum at id ante. Ut mollis mollis arcu, eu scelerisque dui tempus in. Quisque aliquam, augue quis ornare aliquam, ex purus ultrices mauris, ut porta dolor dolor nec justo. Nunc a tempus odio, eu viverra arcu. Suspendisse vitae nibh nec mi pharetra tempus. Mauris ut ullamcorper sapien, et sagittis sapien. Vestibulum in urna metus. In scelerisque, massa id bibendum tempus, quam orci rutrum turpis, a feugiat nisi ligula id metus. Praesent id dictum purus. Proin interdum ipsum nulla.", -); - -doc.createImage(fs.readFileSync("./demo/images/pizza.gif"), 200, 200, { - floating: { - horizontalPosition: { - offset: 2014400, - }, - verticalPosition: { - offset: 2014400, - }, - wrap: { - type: TextWrappingType.SQUARE, - side: TextWrappingSide.BOTH_SIDES, - }, - margins: { - top: 201440, - bottom: 201440, - }, - }, -}); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo39.ts b/demo/demo39.ts deleted file mode 100644 index cd87bc4bcb..0000000000 --- a/demo/demo39.ts +++ /dev/null @@ -1,33 +0,0 @@ -// Example how to display page numbers -// Import from 'docx' rather than '../build' if you install from npm -import * as fs from "fs"; -import { Document, Packer, PageNumberFormat, TextRun } from "../build"; - -const doc = new Document( - {}, - { - pageNumberStart: 1, - pageNumberFormatType: PageNumberFormat.DECIMAL, - }, -); - -doc.Header.createParagraph("Foo Bar corp. ") - .addRun(new TextRun("Page Number ").pageNumber()) - .addRun(new TextRun(" to ").numberOfTotalPages()); - -doc.Footer.createParagraph("Foo Bar corp. ") - .center() - .addRun(new TextRun("Page Number: ").pageNumber()) - .addRun(new TextRun(" to ").numberOfTotalPages()); - -doc.createParagraph("Hello World 1").pageBreak(); -doc.createParagraph("Hello World 2").pageBreak(); -doc.createParagraph("Hello World 3").pageBreak(); -doc.createParagraph("Hello World 4").pageBreak(); -doc.createParagraph("Hello World 5").pageBreak(); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo40.ts b/demo/demo40.ts deleted file mode 100644 index b9213d76a1..0000000000 --- a/demo/demo40.ts +++ /dev/null @@ -1,26 +0,0 @@ -// Example demonstrating line numbers. -// Import from 'docx' rather than '../build' if you install from npm -import * as fs from "fs"; -import { Document, LineNumberRestartFormat, Packer, Paragraph } from "../build"; - -const doc = new Document( - {}, - { - lineNumberCountBy: 1, - lineNumberRestart: LineNumberRestartFormat.CONTINUOUS, - }, -); - -doc.addParagraph(new Paragraph("Hello").heading1()); -doc.createParagraph( - "Himenaeos duis luctus nullam fermentum lobortis potenti vivamus non dis, sed facilisis ultricies scelerisque aenean risus hac senectus. Adipiscing id venenatis justo ante gravida placerat, ac curabitur dis pellentesque proin bibendum risus, aliquam porta taciti vulputate primis. Tortor ipsum fermentum quam vel convallis primis nisl praesent tincidunt, lobortis quisque felis vitae condimentum class ut sem nam, aenean potenti pretium ac amet lacinia himenaeos mi. Aliquam nisl turpis hendrerit est morbi malesuada, augue interdum mus inceptos curabitur tristique, parturient feugiat sodales nulla facilisi. Aliquam non pulvinar purus nulla ex integer, velit faucibus vitae at bibendum quam, risus elit aenean adipiscing posuere.", -); -doc.createParagraph( - "Sed laoreet id mattis egestas nam mollis elit lacinia convallis dui tincidunt ultricies habitant, pharetra per maximus interdum neque tempor risus efficitur morbi imperdiet senectus. Lectus laoreet senectus finibus inceptos donec potenti fermentum, ultrices eleifend odio suscipit magnis tellus maximus nibh, ac sit nullam eget felis himenaeos. Diam class sem magnis aenean commodo faucibus id proin mi, nullam sodales nec mus parturient ornare ad inceptos velit hendrerit, bibendum placerat eleifend integer facilisis urna dictumst suspendisse.", -); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo41.ts b/demo/demo41.ts deleted file mode 100644 index a7094784ca..0000000000 --- a/demo/demo41.ts +++ /dev/null @@ -1,51 +0,0 @@ -// Multiple cells merging in the same table -// Import from 'docx' rather than '../build' if you install from npm -import * as fs from "fs"; -import { Document, Packer, Paragraph } from "../build"; - -const doc = new Document(); - -const table = doc.createTable({ - rows: 13, - columns: 6, -}); -let row = 0; -table.getCell(row, 0).addContent(new Paragraph("0,0")); -table.getCell(row, 1).addContent(new Paragraph("0,1")); -table.getCell(row, 3).addContent(new Paragraph("0,3")); -table.getCell(row, 4).addContent(new Paragraph("0,4")); -table.getRow(row).mergeCells(4, 5); -table.getRow(row).mergeCells(1, 2); -row = 1; -table.getCell(row, 0).addContent(new Paragraph("1,0")); -table.getCell(row, 2).addContent(new Paragraph("1,2")); -table.getCell(row, 4).addContent(new Paragraph("1,4")); -table.getRow(row).mergeCells(4, 5); -table.getRow(row).mergeCells(2, 3); -table.getRow(row).mergeCells(0, 1); - -row = 2; -table.getCell(row, 0).addContent(new Paragraph("2,0")); -table.getCell(row, 1).addContent(new Paragraph("2,1")); -table.getCell(row, 2).addContent(new Paragraph("2,2")); -table.getCell(row, 3).addContent(new Paragraph("2,3")); -table.getCell(row, 4).addContent(new Paragraph("2,4")); -table.getRow(row).mergeCells(4, 5); -table.getRow(row).mergeCells(1, 2); -row = 3; -table.getCell(row, 0).addContent(new Paragraph("3,0")); -table.getCell(row, 1).addContent(new Paragraph("3,1")); -table.getCell(row, 2).addContent(new Paragraph("3,2")); -table.getCell(row, 3).addContent(new Paragraph("3,3")); -table.getCell(row, 4).addContent(new Paragraph("3,4")); -table.getCell(row, 5).addContent(new Paragraph("3,5")); -row = 4; -table.getCell(row, 0).addContent(new Paragraph("4,0")); -table.getCell(row, 5).addContent(new Paragraph("4,5")); -table.getRow(row).mergeCells(0, 4); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo44.ts b/demo/demo44.ts deleted file mode 100644 index a64062222b..0000000000 --- a/demo/demo44.ts +++ /dev/null @@ -1,36 +0,0 @@ -// Sections with multiple columns -// Import from 'docx' rather than '../build' if you install from npm -import * as fs from "fs"; -import { Document, Packer } from "../build"; - -const doc = new Document(); - -doc.addSection({ - column: { - width: 708, - count: 2, - }, -}); - -doc.createParagraph("This text will be split into 2 columns on a page."); -doc.createParagraph( - "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.", -); - -doc.addSection({ - column: { - width: 708, - count: 2, - }, -}); - -doc.createParagraph("This text will be split into 3 columns on a page."); -doc.createParagraph( - "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.", -); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo5.ts b/demo/demo5.ts deleted file mode 100644 index 7163a5db60..0000000000 --- a/demo/demo5.ts +++ /dev/null @@ -1,45 +0,0 @@ -// Example of how to add images to the document - You can use Buffers, UInt8Arrays or Base64 strings -// Import from 'docx' rather than '../build' if you install from npm -import * as fs from "fs"; -// import { Document, Packer, Paragraph } from "../build"; -import { Document, HorizontalPositionAlign, HorizontalPositionRelativeFrom, Packer, Paragraph, VerticalPositionAlign, VerticalPositionRelativeFrom} from "../build"; - -const doc = new Document(); - -const paragraph = new Paragraph("Hello World"); -doc.addParagraph(paragraph); - -doc.createImage(fs.readFileSync("./demo/images/image1.jpeg")); -doc.createImage(fs.readFileSync("./demo/images/dog.png").toString("base64")); -doc.createImage(fs.readFileSync("./demo/images/cat.jpg")); -doc.createImage(fs.readFileSync("./demo/images/parrots.bmp")); -doc.createImage(fs.readFileSync("./demo/images/pizza.gif")); -doc.createImage(fs.readFileSync("./demo/images/pizza.gif"), 200, 200, { - floating: { - horizontalPosition: { - offset: 1014400, - }, - verticalPosition: { - offset: 1014400, - }, - }, -}); - -doc.createImage(fs.readFileSync("./demo/images/cat.jpg"), 200, 200, { - floating: { - horizontalPosition: { - relative: HorizontalPositionRelativeFrom.PAGE, - align: HorizontalPositionAlign.RIGHT, - }, - verticalPosition: { - relative: VerticalPositionRelativeFrom.PAGE, - align: VerticalPositionAlign.BOTTOM, - }, - }, -}); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo6.ts b/demo/demo6.ts deleted file mode 100644 index 5c9ff2798f..0000000000 --- a/demo/demo6.ts +++ /dev/null @@ -1,29 +0,0 @@ -// Example of how to change page borders -// 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(undefined, { - top: 0, - right: 0, - bottom: 0, - left: 0, -}); - -const paragraph = new Paragraph("Hello World"); -const institutionText = new TextRun("Foo bar").bold(); -const dateText = new TextRun("Github is the best").tab().bold(); -paragraph.addRun(institutionText); -paragraph.addRun(dateText); - -doc.addParagraph(paragraph); - -doc.createParagraph("Hello World").heading1(); -doc.createParagraph("Foo bar"); -doc.createParagraph("Github is the best"); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo8.ts b/demo/demo8.ts deleted file mode 100644 index c4fb96a78c..0000000000 --- a/demo/demo8.ts +++ /dev/null @@ -1,17 +0,0 @@ -// Add text to header and footer -// Import from 'docx' rather than '../build' if you install from npm -import * as fs from "fs"; -import { Document, Packer } from "../build"; - -const doc = new Document(); - -doc.createParagraph("Hello World"); - -doc.Header.createParagraph("Header text"); -doc.Footer.createParagraph("Footer text"); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/demo9.ts b/demo/demo9.ts deleted file mode 100644 index 87fe9b5192..0000000000 --- a/demo/demo9.ts +++ /dev/null @@ -1,17 +0,0 @@ -// Add images to header and footer -// Import from 'docx' rather than '../build' if you install from npm -import * as fs from "fs"; -import { Document, Packer } from "../build"; - -const doc = new Document(); - -doc.createParagraph("Hello World"); - -doc.Header.createImage(fs.readFileSync("./demo/images/pizza.gif")); -doc.Footer.createImage(fs.readFileSync("./demo/images/pizza.gif")); - -const packer = new Packer(); - -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My Document.docx", buffer); -}); diff --git a/demo/index.ts b/demo/index.ts index 50b65572f2..8764e25f31 100644 --- a/demo/index.ts +++ b/demo/index.ts @@ -19,13 +19,16 @@ prompt.start(); prompt.get(schema, (_, result) => { const demoNumber = result.number; - const filePath = `./demo/demo${demoNumber}.ts`; + const files = fs.readdirSync("./demo").filter((fn) => fn.startsWith(demoNumber)); - if (!fs.existsSync(filePath)) { - console.error(`demo${demoNumber} does not exist: ${filePath}`); + if (files.length === 0) { + console.error(`demo number ${demoNumber} does not exist`); return; } - console.log(`Running demo ${demoNumber}`); + + const filePath = `./demo/${files[0]}`; + + console.log(`Running demo ${demoNumber}: ${files[0]}`); if (shelljs.exec(`npm run ts-node -- ${filePath}`).code === 0) { console.log("Document created successfully"); } else { diff --git a/docs/README.md b/docs/README.md index fd5ad9ecd9..089c133ac2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,5 @@

- clippy the assistant + clippy the assistant

@@ -18,33 +18,49 @@ npm install --save docx Then you can `require` or `import` as usual: -```js -let docx = require("docx"); +```ts +const docx = require("docx"); ``` -```js +```ts import * as docx from "docx"; +// or +import { ... } from "docx"; ``` ## Basic Usage -```js -var fs = require("fs"); -var docx = require("docx"); +```ts +import * as fs from "fs"; +import { Document, Packer, Paragraph, TextRun } from "docx"; // Create document -var doc = new docx.Document(); +const doc = new Document(); -// Add some content in the document -var paragraph = new docx.Paragraph("Some cool text here."); -// Add more text into the paragraph if you wish -paragraph.addRun(new docx.TextRun("Lorem Ipsum Foo Bar")); -doc.addParagraph(paragraph); +// Documents contain sections, you can have multiple sections per document, go here to learn more about sections +// This simple example will only contain one section +doc.addSection({ + properties: {}, + children: [ + new Paragraph({ + children: [ + new TextRun("Hello World"), + new TextRun({ + text: "Foo Bar", + bold: true, + }), + new TextRun({ + text: "Github is the best", + bold: true, + }).tab(), + ], + }), + ], +}); // Used to export the file into a .docx file -var packer = new docx.Packer(); -packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My First Document.docx", buffer); +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); }); // Done! A file called 'My First Document.docx' will be in your file system. diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 558029dbf6..9e329b6448 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -9,6 +9,7 @@ * Usage * [Document](usage/document.md) + * [Sections](usage/sections.md) * [Paragraph](usage/paragraph.md) * [Text](usage/text.md) * [Image](usage/images.md) diff --git a/docs/contribution-guidelines.md b/docs/contribution-guidelines.md index 7f61964032..1305c4c4bd 100644 --- a/docs/contribution-guidelines.md +++ b/docs/contribution-guidelines.md @@ -2,7 +2,7 @@ * Include documentation reference(s) at the top of each file: - ```js + ```ts // http://officeopenxml.com/WPdocument.php ``` @@ -44,7 +44,7 @@ Try to make method parameters of the outside API accept primitives, or `json` ob This is so that: 1. Imports are much cleaner for the end user, no need for: - ```js + ```ts import { ChildComponent } from "./my-feature/sub-component/deeper/.../my-deep.component"; ``` @@ -55,7 +55,7 @@ This is so that: `TableFloatProperties` is a class. The outside world would have to `new` up the object, and inject it in like so: -```js +```ts public float(tableFloatProperties: TableFloatProperties): Table ``` @@ -67,7 +67,7 @@ This is so that: `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: -```js +```ts public float(tableFloatOptions: ITableFloatOptions): Table ``` @@ -81,7 +81,7 @@ This is just a guideline, and the rules can sometimes be broken. * Use `create` if the method `new`'s up an element inside: - ```js + ```ts public createParagraph() { const paragraph = new Paragraph(); this.root.push(paragraph); @@ -91,8 +91,8 @@ This is just a guideline, and the rules can sometimes be broken. * 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: - ```js - public addParagraph(paragraph: Paragraph) { + ```ts + public add(paragraph: Paragraph) { this.root.push(paragraph); } ``` @@ -101,7 +101,7 @@ This is just a guideline, and the rules can sometimes be broken. Getters and Setters are done with a capital letter like so: -```js +```ts public get Level() { ... } @@ -111,13 +111,13 @@ There is no performance advantage by doing this. It means we don't need to prefi **Do not:** -```js +```ts private get _level: string; ``` **Do** -```js +```ts private get level: string; ``` @@ -158,13 +158,13 @@ Do not use `type`, but rather use `Interfaces`. `type` cannot be extended, and a **Do not:** -```js +```ts type RelationshipFileInfo = { id: number, target: string }; ``` **Do:** -```js +```ts interface IRelationshipFileInfo { id: number; target: string; @@ -177,13 +177,13 @@ To take full advantage of TypeScript's typing system, its best to use `string en **Do not:** -```js +```ts type WeaponType = "bow" | "sword" | "wand"; ``` **Do:** -```js +```ts enum WeaponType = { BOW = "bow", SWORD = "sword", @@ -196,7 +196,7 @@ enum WeaponType = { I am not sure where these habits in software development come from, but I do not believe it is beneficial: **Do not:** -```js +```ts readdy // misspelling perm // abbreviation conf // abbreviation @@ -206,7 +206,7 @@ colour // U.K. English ``` **Do:** -```js +```ts ready permission config @@ -231,7 +231,7 @@ Please write a test of every file you make and suffix it with `.spec.ts`. Here is a template of a test: -```js +```ts import { assert } from "chai"; describe("ClassName", () => { diff --git a/docs/usage/bullet-points.md b/docs/usage/bullet-points.md index c2fb2987d0..dde800ec4d 100644 --- a/docs/usage/bullet-points.md +++ b/docs/usage/bullet-points.md @@ -4,15 +4,15 @@ To make a bullet point, simply make a paragraph into a bullet point: -```js -var text = new docx.TextRun("Bullet points"); -var paragraph = new docx.Paragraph(text).bullet(); +```ts +const text = new docx.TextRun("Bullet points"); +const paragraph = new docx.Paragraph(text).bullet(); -var text2 = new docx.TextRun("Are awesome"); -var paragraph2 = new docx.Paragraph(text2).bullet(); +const text2 = new docx.TextRun("Are awesome"); +const paragraph2 = new docx.Paragraph(text2).bullet(); -doc.addParagraph(paragraph); -doc.addParagraph(paragraph2); +doc.add(paragraph); +doc.add(paragraph2); ``` ### This will produce: diff --git a/docs/usage/document.md b/docs/usage/document.md index 175e4ecad1..bf06d30613 100644 --- a/docs/usage/document.md +++ b/docs/usage/document.md @@ -4,7 +4,7 @@ To create a new document, it is very easy: -```js +```ts const doc = new docx.Document(); ``` @@ -12,7 +12,7 @@ const doc = new docx.Document(); You can add properties to the Word document by specifying options, for example: -```js +```ts const doc = new docx.Document({ creator: "Dolan Miu", description: "My extremely interesting document", @@ -33,7 +33,7 @@ const doc = new docx.Document({ You can mix and match whatever properties you want, or provide no properties. -### units for positioning +### Units for positioning Various parts of the API require positioning arguments. The units are "20ths of a point" from the [OOXML](http://officeopenxml.com/index.php) specification. -See [Lars Corneliussen's blog post](https://startbigthinksmall.wordpress.com/2010/01/04/points-inches-and-emus-measuring-units-in-office-open-xml/) for more information and how to convert units. \ No newline at end of file +See [Lars Corneliussen's blog post](https://startbigthinksmall.wordpress.com/2010/01/04/points-inches-and-emus-measuring-units-in-office-open-xml/) for more information and how to convert units. diff --git a/docs/usage/headers-and-footers.md b/docs/usage/headers-and-footers.md index 22951abdee..f93cae332c 100644 --- a/docs/usage/headers-and-footers.md +++ b/docs/usage/headers-and-footers.md @@ -1,24 +1,26 @@ # Headers and Footers +!> Headers and Footers requires an understanding of [Sections](usage/sections.md). + ## Example Creating Headers and footers is simple. Access the `Header` and `Footer` by doing so like this: -```js +```ts doc.Header; doc.Footer; ``` You can call the same methods as you would with a `File`: -```js +```ts doc.Header.createParagraph("Header text"); doc.Footer.createParagraph("Footer text"); ``` Even add images: -```js +```ts doc.Header.createImage([BUFFER_OF_YOUR_IMAGE]); doc.Footer.createImage([BUFFER_OF_YOUR_IMAGE]); ``` @@ -31,7 +33,7 @@ Also all the supported section properties are implemented according to: http://o ### Example -```js +```ts const header = this.document.createHeader(); const footer = this.document.createFooter(); diff --git a/docs/usage/images.md b/docs/usage/images.md index 8f4c34643c..693b2d4781 100644 --- a/docs/usage/images.md +++ b/docs/usage/images.md @@ -1,9 +1,11 @@ # Images +!> Images requires an understanding of [Sections](usage/sections.md) and [Paragraphs](usage/paragraph.md). + To create a `floating` image on top of text: ```ts -doc.createImage(fs.readFileSync("./demo/images/pizza.gif"), 200, 200, { +Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 200, 200, { floating: { horizontalPosition: { offset: 1014400, @@ -18,14 +20,27 @@ doc.createImage(fs.readFileSync("./demo/images/pizza.gif"), 200, 200, { By default with no arguments, its an `inline` image: ```ts -doc.createImage(fs.readFileSync("./demo/images/parrots.bmp")); +const image = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif")); ``` -You can also create images manually and add them later: +Add it into the document by adding the image into a paragraph: ```ts -const image = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif")); -doc.addImage(image); +doc.addSection({ + children: [new Paragraph(image)], +}); +``` + +Or: + +```ts +doc.addSection({ + children: [ + new Paragraph({ + children: [image], + }), + ], +}); ``` ## Intro @@ -34,15 +49,17 @@ Adding images can be done in two ways: 1. Call the `createImage` method to add the image directly into the `document`: - ```js - doc.createImage([IMAGE_BUFFER], [WIDTH], [HEIGHT], [POSITION_OPTIONS]); + ```ts + Media.addImage(doc, [IMAGE_BUFFER], [WIDTH], [HEIGHT], [POSITION_OPTIONS]); ``` 2. Create an `image` first, then add it into the `document`: ```ts const image = Media.addImage(doc, [IMAGE_BUFFER]); - doc.addImage(image); + doc.addSection({ + children: [new Paragraph(image)], + }); ``` `docx` supports `jpeg`, `jpg`, `bmp`, `gif` and `png` @@ -141,7 +158,7 @@ wrap: { For example: ```ts -doc.createImage(fs.readFileSync("./demo/images/pizza.gif"), 200, 200, { +Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 200, 200, { floating: { horizontalPosition: { offset: 2014400, @@ -184,7 +201,7 @@ margins: { For example: ```ts -doc.createImage(fs.readFileSync("./demo/images/pizza.gif"), 200, 200, { +Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 200, 200, { floating: { horizontalPosition: { offset: 2014400, @@ -210,7 +227,7 @@ doc.createImage(fs.readFileSync("./demo/images/pizza.gif"), 200, 200, { Importing Images from file system path -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo5.ts ':include') +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo5.ts ":include") _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo5.ts_ @@ -218,7 +235,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo5.ts_ Example showing how to add image to headers and footers -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo9.ts ':include') +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo9.ts ":include") _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo9.ts_ @@ -226,6 +243,6 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo9.ts_ Example showing how to float images on top of text and optimally give a `margin` -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo38.ts ':include') +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo38.ts ":include") _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo38.ts_ diff --git a/docs/usage/numbering.md b/docs/usage/numbering.md index ba8f10cdba..1f61c53dca 100644 --- a/docs/usage/numbering.md +++ b/docs/usage/numbering.md @@ -67,7 +67,7 @@ First you need to create a new numbering container class and use it to create your abstract numbering style, define your levels, and create your concrete numbering style: -```js +```ts const numbering = new docx.Numbering(); const abstractNum = numbering.createAbstractNumbering(); @@ -81,7 +81,7 @@ const concrete = numbering.createConcreteNumbering(abstractNum); You can then apply your concrete style to paragraphs using the `setNumbering` method: -```js +```ts topLevelP.setNumbering(concrete, 0); subP.setNumbering(concrete, 1); subSubP.setNumbering(concrete, 2); @@ -90,7 +90,7 @@ subSubP.setNumbering(concrete, 2); Finally, you need to let your exporter know about your numbering styles when you're ready to render the document: -```js +```ts const packer = new Packer(doc, undefined, undefined, numbering); packer.pack(myOutput); ``` diff --git a/docs/usage/packers.md b/docs/usage/packers.md index 11f107390d..e9b3626015 100644 --- a/docs/usage/packers.md +++ b/docs/usage/packers.md @@ -2,15 +2,50 @@ > Packers are the way in which `docx` turns your code into `.docx` format. It is completely decoupled from the `docx.Document`. -## Version 4 - 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. +## Version 5 + +Packers in `version 5` and above are now static methods on `Packer`. + ### Export as Buffer This will return a NodeJS `Buffer`. If this is used in the browser, it will return a `UInt8Array` instead. -```js +```ts +Packer.toBuffer(doc).then((buffer) => { + fs.writeFileSync("My Document.docx", buffer); +}); +``` + +### Export as a `base64` string + +```ts +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 +Packer.toBlob(doc).then((blob) => { + // saveAs from FileSaver will download the file + 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) => { @@ -20,7 +55,7 @@ packer.toBuffer(doc).then((buffer) => { ### Export as a `base64` string -```js +```ts const packer = new docx.Packer(); packer.toBase64String(doc).then((string) => { @@ -32,7 +67,7 @@ packer.toBase64String(doc).then((string) => { This is useful if you want to send it as an downloadable in a browser environment. -```js +```ts const packer = new docx.Packer(); packer.toBlob(doc).then((blob) => { @@ -45,7 +80,7 @@ packer.toBlob(doc).then((blob) => { ### File System Packer -```js +```ts const docx = require("docx"); const doc = new docx.Document(); @@ -56,7 +91,7 @@ exporter.pack("My Document"); ### Buffer Packer -```js +```ts const docx = require("docx"); const doc = new docx.Document(); @@ -68,7 +103,7 @@ const buffer = exporter.pack(); Creates a `node` `Readable` stream -```js +```ts const docx = require("docx"); const doc = new docx.Document(); @@ -88,7 +123,7 @@ 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: -```js +```ts const docx = require("docx"); const doc = new docx.Document(); @@ -107,7 +142,7 @@ where `res` is the response object obtained through the Express router. It is th You can export your word document as a PDF file like so: -```js +```ts const exporter = new docx.LocalPacker(doc); exporter.packPdf("My Document"); diff --git a/docs/usage/paragraph.md b/docs/usage/paragraph.md index 6864bd1e73..a398c82e40 100644 --- a/docs/usage/paragraph.md +++ b/docs/usage/paragraph.md @@ -2,28 +2,180 @@ > Everything (text, images, graphs etc) in OpenXML is organised in paragraphs. -## Example +!> Paragraphs requires an understanding of [Sections](usage/sections.md). -You can add more text to the paragraph by doing this: +You can create `Paragraphs` in the following ways: -```js -var paragraph = new docx.Paragraph(), +### Shorthand + +```ts +import { Paragraph } from "docx"; + +const paragraph = new Paragraph("Short hand Hello World"); ``` -```js -var text = new docx.TextRun("Lorem Ipsum Foo Bar"); -var paragraph = new docx.Paragraph(); -paragraph.addRun(text); +### Children Method + +This method is useful for adding different `text` with different styles or adding `images` inline. + +```ts +const paragraph = new Paragraph({ + children: [new TextRun("Lorem Ipsum Foo Bar"), new TextRun("Hello World")], +}); ``` -```js -var paragraph = new docx.Paragraph("Short hand notation for adding text."); +### Explicit + +```ts +const paragraph = new Paragraph({ + text: "Short hand notation for adding text.", +}); ``` -After you create the paragraph, you must add the paragraph into the `document`: +After you create the paragraph, you must add the paragraph into the `document's section`. Learn more about `sections` here: -```js -doc.addParagraph(paragraph); +```ts +doc.addSection({ + children: [paragraph], +}); +``` + +Or the preferred convension, define the paragraph inside the section and remove the usage of variables: + +```ts +doc.addSection({ + children: [ + new Paragraph({ + children: [new TextRun("Lorem Ipsum Foo Bar"), new TextRun("Hello World")], + }), + ], +}); +``` + +## Options + +This is the list of options for a paragraph. A detailed explanation is below: + +| Property | Type | Mandatory? | Possible Values | +| ----------------------------- | ------------------------------------------------------------------------------------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------- | +| [text](#text) | `string` | Optional | | +| [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 | +| [spacing](#spacing) | `ISpacingProperties` | Optional | See below for ISpacingProperties | +| [outlineLevel](#outline-level) | `number` | Optional | | +| alignment | `AlignmentType` | Optional | | +| heading | `HeadingLevel` | Optional | | +| bidirectional | `boolean` | Optional | | +| thematicBreak | `boolean` | Optional | | +| pageBreakBefore | `boolean` | Optional | | +| contextualSpacing | `boolean` | Optional | | +| indent | `IIndentAttributesProperties` | Optional | | +| keepLines | `boolean` | Optional | | +| keepNext | `boolean` | Optional | | +| children | `(TextRun or PictureRun or Hyperlink)[]` | Optional | | +| style | `string` | Optional | | +| tabStop | `{ left?: ITabStopOptions; right?: ITabStopOptions; maxRight?: { leader: LeaderType; }; center?: ITabStopOptions }` | Optional | | +| bullet | `{ level: number }` | Optional | | +| numbering | `{ num: Num; level: number; custom?: boolean }` | Optional | | + +## Text + +This is the text in a paragraph. You can also add text by using the `Paragraph` shorthand (mentioned above) or adding `children`. + +**Example:** + +```ts +const paragraph = new Paragraph({ + text: "Hello World", +}); +``` + +## Heading + +**Example:** + +Setting a Heading 1 paragraph with "Hello World" as it's text: + +```ts +const paragraph = new Paragraph({ + text: "Hello World", + heading: HeadingLevel.HEADING_1, +}); +``` + +## Border + +Add borders to a `Paragraph`. Good for making the `Paragraph` stand out + +#### IBorderPropertyOptions + +`top`, `bottom`, `left`, `right` of the border + +| Property | Type | Notes | +| -------- | -------- | -------- | +| color | `string` | Required | +| space | `number` | Required | +| value | `string` | Required | +| size | `number` | Required | + +**Example:** + +Add border on the top and the bottom of the paragraph + +```ts +const paragraph = new Paragraph({ + text: "I have borders on my top and bottom sides!", + border: { + top: { + color: "auto", + space: 1, + value: "single", + size: 6, + }, + bottom: { + color: "auto", + space: 1, + value: "single", + size: 6, + }, + }, +}); +``` + +## Spacing + +Adding spacing between paragraphs + +### ISpacingProperties + +| Property | Type | Notes | +| -------- | -------- | -------- | +| after | `number` | Optional | +| before | `number` | Optional | +| line | `number` | Optional | +| lineRule | `string` | Optional | + +**Example:** + +Add spacing before the paragraph: + +```ts +const paragraph = new Paragraph({ + text: "Paragraph with spacing before", + spacing: { + before: 200, + }, +}); +``` + +## Outline Level + +**Example:** + +```ts +const paragraph = new Paragraph({ + outlineLevel: 0, +}); ``` ## Styles @@ -32,46 +184,29 @@ To create styles, please refer to the styling Wiki: https://github.com/dolanmiu/ ![Word 2013 Styles menu](http://content.gcflearnfree.org/topics/233/style_apply_choose.png "Word 2013 Styles menu") -### Heading1 - Heading5 +### Headings and titles -```js -paragraph.heading1(); -paragraph.heading2(); -paragraph.heading3(); -paragraph.heading4(); -paragraph.heading5(); -``` +```ts +import { HeadingLevel, Paragraph } from "docx"; -### Title - -```js -paragraph.title(); +const paragraph = new Paragraph({ + text: "Hello World", + heading: HeadingLevel.TITLE, +}); ``` ## Text Alignment -To change the text alignment of a paragraph, for center, left, right or justified: +To change the text alignment of a paragraph, add an `AlignmentType` option on the paragraph.for center, left, right or justified: -```js -paragraph.center(); -``` +**Example:** -```js -paragraph.left(); -``` - -```js -paragraph.right(); -``` - -```js -paragraph.justified(); -``` - -### Example - -```js -paragraph.heading1().center(); +```ts +const paragraph = new Paragraph({ + text: "Hello World", + heading: HeadingLevel.HEADING_1, + alignment: AlignmentType.CENTER, +}); ``` The above will create a `heading 1` which is `centered`. @@ -94,10 +229,15 @@ The result is: ## Thematic Break -To add a break in the page, simply add `.thematicBreak()` on a paragraph: +To add a thematic break in the `Paragraph`: -```js -var paragraph = new docx.Paragraph("Amazing Heading").heading1().thematicBreak(); +```ts +const paragraph = new docx.Paragraph("Amazing Heading"); +const paragraph = new Paragraph({ + text: "Amazing Heading", + heading: HeadingLevel.HEADING_1, + thematicBreak: true, +}); ``` The above example will create a heading with a page break directly under it. @@ -106,8 +246,8 @@ The above example will create a heading with a page break directly under it. To move to a new page (insert a page break), simply add `.pageBreak()` on a paragraph: -```js -var paragraph = new docx.Paragraph("Amazing Heading").heading1().pageBreak(); +```ts +const paragraph = new docx.Paragraph("Amazing Heading").pageBreak(); ``` The above example will create a heading and start a new page immediately afterwards. @@ -116,8 +256,11 @@ The above example will create a heading and start a new page immediately afterwa This option (available in word) will make sure that the paragraph will start on a new page (if it's not already on a new page). -```js -var paragraph = new docx.Paragraph("Hello World on another page").pageBreakBefore(); +```ts +const paragraph = new Paragraph({ + text: "Hello World on another page", + pageBreakBefore: true, +}); ``` ![Page Break Before in Word](https://user-images.githubusercontent.com/34742290/40176503-df3a8398-59db-11e8-8b9c-d719f13aa8b4.png) diff --git a/docs/usage/sections.md b/docs/usage/sections.md new file mode 100644 index 0000000000..5b6d4e9c74 --- /dev/null +++ b/docs/usage/sections.md @@ -0,0 +1,21 @@ +# Sections + +> Every document is made up of one or more sections + +A section is a grouping of paragraphs that have a specific set of properties used to define the pages on which the text will appear. Properties include page size, page numbers, page orientation, headers, borders and margins. + +For example, you could have one section which is portrait with a header and footer, and another section in landscape with no footer, and a header showing the current page number. + +## Example + +This creates a simple section in a document with one paragraph inside: + +```ts +doc.addSection({ + children: [ + new Paragraph({ + children: [new TextRun("Hello World")], + }), + ], +}); +``` diff --git a/docs/usage/styling-with-js.md b/docs/usage/styling-with-js.md index f1f043cb1b..c39e7a7f40 100644 --- a/docs/usage/styling-with-js.md +++ b/docs/usage/styling-with-js.md @@ -2,7 +2,7 @@ ## Example -```js +```ts const para = new Paragraph("To whom it may concern:").heading2().center(); const name = new TextRun("Name:") @@ -56,7 +56,7 @@ Unlike CSS, less specific rules don't _necessarily_ override parent rules. The r 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 `Name:` 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: -```js +```ts const name = new TextRun("Name:") .bold() .font("Calibri") @@ -65,7 +65,7 @@ const name = new TextRun("Name:") Or for paragraph formatting: -```js +```ts const para = new Paragraph("To whom it may concern:").heading2().center(); ``` @@ -76,12 +76,12 @@ DOCX files contain a styles section separate from the main content, much like ho There are three parts to using custom styles with `docx`: 1. Create a container object for the style definitions: - ```js + ```ts const myStyles = new docx.Styles(); ``` 2. Define your custom styles, similar to the way you would format a paragraph or run - ```js + ```ts // The first argument is an ID you use to apply the style to paragraphs // The second argument is a human-friendly name to show in the UI myStyles @@ -106,9 +106,8 @@ There are three parts to using custom styles with `docx`: 3. When you generate your document, make sure to pass the `styles` container to the `Packer`: - ```js - const packer = new Packer(doc, myStyles); - packer.pack(myOutStream); + ```ts + Packer.pack(myOutStream); ``` **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. diff --git a/docs/usage/styling-with-xml.md b/docs/usage/styling-with-xml.md index 5f138d31d6..ee5a2b1db4 100644 --- a/docs/usage/styling-with-xml.md +++ b/docs/usage/styling-with-xml.md @@ -24,7 +24,7 @@ Read the styles using `fs`, and put it into the `Document` object in the constructor: -```js +```ts const styles = fs.readFileSync("./styles.xml", "utf-8"); const doc = new docx.Document({ title: "Title", @@ -34,12 +34,12 @@ const doc = new docx.Document({ You can use paragraphs, `heading1()`, `heading2()` etc and it will be styled according to your `styles.xml` created earlier. You can even use your new style you made by calling the `style` method: -```js +```ts doc.createParagraph("Cool Heading Text").heading1(); -let paragraph = new docx.Paragraph('This is a custom named style from the template "Cool New Style"'); +const paragraph = new docx.Paragraph('This is a custom named style from the template "Cool New Style"'); paragraph.style("Cool New Style"); -doc.addParagraph(paragraph); +doc.add(paragraph); doc.createParagraph("Some normal text"); ``` diff --git a/docs/usage/tab-stops.md b/docs/usage/tab-stops.md index aa15ea75a9..e172c7f9b0 100644 --- a/docs/usage/tab-stops.md +++ b/docs/usage/tab-stops.md @@ -10,45 +10,45 @@ Simply call the relevant methods on the paragraph listed below. Then just add a ## Example -```js -var paragraph = new docx.Paragraph().maxRightTabStop(); -var leftText = new docx.TextRun("Hey everyone").bold(); -var rightText = new docx.TextRun("11th November 2015").tab(); +```ts +const paragraph = new docx.Paragraph().maxRightTabStop(); +const leftText = new docx.TextRun("Hey everyone").bold(); +const rightText = new docx.TextRun("11th November 2015").tab(); paragraph.addRun(leftText); paragraph.addRun(rightText); ``` 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! -```js -var paragraph = new docx.Paragraph(); +```ts +const paragraph = new docx.Paragraph(); paragraph.maxRightTabStop(); paragraph.leftTabStop(1000); -var text = new docx.TextRun("Second tab stop here I come!").tab().tab(); +const text = new docx.TextRun("Second tab stop here I come!").tab().tab(); paragraph.addRun(text); ``` The above shows the use of two tab stops, and how to select/use it. ## Left Tab Stop -```js +```ts paragraph.leftTabStop(2268); ``` 2268 is the distance from the left side. ## Center Tab Stop -```js +```ts paragraph.centerTabStop(2268); ``` 2268 is the distance from the left side. ## Right Tab Stop -```js +```ts paragraph.rightTabStop(2268); ``` 2268 is the distance from the left side. ## Max Right Tab Stop -```js +```ts paragraph.maxRightTabStop(); ``` 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. diff --git a/docs/usage/table-of-contents.md b/docs/usage/table-of-contents.md index c1fb439143..53e8e7df57 100644 --- a/docs/usage/table-of-contents.md +++ b/docs/usage/table-of-contents.md @@ -12,7 +12,7 @@ The complete documentation can be found [here](https://www.ecma-international.or All you need to do is create a `TableOfContents` object and assign it to the document. -```js +```ts const toc = new TableOfContents("Summary", { hyperlink: true, headingStyleRange: "1-5", @@ -47,7 +47,7 @@ Here is the list of all options that you can use to generate your tables of cont ## Examples -```js +```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", { @@ -58,15 +58,15 @@ const toc = new TableOfContents("Summary", { doc.addTableOfContents(toc); -doc.addParagraph(new Paragraph("Header #1").heading1().pageBreakBefore()); -doc.addParagraph(new Paragraph("I'm a little text, very nicely written.'")); +doc.add(new Paragraph("Header #1").heading1().pageBreakBefore()); +doc.add(new Paragraph("I'm a little text, very nicely written.'")); -doc.addParagraph(new Paragraph("Header #2").heading1().pageBreakBefore()); -doc.addParagraph(new Paragraph("I'm another text very nicely written.'")); -doc.addParagraph(new Paragraph("Header #2.1").heading2()); -doc.addParagraph(new Paragraph("I'm another 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.addParagraph(new Paragraph("My Spectacular Style #1").style("MySpectacularStyle").pageBreakBefore()); +doc.add(new Paragraph("My Spectacular Style #1").style("MySpectacularStyle").pageBreakBefore()); ``` ### Complete example diff --git a/docs/usage/tables.md b/docs/usage/tables.md index ed669cfd18..70556ae028 100644 --- a/docs/usage/tables.md +++ b/docs/usage/tables.md @@ -4,28 +4,30 @@ You can create tables with `docx`. More information can be found [here](http://o ## Create Table -To create a table, simply use the `createTable()` method on a `document`. +To create a table, simply create one with `new Table()`, then add it to the document: `doc.add()`. ```ts -const table = doc.createTable([NUMBER OF ROWS], [NUMBER OF COLUMNS]); +const table = doc.add(new Table({ + rows: [NUMBER OF ROWS], + columns: [NUMBER OF COLUMNS] +}); ``` Alternatively, you can create a table object directly, and then add it in the `document` ```ts const table = new Table(4, 4); -doc.addTable(table); +doc.add(table); ``` The snippet below creates a table of 2 rows and 4 columns. ```ts -const table = doc.createTable(2, 4); - -// Or - -const table = new Table(2, 4); -doc.addTable(table); +const table = new Table({ + rows: 2, + columns: 4, +}); +doc.add(table); ``` ## Rows and Columns @@ -70,7 +72,7 @@ column.getCell(index); ## Cells -The `createTable()` method created a table with cells. To access the cell, use the `getCell()` method. +To access the cell, use the `getCell()` method. ```ts const cell = table.getCell([ROW INDEX], [COLUMN INDEX]); @@ -90,10 +92,10 @@ const cell = column.getCell(2); ### Add paragraph to a cell -Once you have got the cell, you can add data to it with the `addParagraph()` method. +Once you have got the cell, you can add data to it with the `add()` method. ```ts -cell.addParagraph(new Paragraph("Hello")); +cell.add(new Paragraph("Hello")); ``` ### Set width of a cell @@ -103,10 +105,11 @@ You can specify the width of a cell using: `cell.Properties.setWidth(width, format)` format can be: -* WidthType.AUTO -* WidthType.DXA: value is in twentieths of a point -* WidthType.NIL: is considered as zero -* WidthType.PCT: percent of table width + +- WidthType.AUTO +- WidthType.DXA: value is in twentieths of a point +- WidthType.NIL: is considered as zero +- WidthType.PCT: percent of table width ### Example @@ -115,7 +118,7 @@ cell.Properties.setWidth(100, WidthType.DXA); ``` ```ts -cell.Properties.setWidth('50%', WidthType.PCT); +cell.Properties.setWidth("50%", WidthType.PCT); ``` ## Borders @@ -223,7 +226,7 @@ It has not been implemented yet, but it will follow a similar structure as mergi To have a table within a table ```ts -cell.addTable(new Table(1, 1)); +cell.add(new Table(1, 1)); ``` ## Pagination @@ -241,11 +244,10 @@ If a table is paginated on multiple pages, it is possible to repeat a row at the ```ts table.getRow(0).setTableHeader(); ``` - ## Examples -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo4.ts ':include') +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo4.ts ":include") _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo4.ts_ @@ -253,7 +255,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo4.ts_ Example showing how to add colourful borders to tables -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo20.ts ':include') +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo20.ts ":include") _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo20.ts_ @@ -261,11 +263,11 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo20.ts_ Example showing how to add images to tables -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo24.ts ':include') +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo24.ts ":include") _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo24.ts_ -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo36.ts ':include') +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo36.ts ":include") _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo36.ts_ @@ -273,7 +275,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo36.ts_ Example showing how align text in a table cell -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo31.ts ':include') +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo31.ts ":include") _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo31.ts_ @@ -281,11 +283,11 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo31.ts_ Example showing merging of `rows` -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo32.ts ':include') +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo32.ts ":include") _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo32.ts_ -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo41.ts ':include') +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo41.ts ":include") _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo41.ts_ @@ -293,13 +295,12 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo41.ts_ Example showing merging of `columns` -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo43.ts ':include') +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo43.ts ":include") _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo43.ts_ ### Floating tables -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo34.ts ':include') +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo34.ts ":include") _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo34.ts_ - diff --git a/docs/usage/text.md b/docs/usage/text.md index faa2bdf2d5..6cbd9da224 100644 --- a/docs/usage/text.md +++ b/docs/usage/text.md @@ -1,10 +1,15 @@ -# Text +# Text Runs -Paragraphs need `text run` objects. To create text: +!> TextRuns requires an understanding of [Paragraphs](usage/paragraph.md). -```js -var text = new docx.TextRun("My awesome text here for my university dissertation"); -paragraph.addRun(text); +You can add multiple `text runs` in `Paragraphs`. This is the most verbose way of writing a `Paragraph` but it is also the most flexible: + +```ts +import { Paragraph, TextRun } from "docx"; + +const paragraph = new Paragraph({ + children: [new TextRun("My awesome text here for my university dissertation"), new TextRun("Foo Bar")], +}); ``` Text objects have methods inside which changes the way the text is displayed. @@ -15,55 +20,87 @@ More info [here](https://english.stackexchange.com/questions/97081/what-is-the-t ### Bold -```js -text.bold(); +```ts +const text = new TextRun({ + text: "Foo Bar", + bold: true, +}); ``` ### Italics -```js -text.italics(); +```ts +const text = new TextRun({ + text: "Foo Bar", + italics: true, +}); ``` ### Underline -```js -text.underline(); +Underline has a few options + +#### Options + +| Property | Type | Notes | Possible Values | +| -------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| type | `UnderlineType` | Optional | SINGLE, WORD, DOUBLE, THICK, DOTTED, DOTTEDHEAV, DASH, DASHEDHEAV, DASHLONG, DASHLONGHEAV, DOTDASH, DASHDOTHEAVY, DOTDOTDAS, DASHDOTDOTHEAVY, WAVE, WAVYHEAVY, WAVYDOUBLE | +| color | `string` | Optional | Color Hex values | + +**Example:** + +```ts +const text = new TextRun({ + text: "and then underlined ", + underline: { + type: UnderlineType.DOUBLE, + color: "990011", + }, +}); +``` + +To do a simple vanilla underline: + +```ts +const text = new TextRun({ + text: "and then underlined ", + underline: {}, +}); ``` ### Strike through -```js +```ts text.strike(); ``` ### Double strike through -```js +```ts text.doubleStrike(); ``` ### Superscript -```js +```ts text.superScript(); ``` ### Subscript -```js +```ts text.subScript(); ``` ### All Capitals -```js +```ts text.allCaps(); ``` ### Small Capitals -```js +```ts text.smallCaps(); ``` @@ -71,7 +108,7 @@ text.smallCaps(); Sometimes you would want to put text underneath another line of text but inside the same paragraph. -```js +```ts text.break(); ``` @@ -79,6 +116,6 @@ text.break(); What if you want to create a paragraph which is **_bold_** and **_italic_**? -```js +```ts paragraph.bold().italics(); ``` diff --git a/package.json b/package.json index 965a8b51e9..ea3be1ab15 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "docx", - "version": "5.0.0-rc4", + "version": "5.0.0-rc5", "description": "Generate .docx documents with JavaScript (formerly Office-Clippy)", "main": "build/index.js", "scripts": { @@ -68,7 +68,7 @@ "@types/webpack": "^4.4.24", "awesome-typescript-loader": "^3.4.1", "chai": "^3.5.0", - "docsify": "^4.9.1", + "docsify-cli": "^4.3.0", "glob": "^7.1.2", "istanbul-instrumenter-loader": "^3.0.1", "jszip": "^3.1.5", diff --git a/src/export/formatter.spec.ts b/src/export/formatter.spec.ts index f8c1b457f0..bd6c9b7160 100644 --- a/src/export/formatter.spec.ts +++ b/src/export/formatter.spec.ts @@ -14,23 +14,28 @@ describe("Formatter", () => { describe("#format()", () => { it("should format simple paragraph", () => { - const paragraph = new file.Paragraph(); + const paragraph = new file.Paragraph(""); const newJson = formatter.format(paragraph); assert.isDefined(newJson["w:p"]); }); it("should remove xmlKeys", () => { - const paragraph = new file.Paragraph(); + const paragraph = new file.Paragraph(""); const newJson = formatter.format(paragraph); const stringifiedJson = JSON.stringify(newJson); assert(stringifiedJson.indexOf("xmlKeys") < 0); }); it("should format simple paragraph with bold text", () => { - const paragraph = new file.Paragraph(); - paragraph.addRun(new file.TextRun("test").bold()); + const paragraph = new file.Paragraph(""); + paragraph.addRun( + new file.TextRun({ + text: "test", + bold: true, + }), + ); const newJson = formatter.format(paragraph); - assert.isDefined(newJson["w:p"][0]["w:r"][0]["w:rPr"][0]["w:b"]._attr["w:val"]); + assert.isDefined(newJson["w:p"][1]["w:r"][0]["w:rPr"][0]["w:b"]._attr["w:val"]); }); it("should format attributes (rsidSect)", () => { @@ -58,7 +63,7 @@ describe("Formatter", () => { }); it("should should change 'p' tag into 'w:p' tag", () => { - const paragraph = new file.Paragraph(); + const paragraph = new file.Paragraph(""); const newJson = formatter.format(paragraph); assert.isDefined(newJson["w:p"]); }); diff --git a/src/export/packer/next-compiler.spec.ts b/src/export/packer/next-compiler.spec.ts index dec853ba68..ac271c02d9 100644 --- a/src/export/packer/next-compiler.spec.ts +++ b/src/export/packer/next-compiler.spec.ts @@ -1,7 +1,7 @@ /* tslint:disable:typedef space-before-function-paren */ import { expect } from "chai"; -import { File } from "file"; +import { File, Footer, Header } from "file"; import { Compiler } from "./next-compiler"; @@ -21,28 +21,39 @@ describe("Compiler", () => { const fileNames = Object.keys(zipFile.files).map((f) => zipFile.files[f].name); expect(fileNames).is.an.instanceof(Array); - expect(fileNames).has.length(18); + expect(fileNames).has.length(14); expect(fileNames).to.include("word/document.xml"); expect(fileNames).to.include("word/styles.xml"); expect(fileNames).to.include("docProps/core.xml"); expect(fileNames).to.include("docProps/app.xml"); expect(fileNames).to.include("word/numbering.xml"); - expect(fileNames).to.include("word/header1.xml"); - expect(fileNames).to.include("word/_rels/header1.xml.rels"); - expect(fileNames).to.include("word/footer1.xml"); expect(fileNames).to.include("word/footnotes.xml"); expect(fileNames).to.include("word/settings.xml"); - expect(fileNames).to.include("word/_rels/footer1.xml.rels"); expect(fileNames).to.include("word/_rels/document.xml.rels"); expect(fileNames).to.include("[Content_Types].xml"); expect(fileNames).to.include("_rels/.rels"); }); it("should pack all additional headers and footers", async function() { - file.createFooter(); - file.createFooter(); - file.createHeader(); - file.createHeader(); + file.addSection({ + headers: { + default: new Header(), + }, + footers: { + default: new Footer(), + }, + children: [], + }); + + file.addSection({ + headers: { + default: new Header(), + }, + footers: { + default: new Footer(), + }, + children: [], + }); this.timeout(99999999); @@ -50,20 +61,16 @@ describe("Compiler", () => { const fileNames = Object.keys(zipFile.files).map((f) => zipFile.files[f].name); expect(fileNames).is.an.instanceof(Array); - expect(fileNames).has.length(26); + expect(fileNames).has.length(22); expect(fileNames).to.include("word/header1.xml"); expect(fileNames).to.include("word/_rels/header1.xml.rels"); expect(fileNames).to.include("word/header2.xml"); expect(fileNames).to.include("word/_rels/header2.xml.rels"); - expect(fileNames).to.include("word/header3.xml"); - expect(fileNames).to.include("word/_rels/header3.xml.rels"); expect(fileNames).to.include("word/footer1.xml"); expect(fileNames).to.include("word/_rels/footer1.xml.rels"); expect(fileNames).to.include("word/footer2.xml"); expect(fileNames).to.include("word/_rels/footer2.xml.rels"); - expect(fileNames).to.include("word/footer3.xml"); - expect(fileNames).to.include("word/_rels/footer3.xml.rels"); }); }); }); diff --git a/src/export/packer/next-compiler.ts b/src/export/packer/next-compiler.ts index a2a09c3a8b..426d32174f 100644 --- a/src/export/packer/next-compiler.ts +++ b/src/export/packer/next-compiler.ts @@ -30,17 +30,15 @@ interface IXmlifyedFileMapping { export class Compiler { private readonly formatter: Formatter; private readonly imageReplacer: ImageReplacer; - private readonly prettifyXml?: boolean; - constructor(prettifyXml?: boolean) { + constructor() { this.formatter = new Formatter(); this.imageReplacer = new ImageReplacer(); - this.prettifyXml = prettifyXml; } - public compile(file: File): JSZip { + public compile(file: File, prettifyXml?: boolean): JSZip { const zip = new JSZip(); - const xmlifiedFileMapping = this.xmlifyFile(file); + const xmlifiedFileMapping = this.xmlifyFile(file, prettifyXml); for (const key in xmlifiedFileMapping) { if (!xmlifiedFileMapping[key]) { @@ -66,14 +64,14 @@ export class Compiler { return zip; } - private xmlifyFile(file: File): IXmlifyedFileMapping { + private xmlifyFile(file: File, prettify?: boolean): IXmlifyedFileMapping { file.verifyUpdateFields(); const documentRelationshipCount = file.DocumentRelationships.RelationshipCount + 1; return { Relationships: { data: (() => { - const xmlData = xml(this.formatter.format(file.Document), this.prettifyXml); + const xmlData = xml(this.formatter.format(file.Document), prettify); const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media); mediaDatas.forEach((mediaData, i) => { @@ -84,13 +82,13 @@ export class Compiler { ); }); - return xml(this.formatter.format(file.DocumentRelationships), this.prettifyXml); + return xml(this.formatter.format(file.DocumentRelationships), prettify); })(), path: "word/_rels/document.xml.rels", }, Document: { data: (() => { - const tempXmlData = xml(this.formatter.format(file.Document), this.prettifyXml); + const tempXmlData = xml(this.formatter.format(file.Document), prettify); const mediaDatas = this.imageReplacer.getMediaData(tempXmlData, file.Media); const xmlData = this.imageReplacer.replace(tempXmlData, mediaDatas, documentRelationshipCount); @@ -99,7 +97,7 @@ export class Compiler { path: "word/document.xml", }, Styles: { - data: xml(this.formatter.format(file.Styles), this.prettifyXml), + data: xml(this.formatter.format(file.Styles), prettify), path: "word/styles.xml", }, Properties: { @@ -112,15 +110,15 @@ export class Compiler { path: "docProps/core.xml", }, Numbering: { - data: xml(this.formatter.format(file.Numbering), this.prettifyXml), + data: xml(this.formatter.format(file.Numbering), prettify), path: "word/numbering.xml", }, FileRelationships: { - data: xml(this.formatter.format(file.FileRelationships), this.prettifyXml), + data: xml(this.formatter.format(file.FileRelationships), prettify), path: "_rels/.rels", }, HeaderRelationships: file.Headers.map((headerWrapper, index) => { - const xmlData = xml(this.formatter.format(headerWrapper.Header), this.prettifyXml); + const xmlData = xml(this.formatter.format(headerWrapper.Header), prettify); const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media); mediaDatas.forEach((mediaData, i) => { @@ -132,12 +130,12 @@ export class Compiler { }); return { - data: xml(this.formatter.format(headerWrapper.Relationships), this.prettifyXml), + data: xml(this.formatter.format(headerWrapper.Relationships), prettify), path: `word/_rels/header${index + 1}.xml.rels`, }; }), FooterRelationships: file.Footers.map((footerWrapper, index) => { - const xmlData = xml(this.formatter.format(footerWrapper.Footer), this.prettifyXml); + const xmlData = xml(this.formatter.format(footerWrapper.Footer), prettify); const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media); mediaDatas.forEach((mediaData, i) => { @@ -149,12 +147,12 @@ export class Compiler { }); return { - data: xml(this.formatter.format(footerWrapper.Relationships), this.prettifyXml), + data: xml(this.formatter.format(footerWrapper.Relationships), prettify), path: `word/_rels/footer${index + 1}.xml.rels`, }; }), Headers: file.Headers.map((headerWrapper, index) => { - const tempXmlData = xml(this.formatter.format(headerWrapper.Header), this.prettifyXml); + const tempXmlData = xml(this.formatter.format(headerWrapper.Header), prettify); const mediaDatas = this.imageReplacer.getMediaData(tempXmlData, file.Media); // TODO: 0 needs to be changed when headers get relationships of their own const xmlData = this.imageReplacer.replace(tempXmlData, mediaDatas, 0); @@ -165,7 +163,7 @@ export class Compiler { }; }), Footers: file.Footers.map((footerWrapper, index) => { - const tempXmlData = xml(this.formatter.format(footerWrapper.Footer), this.prettifyXml); + const tempXmlData = xml(this.formatter.format(footerWrapper.Footer), prettify); const mediaDatas = this.imageReplacer.getMediaData(tempXmlData, file.Media); // TODO: 0 needs to be changed when headers get relationships of their own const xmlData = this.imageReplacer.replace(tempXmlData, mediaDatas, 0); @@ -176,19 +174,19 @@ export class Compiler { }; }), ContentTypes: { - data: xml(this.formatter.format(file.ContentTypes), this.prettifyXml), + data: xml(this.formatter.format(file.ContentTypes), prettify), path: "[Content_Types].xml", }, AppProperties: { - data: xml(this.formatter.format(file.AppProperties), this.prettifyXml), + data: xml(this.formatter.format(file.AppProperties), prettify), path: "docProps/app.xml", }, FootNotes: { - data: xml(this.formatter.format(file.FootNotes), this.prettifyXml), + data: xml(this.formatter.format(file.FootNotes), prettify), path: "word/footnotes.xml", }, Settings: { - data: xml(this.formatter.format(file.Settings), this.prettifyXml), + data: xml(this.formatter.format(file.Settings), prettify), path: "word/settings.xml", }, }; diff --git a/src/export/packer/packer.spec.ts b/src/export/packer/packer.spec.ts index b61165ab46..8235649f15 100644 --- a/src/export/packer/packer.spec.ts +++ b/src/export/packer/packer.spec.ts @@ -2,12 +2,11 @@ import { assert } from "chai"; import { stub } from "sinon"; -import { File, Paragraph } from "file"; +import { File, HeadingLevel, Paragraph } from "file"; import { Packer } from "./packer"; describe("Packer", () => { - let packer: Packer; let file: File; beforeEach(() => { @@ -16,21 +15,30 @@ describe("Packer", () => { revision: "1", lastModifiedBy: "Dolan Miu", }); - const paragraph = new Paragraph("test text"); - const heading = new Paragraph("Hello world").heading1(); - file.addParagraph(new Paragraph("title").title()); - file.addParagraph(heading); - file.addParagraph(new Paragraph("heading 2").heading2()); - file.addParagraph(paragraph); - - packer = new Packer(); + file.addSection({ + children: [ + new Paragraph({ + text: "title", + heading: HeadingLevel.TITLE, + }), + new Paragraph({ + text: "Hello world", + heading: HeadingLevel.HEADING_1, + }), + new Paragraph({ + text: "heading 2", + heading: HeadingLevel.HEADING_2, + }), + new Paragraph("test text"), + ], + }); }); describe("#toBuffer()", () => { it("should create a standard docx file", async function() { this.timeout(99999999); - const buffer = await packer.toBuffer(file); + const buffer = await Packer.toBuffer(file); assert.isDefined(buffer); assert.isTrue(buffer.byteLength > 0); @@ -38,19 +46,24 @@ describe("Packer", () => { it("should handle exception if it throws any", () => { // tslint:disable-next-line:no-any - const compiler = stub((packer as any).compiler, "compile"); + const compiler = stub((Packer as any).compiler, "compile"); compiler.throwsException(); - return packer.toBuffer(file).catch((error) => { + return Packer.toBuffer(file).catch((error) => { assert.isDefined(error); }); }); + + after(() => { + // tslint:disable-next-line:no-any + (Packer as any).compiler.compile.restore(); + }); }); describe("#toBase64String()", () => { it("should create a standard docx file", async function() { this.timeout(99999999); - const str = await packer.toBase64String(file); + const str = await Packer.toBase64String(file); assert.isDefined(str); assert.isTrue(str.length > 0); @@ -58,12 +71,17 @@ describe("Packer", () => { it("should handle exception if it throws any", () => { // tslint:disable-next-line:no-any - const compiler = stub((packer as any).compiler, "compile"); + const compiler = stub((Packer as any).compiler, "compile"); compiler.throwsException(); - return packer.toBase64String(file).catch((error) => { + return Packer.toBase64String(file).catch((error) => { assert.isDefined(error); }); }); + + after(() => { + // tslint:disable-next-line:no-any + (Packer as any).compiler.compile.restore(); + }); }); }); diff --git a/src/export/packer/packer.ts b/src/export/packer/packer.ts index a6c0f33cc4..24c29491ce 100644 --- a/src/export/packer/packer.ts +++ b/src/export/packer/packer.ts @@ -2,39 +2,38 @@ import { File } from "file"; import { Compiler } from "./next-compiler"; export class Packer { - private readonly compiler: Compiler; - - constructor(prettifyXml?: boolean) { - this.compiler = new Compiler(prettifyXml); - } - - public async toBuffer(file: File): Promise { - const zip = this.compiler.compile(file); + public static async toBuffer(file: File, prettify?: boolean): Promise { + const zip = this.compiler.compile(file, prettify); const zipData = (await zip.generateAsync({ type: "nodebuffer", mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document", + compression: "DEFLATE", })) as Buffer; return zipData; } - public async toBase64String(file: File): Promise { - const zip = this.compiler.compile(file); + public static async toBase64String(file: File, prettify?: boolean): Promise { + const zip = this.compiler.compile(file, prettify); const zipData = (await zip.generateAsync({ type: "base64", mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document", + compression: "DEFLATE", })) as string; return zipData; } - public async toBlob(file: File): Promise { - const zip = this.compiler.compile(file); + public static async toBlob(file: File, prettify?: boolean): Promise { + const zip = this.compiler.compile(file, prettify); const zipData = (await zip.generateAsync({ type: "blob", mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document", + compression: "DEFLATE", })) as Blob; return zipData; } + + private static readonly compiler = new Compiler(); } diff --git a/src/file/document/body/body.spec.ts b/src/file/document/body/body.spec.ts index 6eb8cdddad..a5bc222fb4 100644 --- a/src/file/document/body/body.spec.ts +++ b/src/file/document/body/body.spec.ts @@ -11,35 +11,7 @@ describe("Body", () => { body = new Body(); }); - describe("#constructor()", () => { - it("should create default section", () => { - const formatted = new Formatter().format(body)["w:body"][0]; - expect(formatted) - .to.have.property("w:sectPr") - .and.to.be.an.instanceof(Array); - expect(formatted["w:sectPr"]).to.have.length(4); - }); - }); - describe("#addSection", () => { - it("should add section with options", () => { - body.addSection({ - width: 10000, - height: 10000, - }); - - const formatted = new Formatter().format(body)["w:body"]; - expect(formatted).to.be.an.instanceof(Array); - const defaultSectionPr = formatted[0]["w:p"][0]["w:pPr"][0]["w:sectPr"]; - - // check that this is the default section and added first in paragraph - expect(defaultSectionPr[0]).to.deep.equal({ "w:pgSz": { _attr: { "w:h": 16838, "w:w": 11906, "w:orient": "portrait" } } }); - - // check for new section (since it's the last one, it's direct child of body) - const newSection = formatted[1]["w:sectPr"]; - expect(newSection[0]).to.deep.equal({ "w:pgSz": { _attr: { "w:h": 10000, "w:w": 10000, "w:orient": "portrait" } } }); - }); - it("should add section with default parameters", () => { body.addSection({ width: 10000, @@ -51,33 +23,7 @@ describe("Body", () => { expect(tree).to.deep.equal({ "w:body": [ { - "w:p": [ - { - "w:pPr": [ - { - "w:sectPr": [ - { "w:pgSz": { _attr: { "w:w": 11906, "w:h": 16838, "w:orient": "portrait" } } }, - { - "w:pgMar": { - _attr: { - "w:top": 1440, - "w:right": 1440, - "w:bottom": 1440, - "w:left": 1440, - "w:header": 708, - "w:footer": 708, - "w:gutter": 0, - "w:mirrorMargins": false, - }, - }, - }, - { "w:cols": { _attr: { "w:space": 708, "w:num": 1 } } }, - { "w:docGrid": { _attr: { "w:linePitch": 360 } } }, - ], - }, - ], - }, - ], + "w:p": {}, }, { "w:sectPr": [ @@ -104,21 +50,4 @@ describe("Body", () => { }); }); }); - - describe("#getParagraphs", () => { - it("should get no paragraphs", () => { - const paragraphs = body.getParagraphs(); - - expect(paragraphs).to.be.an.instanceof(Array); - }); - }); - - describe("#DefaultSection", () => { - it("should get section", () => { - const section = body.DefaultSection; - - const tree = new Formatter().format(section); - expect(tree["w:sectPr"]).to.be.an.instanceof(Array); - }); - }); }); diff --git a/src/file/document/body/body.ts b/src/file/document/body/body.ts index fb8a187645..e91b72d59a 100644 --- a/src/file/document/body/body.ts +++ b/src/file/document/body/body.ts @@ -3,15 +3,10 @@ import { Paragraph, ParagraphProperties, TableOfContents } from "../.."; import { SectionProperties, SectionPropertiesOptions } from "./section-properties/section-properties"; export class Body extends XmlComponent { - private readonly defaultSection: SectionProperties; - private readonly sections: SectionProperties[] = []; - constructor(sectionPropertiesOptions?: SectionPropertiesOptions) { + constructor() { super("w:body"); - - this.defaultSection = new SectionProperties(sectionPropertiesOptions); - this.sections.push(this.defaultSection); } /** @@ -20,21 +15,15 @@ export class Body extends XmlComponent { * The spec says: * - section element should be in the last paragraph of the section * - last section should be direct child of body - * @param section new section + * @param options new section options */ - public addSection(section: SectionPropertiesOptions | SectionProperties): void { + public addSection(options: SectionPropertiesOptions): void { const currentSection = this.sections.pop() as SectionProperties; this.root.push(this.createSectionParagraph(currentSection)); - if (section instanceof SectionProperties) { - this.sections.push(section); - } else { - const params = { - ...this.defaultSection.Options, - ...section, - }; - this.sections.push(new SectionProperties(params)); - } + + this.sections.push(new SectionProperties(options)); } + public prepForXml(): IXmlableObject | undefined { if (this.sections.length === 1) { this.root.push(this.sections.pop() as SectionProperties); @@ -47,21 +36,13 @@ export class Body extends XmlComponent { this.root.push(component); } - public get DefaultSection(): SectionProperties { - return this.defaultSection; - } - public getTablesOfContents(): TableOfContents[] { return this.root.filter((child) => child instanceof TableOfContents) as TableOfContents[]; } - public getParagraphs(): Paragraph[] { - return this.root.filter((child) => child instanceof Paragraph) as Paragraph[]; - } - private createSectionParagraph(section: SectionProperties): Paragraph { - const paragraph = new Paragraph(); - const properties = new ParagraphProperties(); + const paragraph = new Paragraph({}); + const properties = new ParagraphProperties({}); properties.addChildElement(section); paragraph.addChildElement(properties); return paragraph; diff --git a/src/file/document/body/section-properties/header-reference/header-reference.ts b/src/file/document/body/section-properties/header-reference/header-reference.ts index 8f89ea09b3..b1bc4ef4f4 100644 --- a/src/file/document/body/section-properties/header-reference/header-reference.ts +++ b/src/file/document/body/section-properties/header-reference/header-reference.ts @@ -1,13 +1,13 @@ import { XmlComponent } from "file/xml-components"; import { HeaderReferenceAttributes, HeaderReferenceType } from "./header-reference-attributes"; -export interface IHeaderOptions { +export interface IHeaderReferenceOptions { readonly headerType?: HeaderReferenceType; readonly headerId?: number; } export class HeaderReference extends XmlComponent { - constructor(options: IHeaderOptions) { + constructor(options: IHeaderReferenceOptions) { super("w:headerReference"); this.root.push( new HeaderReferenceAttributes({ diff --git a/src/file/document/document.spec.ts b/src/file/document/document.spec.ts index 111d42efdf..dba489601e 100644 --- a/src/file/document/document.spec.ts +++ b/src/file/document/document.spec.ts @@ -1,9 +1,7 @@ -import { assert, expect } from "chai"; +import { expect } from "chai"; import { Formatter } from "export/formatter"; -import { Paragraph } from "../paragraph"; -import { Table } from "../table"; import { Document } from "./document"; describe("Document", () => { @@ -15,81 +13,34 @@ describe("Document", () => { describe("#constructor()", () => { it("should create valid JSON", () => { - const stringifiedJson = JSON.stringify(document); + const tree = new Formatter().format(document); - try { - JSON.parse(stringifiedJson); - } catch (e) { - assert.isTrue(false); - } - assert.isTrue(true); - }); - - it("should create default section", () => { - const body = new Formatter().format(document)["w:document"][1]["w:body"]; - expect(body[0]).to.have.property("w:sectPr"); - }); - }); - - describe("#createParagraph", () => { - it("should create a new paragraph and append it to body", () => { - const para = document.createParagraph(); - expect(para).to.be.an.instanceof(Paragraph); - const body = new Formatter().format(document)["w:document"][1]["w:body"]; - expect(body) - .to.be.an("array") - .which.has.length.at.least(1); - expect(body[0]).to.have.property("w:p"); - }); - - it("should use the text given to create a run in the paragraph", () => { - const para = document.createParagraph("sample paragraph text"); - expect(para).to.be.an.instanceof(Paragraph); - const body = new Formatter().format(document)["w:document"][1]["w:body"]; - expect(body) - .to.be.an("array") - .which.has.length.at.least(1); - expect(body[0]) - .to.have.property("w:p") - .which.includes({ - "w:r": [{ "w:t": [{ _attr: { "xml:space": "preserve" } }, "sample paragraph text"] }], - }); - }); - }); - - describe("#createTable", () => { - it("should create a new table and append it to body", () => { - const table = document.createTable({ - rows: 2, - columns: 3, + expect(tree).to.deep.equal({ + "w:document": [ + { + _attr: { + "xmlns:wpc": "http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas", + "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:m": "http://schemas.openxmlformats.org/officeDocument/2006/math", + "xmlns:v": "urn:schemas-microsoft-com:vml", + "xmlns:wp14": "http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing", + "xmlns:wp": "http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing", + "xmlns:w10": "urn:schemas-microsoft-com:office:word", + "xmlns:w": "http://schemas.openxmlformats.org/wordprocessingml/2006/main", + "xmlns:w14": "http://schemas.microsoft.com/office/word/2010/wordml", + "xmlns:w15": "http://schemas.microsoft.com/office/word/2012/wordml", + "xmlns:wpg": "http://schemas.microsoft.com/office/word/2010/wordprocessingGroup", + "xmlns:wpi": "http://schemas.microsoft.com/office/word/2010/wordprocessingInk", + "xmlns:wne": "http://schemas.microsoft.com/office/word/2006/wordml", + "xmlns:wps": "http://schemas.microsoft.com/office/word/2010/wordprocessingShape", + "mc:Ignorable": "w14 w15 wp14", + }, + }, + { "w:body": {} }, + ], }); - expect(table).to.be.an.instanceof(Table); - const body = new Formatter().format(document)["w:document"][1]["w:body"]; - expect(body) - .to.be.an("array") - .which.has.length.at.least(1); - expect(body[0]).to.have.property("w:tbl"); - }); - - it("should create a table with the correct dimensions", () => { - document.createTable({ - rows: 2, - columns: 3, - }); - const body = new Formatter().format(document)["w:document"][1]["w:body"]; - expect(body) - .to.be.an("array") - .which.has.length.at.least(1); - expect(body[0]) - .to.have.property("w:tbl") - .which.includes({ - "w:tblGrid": [ - { "w:gridCol": { _attr: { "w:w": 100 } } }, - { "w:gridCol": { _attr: { "w:w": 100 } } }, - { "w:gridCol": { _attr: { "w:w": 100 } } }, - ], - }); - expect(body[0]["w:tbl"].filter((x) => x["w:tr"])).to.have.length(2); }); }); }); diff --git a/src/file/document/document.ts b/src/file/document/document.ts index e9a0e71c27..d8c0c55131 100644 --- a/src/file/document/document.ts +++ b/src/file/document/document.ts @@ -1,16 +1,15 @@ // http://officeopenxml.com/WPdocument.php import { XmlComponent } from "file/xml-components"; import { Paragraph } from "../paragraph"; -import { ITableOptions, Table } from "../table"; +import { Table } from "../table"; import { TableOfContents } from "../table-of-contents"; import { Body } from "./body"; -import { SectionPropertiesOptions } from "./body/section-properties"; import { DocumentAttributes } from "./document-attributes"; export class Document extends XmlComponent { private readonly body: Body; - constructor(sectionPropertiesOptions?: SectionPropertiesOptions) { + constructor() { super("w:document"); this.root.push( new DocumentAttributes({ @@ -33,37 +32,15 @@ export class Document extends XmlComponent { Ignorable: "w14 w15 wp14", }), ); - this.body = new Body(sectionPropertiesOptions); + this.body = new Body(); this.root.push(this.body); } - public addParagraph(paragraph: Paragraph): Document { - this.body.push(paragraph); + public add(item: Paragraph | Table | TableOfContents): Document { + this.body.push(item); return this; } - public addTableOfContents(toc: TableOfContents): Document { - this.body.push(toc); - return this; - } - - public createParagraph(text?: string): Paragraph { - const para = new Paragraph(text); - this.addParagraph(para); - return para; - } - - public addTable(table: Table): Document { - this.body.push(table); - return this; - } - - public createTable(options: ITableOptions): Table { - const table = new Table(options); - this.addTable(table); - return table; - } - public get Body(): Body { return this.body; } @@ -71,8 +48,4 @@ export class Document extends XmlComponent { public getTablesOfContents(): TableOfContents[] { return this.body.getTablesOfContents(); } - - public getParagraphs(): Paragraph[] { - return this.body.getParagraphs(); - } } diff --git a/src/file/file.spec.ts b/src/file/file.spec.ts index 1ceb87cd85..dae4af33fb 100644 --- a/src/file/file.spec.ts +++ b/src/file/file.spec.ts @@ -4,23 +4,37 @@ import * as sinon from "sinon"; import { Formatter } from "export/formatter"; import { File } from "./file"; +import { Footer, Header } from "./header"; import { Paragraph } from "./paragraph"; import { Table } from "./table"; +import { TableOfContents } from "./table-of-contents"; describe("File", () => { describe("#constructor", () => { + it("should create with correct headers and footers by default", () => { + const doc = new File(); + + doc.addSection({ + children: [], + }); + + const tree = new Formatter().format(doc.Document.Body); + + expect(tree["w:body"][1]["w:sectPr"][4]["w:headerReference"]._attr["w:type"]).to.equal("default"); + expect(tree["w:body"][1]["w:sectPr"][5]["w:footerReference"]._attr["w:type"]).to.equal("default"); + }); + it("should create with correct headers and footers", () => { const doc = new File(); - const header = doc.createHeader(); - const footer = doc.createFooter(); doc.addSection({ headers: { - default: header, + default: new Header(), }, footers: { - default: footer, + default: new Footer(), }, + children: [], }); const tree = new Formatter().format(doc.Document.Body); @@ -31,40 +45,38 @@ describe("File", () => { it("should create with first headers and footers", () => { const doc = new File(); - const header = doc.createHeader(); - const footer = doc.createFooter(); doc.addSection({ headers: { - first: header, + first: new Header(), }, footers: { - first: footer, + first: new Footer(), }, + children: [], }); const tree = new Formatter().format(doc.Document.Body); - expect(tree["w:body"][1]["w:sectPr"][4]["w:headerReference"]._attr["w:type"]).to.equal("first"); - expect(tree["w:body"][1]["w:sectPr"][5]["w:footerReference"]._attr["w:type"]).to.equal("first"); + expect(tree["w:body"][1]["w:sectPr"][5]["w:headerReference"]._attr["w:type"]).to.equal("first"); + expect(tree["w:body"][1]["w:sectPr"][7]["w:footerReference"]._attr["w:type"]).to.equal("first"); }); it("should create with correct headers", () => { const doc = new File(); - const header = doc.createHeader(); - const footer = doc.createFooter(); doc.addSection({ headers: { - default: header, - first: header, - even: header, + default: new Header(), + first: new Header(), + even: new Header(), }, footers: { - default: footer, - first: footer, - even: footer, + default: new Footer(), + first: new Footer(), + even: new Footer(), }, + children: [], }); const tree = new Formatter().format(doc.Document.Body); @@ -79,88 +91,56 @@ describe("File", () => { }); }); - describe("#addParagraph", () => { - it("should call the underlying document's addParagraph", () => { + describe("#addSection", () => { + it("should call the underlying document's add a Paragraph", () => { const file = new File(); - const spy = sinon.spy(file.Document, "addParagraph"); - file.addParagraph(new Paragraph()); + const spy = sinon.spy(file.Document, "add"); + file.addSection({ + children: [new Paragraph({})], + }); expect(spy.called).to.equal(true); }); - }); - describe("#addTable", () => { - it("should call the underlying document's addTable", () => { - const wrapper = new File(); - const spy = sinon.spy(wrapper.Document, "addTable"); - wrapper.addTable( - new Table({ - rows: 1, - columns: 1, - }), - ); + it("should call the underlying document's add when adding a Table", () => { + const file = new File(); + const spy = sinon.spy(file.Document, "add"); + file.addSection({ + children: [ + new Table({ + rows: 1, + columns: 1, + }), + ], + }); expect(spy.called).to.equal(true); }); - }); - describe("#createTable", () => { - it("should call the underlying document's createTable", () => { - const wrapper = new File(); - const spy = sinon.spy(wrapper.Document, "createTable"); - wrapper.createTable({ - rows: 1, - columns: 1, + it("should call the underlying document's add when adding an Image (paragraph)", () => { + const file = new File(); + const spy = sinon.spy(file.Document, "add"); + // tslint:disable-next-line:no-any + file.addSection({ + children: [new Paragraph("")], }); expect(spy.called).to.equal(true); }); }); - describe("#addTableOfContents", () => { - it("should call the underlying document's addTableOfContents", () => { - const wrapper = new File(); - const spy = sinon.spy(wrapper.Document, "addTableOfContents"); - // tslint:disable-next-line:no-any - wrapper.addTableOfContents({} as any); + describe("#addSection", () => { + it("should call the underlying document's add", () => { + const file = new File(); + const spy = sinon.spy(file.Document, "add"); + file.addSection({ + children: [new TableOfContents()], + }); expect(spy.called).to.equal(true); }); }); - describe("#createParagraph", () => { - it("should call the underlying document's createParagraph", () => { - const wrapper = new File(); - const spy = sinon.spy(wrapper.Document, "createParagraph"); - wrapper.createParagraph("test"); - - expect(spy.called).to.equal(true); - }); - }); - - describe("#addImage", () => { - it("should call the underlying document's addImage", () => { - const wrapper = new File(); - const spy = sinon.spy(wrapper.Document, "addParagraph"); - // tslint:disable-next-line:no-any - wrapper.addImage({} as any); - - expect(spy.called).to.equal(true); - }); - }); - - describe("#createImage", () => { - it("should call the underlying document's createImage", () => { - const wrapper = new File(); - const spy = sinon.spy(wrapper.Media, "addMedia"); - const wrapperSpy = sinon.spy(wrapper.Document, "addParagraph"); - wrapper.createImage(""); - - expect(spy.called).to.equal(true); - expect(wrapperSpy.called).to.equal(true); - }); - }); - describe("#createFootnote", () => { it("should call the underlying document's createFootnote", () => { const wrapper = new File(); diff --git a/src/file/file.ts b/src/file/file.ts index f6cf109b94..c0adf21e30 100644 --- a/src/file/file.ts +++ b/src/file/file.ts @@ -3,19 +3,18 @@ import { ContentTypes } from "./content-types/content-types"; import { CoreProperties, IPropertiesOptions } from "./core-properties"; import { Document } from "./document"; import { - FooterReference, FooterReferenceType, - HeaderReference, HeaderReferenceType, - IHeaderFooterGroup, + IPageSizeAttributes, SectionPropertiesOptions, } from "./document/body/section-properties"; -import { IDrawingOptions } from "./drawing"; +import { IPageMarginAttributes } from "./document/body/section-properties/page-margin/page-margin-attributes"; import { IFileProperties } from "./file-properties"; import { FooterWrapper, IDocumentFooter } from "./footer-wrapper"; import { FootNotes } from "./footnotes"; +import { Footer, Header } from "./header"; import { HeaderWrapper, IDocumentHeader } from "./header-wrapper"; -import { Image, Media } from "./media"; +import { Media } from "./media"; import { Numbering } from "./numbering"; import { Bookmark, Hyperlink, Paragraph } from "./paragraph"; import { Relationships } from "./relationships"; @@ -24,12 +23,31 @@ import { Settings } from "./settings"; import { Styles } from "./styles"; import { ExternalStylesFactory } from "./styles/external-styles-factory"; import { DefaultStylesFactory } from "./styles/factory"; -import { ITableOptions, Table } from "./table"; +import { Table } from "./table"; import { TableOfContents } from "./table-of-contents"; +export interface ISectionOptions { + readonly headers?: { + readonly default?: Header; + readonly first?: Header; + readonly even?: Header; + }; + readonly footers?: { + readonly default?: Footer; + readonly first?: Footer; + readonly even?: Footer; + }; + readonly size?: IPageSizeAttributes; + readonly margins?: IPageMarginAttributes; + readonly properties?: SectionPropertiesOptions; + readonly children: Array; +} + export class File { // tslint:disable-next-line:readonly-keyword private currentRelationshipId: number = 1; + // tslint:disable-next-line:readonly-keyword + private styles: Styles; private readonly document: Document; private readonly headers: IDocumentHeader[] = []; @@ -43,8 +61,6 @@ export class File { private readonly settings: Settings; private readonly contentTypes: ContentTypes; private readonly appProperties: AppProperties; - // tslint:disable-next-line:readonly-keyword - private styles: Styles; constructor( options: IPropertiesOptions = { @@ -52,8 +68,8 @@ export class File { revision: "1", lastModifiedBy: "Un-named", }, - sectionPropertiesOptions: SectionPropertiesOptions = {}, fileProperties: IFileProperties = {}, + sections: ISectionOptions[] = [], ) { this.coreProperties = new CoreProperties(options); this.numbering = new Numbering(); @@ -62,6 +78,8 @@ export class File { this.appProperties = new AppProperties(); this.footNotes = new FootNotes(); this.contentTypes = new ContentTypes(); + this.document = new Document(); + this.settings = new Settings(); this.media = fileProperties.template && fileProperties.template.media ? fileProperties.template.media : new Media(); @@ -90,66 +108,21 @@ export class File { for (const templateHeader of fileProperties.template.headers) { this.addHeaderToDocument(templateHeader.header, templateHeader.type); } - } else { - this.createHeader(); } if (fileProperties.template && fileProperties.template.footers) { for (const templateFooter of fileProperties.template.footers) { this.addFooterToDocument(templateFooter.footer, templateFooter.type); } - } else { - this.createFooter(); } - const newSectionPropertiesOptions = { - ...sectionPropertiesOptions, - headers: this.groupHeaders(this.headers, sectionPropertiesOptions.headers), - footers: this.groupFooters(this.footers, sectionPropertiesOptions.footers), - }; + for (const section of sections) { + this.document.Body.addSection(section.properties ? section.properties : {}); - this.document = new Document(newSectionPropertiesOptions); - this.settings = new Settings(); - } - - public addTableOfContents(toc: TableOfContents): File { - this.document.addTableOfContents(toc); - return this; - } - - public addParagraph(paragraph: Paragraph): File { - this.document.addParagraph(paragraph); - return this; - } - - public createParagraph(text?: string): Paragraph { - return this.document.createParagraph(text); - } - - public addTable(table: Table): File { - this.document.addTable(table); - return this; - } - - public createTable(options: ITableOptions): Table { - return this.document.createTable(options); - } - - public addImage(image: Image): File { - this.document.addParagraph(image.Paragraph); - return this; - } - - public createImage( - buffer: Buffer | string | Uint8Array | ArrayBuffer, - width?: number, - height?: number, - drawingOptions?: IDrawingOptions, - ): Image { - const image = Media.addImage(this, buffer, width, height, drawingOptions); - this.document.addParagraph(image.Paragraph); - - return image; + for (const child of section.children) { + this.document.add(child); + } + } } public createHyperlink(link: string, text?: string): Hyperlink { @@ -172,106 +145,71 @@ export class File { return hyperlink; } - public createBookmark(name: string, text?: string): Bookmark { - const newText = text === undefined ? name : text; - const bookmark = new Bookmark(name, newText, this.docRelationships.RelationshipCount); - return bookmark; + public createBookmark(name: string, text: string = name): Bookmark { + return new Bookmark(name, text, this.docRelationships.RelationshipCount); } - public addSection(sectionPropertiesOptions: SectionPropertiesOptions): void { - this.document.Body.addSection(sectionPropertiesOptions); + public addSection({ + headers = { default: new Header() }, + footers = { default: new Header() }, + margins = {}, + size = {}, + properties, + children, + }: ISectionOptions): void { + this.document.Body.addSection({ + ...properties, + headers: { + default: headers.default ? this.createHeader(headers.default) : this.createHeader(new Header()), + first: headers.first ? this.createHeader(headers.first) : undefined, + even: headers.even ? this.createHeader(headers.even) : undefined, + }, + footers: { + default: footers.default ? this.createFooter(footers.default) : this.createFooter(new Footer()), + first: footers.first ? this.createFooter(footers.first) : undefined, + even: footers.even ? this.createFooter(footers.even) : undefined, + }, + ...margins, + ...size, + }); + + for (const child of children) { + this.document.add(child); + } } public createFootnote(paragraph: Paragraph): void { this.footNotes.createFootNote(paragraph); } - public createHeader(): HeaderWrapper { - const header = new HeaderWrapper(this.media, this.currentRelationshipId++); - this.addHeaderToDocument(header); - return header; - } - - public createFooter(): FooterWrapper { - const footer = new FooterWrapper(this.media, this.currentRelationshipId++); - this.addFooterToDocument(footer); - return footer; - } - - public createFirstPageHeader(): HeaderWrapper { - const headerWrapper = this.createHeader(); - - this.document.Body.DefaultSection.addChildElement( - new HeaderReference({ - headerType: HeaderReferenceType.FIRST, - headerId: headerWrapper.Header.ReferenceId, - }), - ); - - return headerWrapper; - } - - public createEvenPageHeader(): HeaderWrapper { - const headerWrapper = this.createHeader(); - - this.document.Body.DefaultSection.addChildElement( - new HeaderReference({ - headerType: HeaderReferenceType.EVEN, - headerId: headerWrapper.Header.ReferenceId, - }), - ); - - return headerWrapper; - } - - public createFirstPageFooter(): FooterWrapper { - const footerWrapper = this.createFooter(); - - this.document.Body.DefaultSection.addChildElement( - new FooterReference({ - footerType: FooterReferenceType.FIRST, - footerId: footerWrapper.Footer.ReferenceId, - }), - ); - - return footerWrapper; - } - - public createEvenPageFooter(): FooterWrapper { - const footerWrapper = this.createFooter(); - - this.document.Body.DefaultSection.addChildElement( - new FooterReference({ - footerType: FooterReferenceType.EVEN, - footerId: footerWrapper.Footer.ReferenceId, - }), - ); - - return footerWrapper; - } - - public getFooterByReferenceNumber(refId: number): FooterWrapper { - const entry = this.footers.map((item) => item.footer).find((h) => h.Footer.ReferenceId === refId); - if (entry) { - return entry; - } - throw new Error(`There is no footer with given reference id ${refId}`); - } - - public getHeaderByReferenceNumber(refId: number): HeaderWrapper { - const entry = this.headers.map((item) => item.header).find((h) => h.Header.ReferenceId === refId); - if (entry) { - return entry; - } - throw new Error(`There is no header with given reference id ${refId}`); - } - public verifyUpdateFields(): void { if (this.document.getTablesOfContents().length) { this.settings.addUpdateFields(); } } + private createHeader(header: Header): HeaderWrapper { + const wrapper = new HeaderWrapper(this.media, this.currentRelationshipId++); + + for (const child of header.options.children) { + wrapper.add(child); + } + + this.addHeaderToDocument(wrapper); + return wrapper; + } + + private createFooter(footer: Footer): FooterWrapper { + const wrapper = new FooterWrapper(this.media, this.currentRelationshipId++); + + for (const child of footer.options.children) { + wrapper.add(child); + } + + this.addFooterToDocument(wrapper); + return wrapper; + } + private addHeaderToDocument(header: HeaderWrapper, type: HeaderReferenceType = HeaderReferenceType.DEFAULT): void { this.headers.push({ header, type }); this.docRelationships.createRelationship( @@ -331,66 +269,6 @@ export class File { ); } - private groupHeaders(headers: IDocumentHeader[], group: IHeaderFooterGroup = {}): IHeaderFooterGroup { - let newGroup = group; - - for (const header of headers) { - switch (header.type) { - case HeaderReferenceType.FIRST: - newGroup = { - ...newGroup, - first: header.header, - }; - break; - case HeaderReferenceType.EVEN: - newGroup = { - ...newGroup, - even: header.header, - }; - break; - case HeaderReferenceType.DEFAULT: - default: - newGroup = { - ...newGroup, - default: header.header, - }; - break; - } - } - - return newGroup; - } - - private groupFooters(footers: IDocumentFooter[], group: IHeaderFooterGroup = {}): IHeaderFooterGroup { - let newGroup = group; - - for (const footer of footers) { - switch (footer.type) { - case FooterReferenceType.FIRST: - newGroup = { - ...newGroup, - first: footer.footer, - }; - break; - case FooterReferenceType.EVEN: - newGroup = { - ...newGroup, - even: footer.footer, - }; - break; - case FooterReferenceType.DEFAULT: - default: - newGroup = { - ...newGroup, - default: footer.footer, - }; - break; - } - } - - return newGroup; - } - public get Document(): Document { return this.document; } @@ -423,18 +301,10 @@ export class File { return this.fileRelationships; } - public get Header(): HeaderWrapper { - return this.headers[0].header; - } - public get Headers(): HeaderWrapper[] { return this.headers.map((item) => item.header); } - public get Footer(): FooterWrapper { - return this.footers[0].footer; - } - public get Footers(): FooterWrapper[] { return this.footers.map((item) => item.footer); } diff --git a/src/file/footer-wrapper.spec.ts b/src/file/footer-wrapper.spec.ts index c7bc5564fa..3f6fb01b82 100644 --- a/src/file/footer-wrapper.spec.ts +++ b/src/file/footer-wrapper.spec.ts @@ -7,21 +7,19 @@ import { Paragraph } from "./paragraph"; import { Table } from "./table"; describe("FooterWrapper", () => { - describe("#addParagraph", () => { + describe("#add", () => { it("should call the underlying footer's addParagraph", () => { const file = new FooterWrapper(new Media(), 1); - const spy = sinon.spy(file.Footer, "addParagraph"); - file.addParagraph(new Paragraph()); + const spy = sinon.spy(file.Footer, "add"); + file.add(new Paragraph({})); expect(spy.called).to.equal(true); }); - }); - describe("#addTable", () => { it("should call the underlying footer's addParagraph", () => { const file = new FooterWrapper(new Media(), 1); - const spy = sinon.spy(file.Footer, "addTable"); - file.addTable( + const spy = sinon.spy(file.Footer, "add"); + file.add( new Table({ rows: 1, columns: 1, @@ -30,32 +28,10 @@ describe("FooterWrapper", () => { expect(spy.called).to.equal(true); }); - }); - describe("#createTable", () => { - it("should call the underlying footer's createTable", () => { - const wrapper = new FooterWrapper(new Media(), 1); - const spy = sinon.spy(wrapper.Footer, "createTable"); - wrapper.createTable(1, 1); - - expect(spy.called).to.equal(true); - }); - }); - - describe("#createParagraph", () => { - it("should call the underlying footer's createParagraph", () => { - const file = new FooterWrapper(new Media(), 1); - const spy = sinon.spy(file.Footer, "addParagraph"); - file.createParagraph(); - - expect(spy.called).to.equal(true); - }); - }); - - describe("#addImage", () => { it("should call the underlying footer's addImage", () => { const file = new FooterWrapper(new Media(), 1); - const spy = sinon.spy(file.Footer, "addParagraph"); + const spy = sinon.spy(file.Footer, "add"); // tslint:disable-next-line:no-any file.addImage({} as any); @@ -63,18 +39,6 @@ describe("FooterWrapper", () => { }); }); - describe("#createImage", () => { - it("should call the underlying footer's createImage", () => { - const file = new FooterWrapper(new Media(), 1); - const spy = sinon.spy(file.Media, "addMedia"); - const fileSpy = sinon.spy(file, "addImage"); - file.createImage(""); - - expect(spy.called).to.equal(true); - expect(fileSpy.called).to.equal(true); - }); - }); - describe("#addChildElement", () => { it("should call the underlying footer's addChildElement", () => { const file = new FooterWrapper(new Media(), 1); diff --git a/src/file/footer-wrapper.ts b/src/file/footer-wrapper.ts index 6b55730f9f..01087e9861 100644 --- a/src/file/footer-wrapper.ts +++ b/src/file/footer-wrapper.ts @@ -3,7 +3,7 @@ import { XmlComponent } from "file/xml-components"; import { FooterReferenceType } from "./document"; import { Footer } from "./footer/footer"; import { Image, Media } from "./media"; -import { ImageParagraph, Paragraph } from "./paragraph"; +import { Paragraph } from "./paragraph"; import { Relationships } from "./relationships"; import { Table } from "./table"; @@ -21,38 +21,19 @@ export class FooterWrapper { this.relationships = new Relationships(); } - public addParagraph(paragraph: Paragraph): void { - this.footer.addParagraph(paragraph); + public add(item: Paragraph | Table): void { + this.footer.add(item); } - public createParagraph(text?: string): Paragraph { - const para = new Paragraph(text); - this.addParagraph(para); - return para; - } - - public addTable(table: Table): void { - this.footer.addTable(table); - } - - public createTable(rows: number, cols: number): Table { - return this.footer.createTable(rows, cols); + public addImage(image: Image): FooterWrapper { + this.footer.add(image.Paragraph); + return this; } public addChildElement(childElement: XmlComponent): void { this.footer.addChildElement(childElement); } - public createImage(image: Buffer | string | Uint8Array | ArrayBuffer, width?: number, height?: number): void { - const mediaData = this.media.addMedia(image, width, height); - this.addImage(new Image(new ImageParagraph(mediaData))); - } - - public addImage(image: Image): FooterWrapper { - this.footer.addParagraph(image.Paragraph); - return this; - } - public get Footer(): Footer { return this.footer; } diff --git a/src/file/footer/footer.ts b/src/file/footer/footer.ts index 9466729b86..d8b8cfe2ea 100644 --- a/src/file/footer/footer.ts +++ b/src/file/footer/footer.ts @@ -38,28 +38,7 @@ export class Footer extends InitializableXmlComponent { return this.refId; } - public addParagraph(paragraph: Paragraph): Footer { - this.root.push(paragraph); - - return this; - } - - public createParagraph(text?: string): Paragraph { - const para = new Paragraph(text); - this.addParagraph(para); - return para; - } - - public addTable(table: Table): void { - this.root.push(table); - } - - public createTable(rows: number, cols: number): Table { - const table = new Table({ - rows: rows, - columns: cols, - }); - this.addTable(table); - return table; + public add(item: Paragraph | Table): void { + this.root.push(item); } } diff --git a/src/file/footnotes/footnote/footnote.ts b/src/file/footnotes/footnote/footnote.ts index 0567695c40..60e6e533c8 100644 --- a/src/file/footnotes/footnote/footnote.ts +++ b/src/file/footnotes/footnote/footnote.ts @@ -20,7 +20,7 @@ export class Footnote extends XmlComponent { ); } - public addParagraph(paragraph: Paragraph): void { + public add(paragraph: Paragraph): void { paragraph.addRunToFront(new FootnoteRefRun()); this.root.push(paragraph); } diff --git a/src/file/footnotes/footnote/run/continuation-seperator-run.ts b/src/file/footnotes/footnote/run/continuation-seperator-run.ts index 4cf3ad2d21..8e55b9bb7f 100644 --- a/src/file/footnotes/footnote/run/continuation-seperator-run.ts +++ b/src/file/footnotes/footnote/run/continuation-seperator-run.ts @@ -3,7 +3,7 @@ import { ContinuationSeperator } from "./continuation-seperator"; export class ContinuationSeperatorRun extends Run { constructor() { - super(); + super({}); this.root.push(new ContinuationSeperator()); } diff --git a/src/file/footnotes/footnote/run/footnote-ref-run.ts b/src/file/footnotes/footnote/run/footnote-ref-run.ts index 65ef0b697a..4be3493b33 100644 --- a/src/file/footnotes/footnote/run/footnote-ref-run.ts +++ b/src/file/footnotes/footnote/run/footnote-ref-run.ts @@ -3,9 +3,10 @@ import { FootnoteRef } from "./footnote-ref"; export class FootnoteRefRun extends Run { constructor() { - super(); + super({ + style: "FootnoteReference", + }); - this.style("FootnoteReference"); this.root.push(new FootnoteRef()); } } diff --git a/src/file/footnotes/footnote/run/reference-run.ts b/src/file/footnotes/footnote/run/reference-run.ts index 278120ed70..7dec91473d 100644 --- a/src/file/footnotes/footnote/run/reference-run.ts +++ b/src/file/footnotes/footnote/run/reference-run.ts @@ -26,7 +26,7 @@ export class FootnoteReference extends XmlComponent { export class FootnoteReferenceRun extends Run { constructor(id: number) { - super(); + super({}); this.properties.push(new Style("FootnoteReference")); diff --git a/src/file/footnotes/footnote/run/seperator-run.ts b/src/file/footnotes/footnote/run/seperator-run.ts index 17cc69d8ec..c5a0f9b252 100644 --- a/src/file/footnotes/footnote/run/seperator-run.ts +++ b/src/file/footnotes/footnote/run/seperator-run.ts @@ -3,7 +3,7 @@ import { Seperator } from "./seperator"; export class SeperatorRun extends Run { constructor() { - super(); + super({}); this.root.push(new Seperator()); } diff --git a/src/file/footnotes/footnotes.ts b/src/file/footnotes/footnotes.ts index 7877eea9a0..2fea5fe380 100644 --- a/src/file/footnotes/footnotes.ts +++ b/src/file/footnotes/footnotes.ts @@ -37,33 +37,33 @@ export class FootNotes extends XmlComponent { ); const begin = new Footnote(-1, FootnoteType.SEPERATOR); - begin.addParagraph( - new Paragraph() - .spacing({ + begin.add( + new Paragraph({ + spacing: { after: 0, line: 240, lineRule: "auto", - }) - .addRun(new SeperatorRun()), + }, + }).addRun(new SeperatorRun()), ); this.root.push(begin); const spacing = new Footnote(0, FootnoteType.CONTINUATION_SEPERATOR); - spacing.addParagraph( - new Paragraph() - .spacing({ + spacing.add( + new Paragraph({ + spacing: { after: 0, line: 240, lineRule: "auto", - }) - .addRun(new ContinuationSeperatorRun()), + }, + }).addRun(new ContinuationSeperatorRun()), ); this.root.push(spacing); } public createFootNote(paragraph: Paragraph): void { const footnote = new Footnote(this.currentId); - footnote.addParagraph(paragraph); + footnote.add(paragraph); this.root.push(footnote); this.currentId++; diff --git a/src/file/header-wrapper.spec.ts b/src/file/header-wrapper.spec.ts index c457753ced..d07473f03a 100644 --- a/src/file/header-wrapper.spec.ts +++ b/src/file/header-wrapper.spec.ts @@ -7,21 +7,19 @@ import { Paragraph } from "./paragraph"; import { Table } from "./table"; describe("HeaderWrapper", () => { - describe("#addParagraph", () => { - it("should call the underlying header's addParagraph", () => { + describe("#add", () => { + it("should call the underlying header's addChildElement for Paragraph", () => { const wrapper = new HeaderWrapper(new Media(), 1); - const spy = sinon.spy(wrapper.Header, "addParagraph"); - wrapper.addParagraph(new Paragraph()); + const spy = sinon.spy(wrapper.Header, "add"); + wrapper.add(new Paragraph({})); expect(spy.called).to.equal(true); }); - }); - describe("#addTable", () => { - it("should call the underlying header's addTable", () => { + it("should call the underlying header's addChildElement for Table", () => { const wrapper = new HeaderWrapper(new Media(), 1); - const spy = sinon.spy(wrapper.Header, "addTable"); - wrapper.addTable( + const spy = sinon.spy(wrapper.Header, "add"); + wrapper.add( new Table({ rows: 1, columns: 1, @@ -32,30 +30,10 @@ describe("HeaderWrapper", () => { }); }); - describe("#createTable", () => { - it("should call the underlying header's createTable", () => { - const wrapper = new HeaderWrapper(new Media(), 1); - const spy = sinon.spy(wrapper.Header, "createTable"); - wrapper.createTable(1, 1); - - expect(spy.called).to.equal(true); - }); - }); - - describe("#createParagraph", () => { - it("should call the underlying header's createParagraph", () => { - const file = new HeaderWrapper(new Media(), 1); - const spy = sinon.spy(file.Header, "addParagraph"); - file.createParagraph(); - - expect(spy.called).to.equal(true); - }); - }); - describe("#addImage", () => { it("should call the underlying header's addImage", () => { const file = new HeaderWrapper(new Media(), 1); - const spy = sinon.spy(file.Header, "addParagraph"); + const spy = sinon.spy(file.Header, "add"); // tslint:disable-next-line:no-any file.addImage({} as any); @@ -63,18 +41,6 @@ describe("HeaderWrapper", () => { }); }); - describe("#createImage", () => { - it("should call the underlying header's createImage", () => { - const file = new HeaderWrapper(new Media(), 1); - const spy = sinon.spy(file.Media, "addMedia"); - const fileSpy = sinon.spy(file, "addImage"); - file.createImage(""); - - expect(spy.called).to.equal(true); - expect(fileSpy.called).to.equal(true); - }); - }); - describe("#addChildElement", () => { it("should call the underlying header's addChildElement", () => { const file = new HeaderWrapper(new Media(), 1); diff --git a/src/file/header-wrapper.ts b/src/file/header-wrapper.ts index 878d23bc9e..d698505e4a 100644 --- a/src/file/header-wrapper.ts +++ b/src/file/header-wrapper.ts @@ -3,7 +3,7 @@ import { XmlComponent } from "file/xml-components"; import { HeaderReferenceType } from "./document"; import { Header } from "./header/header"; import { Image, Media } from "./media"; -import { ImageParagraph, Paragraph } from "./paragraph"; +import { Paragraph } from "./paragraph"; import { Relationships } from "./relationships"; import { Table } from "./table"; @@ -21,38 +21,21 @@ export class HeaderWrapper { this.relationships = new Relationships(); } - public addParagraph(paragraph: Paragraph): void { - this.header.addParagraph(paragraph); + public add(item: Paragraph | Table): HeaderWrapper { + this.header.add(item); + + return this; } - public createParagraph(text?: string): Paragraph { - const para = new Paragraph(text); - this.addParagraph(para); - return para; - } - - public addTable(table: Table): void { - this.header.addTable(table); - } - - public createTable(rows: number, cols: number): Table { - return this.header.createTable(rows, cols); + public addImage(image: Image): HeaderWrapper { + this.header.add(image.Paragraph); + return this; } public addChildElement(childElement: XmlComponent | string): void { this.header.addChildElement(childElement); } - public createImage(image: Buffer | string | Uint8Array | ArrayBuffer, width?: number, height?: number): void { - const mediaData = this.media.addMedia(image, width, height); - this.addImage(new Image(new ImageParagraph(mediaData))); - } - - public addImage(image: Image): HeaderWrapper { - this.header.addParagraph(image.Paragraph); - return this; - } - public get Header(): Header { return this.header; } diff --git a/src/file/header.ts b/src/file/header.ts new file mode 100644 index 0000000000..05e227d9f8 --- /dev/null +++ b/src/file/header.ts @@ -0,0 +1,14 @@ +import { Paragraph } from "./paragraph"; +import { Table } from "./table"; + +export interface IHeaderOptions { + readonly children: Array; +} + +export class Header { + constructor(public readonly options: IHeaderOptions = { children: [] }) {} +} + +export class Footer { + constructor(public readonly options: IHeaderOptions = { children: [] }) {} +} diff --git a/src/file/header/header.ts b/src/file/header/header.ts index 0f753134ba..ef7a3f4d5d 100644 --- a/src/file/header/header.ts +++ b/src/file/header/header.ts @@ -50,26 +50,7 @@ export class Header extends InitializableXmlComponent { return this.refId; } - public addParagraph(paragraph: Paragraph): void { - this.root.push(paragraph); - } - - public createParagraph(text?: string): Paragraph { - const para = new Paragraph(text); - this.addParagraph(para); - return para; - } - - public addTable(table: Table): void { - this.root.push(table); - } - - public createTable(rows: number, cols: number): Table { - const table = new Table({ - rows: rows, - columns: cols, - }); - this.addTable(table); - return table; + public add(item: Paragraph | Table): void { + this.root.push(item); } } diff --git a/src/file/index.ts b/src/file/index.ts index 199679bee3..d14d4d9b1a 100644 --- a/src/file/index.ts +++ b/src/file/index.ts @@ -11,3 +11,4 @@ export * from "./table-of-contents"; export * from "./xml-components"; export * from "./header-wrapper"; export * from "./footer-wrapper"; +export * from "./header"; diff --git a/src/file/media/image.ts b/src/file/media/image.ts index b596f77d9d..8255fe7398 100644 --- a/src/file/media/image.ts +++ b/src/file/media/image.ts @@ -10,8 +10,4 @@ export class Image { public get Run(): PictureRun { return this.paragraph.Run; } - - public scale(factorX: number, factorY?: number): void { - this.paragraph.Run.scale(factorX, factorY); - } } diff --git a/src/file/media/media.spec.ts b/src/file/media/media.spec.ts index 9c53f1910d..b7ce0c106c 100644 --- a/src/file/media/media.spec.ts +++ b/src/file/media/media.spec.ts @@ -5,6 +5,7 @@ import { stub } from "sinon"; import { Formatter } from "export/formatter"; import { File } from "../file"; +import { Paragraph } from "../paragraph"; import { Media } from "./media"; describe("Media", () => { @@ -13,10 +14,10 @@ describe("Media", () => { const file = new File(); const image = Media.addImage(file, ""); - let tree = new Formatter().format(image.Paragraph); + let tree = new Formatter().format(new Paragraph(image)); expect(tree["w:p"]).to.be.an.instanceof(Array); - tree = new Formatter().format(image.Run); + tree = new Formatter().format(image); expect(tree["w:r"]).to.be.an.instanceof(Array); }); @@ -26,7 +27,7 @@ describe("Media", () => { const file = new File(); const image1 = Media.addImage(file, "test"); - const tree = new Formatter().format(image1.Paragraph); + const tree = new Formatter().format(new Paragraph(image1)); const inlineElements = tree["w:p"][0]["w:r"][0]["w:drawing"][0]["wp:inline"]; const graphicData = inlineElements.find((x) => x["a:graphic"]); @@ -38,7 +39,7 @@ describe("Media", () => { }); const image2 = Media.addImage(file, "test"); - const tree2 = new Formatter().format(image2.Paragraph); + const tree2 = new Formatter().format(new Paragraph(image2)); const inlineElements2 = tree2["w:p"][0]["w:r"][0]["w:drawing"][0]["wp:inline"]; const graphicData2 = inlineElements2.find((x) => x["a:graphic"]); diff --git a/src/file/media/media.ts b/src/file/media/media.ts index 8a160291ca..0d062c6d64 100644 --- a/src/file/media/media.ts +++ b/src/file/media/media.ts @@ -1,20 +1,22 @@ import { IDrawingOptions } from "../drawing"; import { File } from "../file"; -import { ImageParagraph } from "../paragraph"; +import { FooterWrapper } from "../footer-wrapper"; +import { HeaderWrapper } from "../header-wrapper"; +import { PictureRun } from "../paragraph"; import { IMediaData } from "./data"; -import { Image } from "./image"; +// import { Image } from "./image"; export class Media { public static addImage( - file: File, + file: File | HeaderWrapper | FooterWrapper, buffer: Buffer | string | Uint8Array | ArrayBuffer, width?: number, height?: number, drawingOptions?: IDrawingOptions, - ): Image { + ): PictureRun { // Workaround to expose id without exposing to API const mediaData = file.Media.addMedia(buffer, width, height); - return new Image(new ImageParagraph(mediaData, drawingOptions)); + return new PictureRun(mediaData, drawingOptions); } private static generateId(): string { diff --git a/src/file/numbering/level.ts b/src/file/numbering/level.ts index 716f313104..8a266fa47f 100644 --- a/src/file/numbering/level.ts +++ b/src/file/numbering/level.ts @@ -1,7 +1,8 @@ import { Attributes, XmlAttributeComponent, XmlComponent } from "file/xml-components"; import { Alignment, - AlignmentOptions, + AlignmentType, + IIndentAttributesProperties, Indent, ISpacingProperties, KeepLines, @@ -114,7 +115,7 @@ export class LevelBase extends XmlComponent { this.root.push(new LevelJc(lvlJc)); } - this.paragraphProperties = new ParagraphProperties(); + this.paragraphProperties = new ParagraphProperties({}); this.runProperties = new RunProperties(); this.root.push(this.paragraphProperties); @@ -198,25 +199,34 @@ export class LevelBase extends XmlComponent { 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(AlignmentOptions.CENTER)); + this.addParagraphProperty(new Alignment(AlignmentType.CENTER)); return this; } public left(): Level { - this.addParagraphProperty(new Alignment(AlignmentOptions.LEFT)); + this.addParagraphProperty(new Alignment(AlignmentType.LEFT)); return this; } public right(): Level { - this.addParagraphProperty(new Alignment(AlignmentOptions.RIGHT)); + this.addParagraphProperty(new Alignment(AlignmentType.RIGHT)); return this; } public justified(): Level { - this.addParagraphProperty(new Alignment(AlignmentOptions.BOTH)); + this.addParagraphProperty(new Alignment(AlignmentType.BOTH)); return this; } @@ -235,7 +245,7 @@ export class LevelBase extends XmlComponent { return this; } - public indent(attrs: object): Level { + public indent(attrs: IIndentAttributesProperties): Level { this.addParagraphProperty(new Indent(attrs)); return this; } diff --git a/src/file/numbering/numbering.spec.ts b/src/file/numbering/numbering.spec.ts index 3ba39b15f6..f38261b071 100644 --- a/src/file/numbering/numbering.spec.ts +++ b/src/file/numbering/numbering.spec.ts @@ -175,9 +175,9 @@ describe("AbstractNumbering", () => { "w:bottom": { _attr: { "w:color": "auto", - "w:space": "1", + "w:space": 1, "w:val": "single", - "w:sz": "6", + "w:sz": 6, }, }, }, @@ -325,6 +325,24 @@ describe("AbstractNumbering", () => { }); }); + 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); diff --git a/src/file/paragraph/formatting/alignment.ts b/src/file/paragraph/formatting/alignment.ts index 838c1dc700..8acf41ee4b 100644 --- a/src/file/paragraph/formatting/alignment.ts +++ b/src/file/paragraph/formatting/alignment.ts @@ -1,22 +1,23 @@ // http://officeopenxml.com/WPalignment.php import { XmlAttributeComponent, XmlComponent } from "file/xml-components"; -export enum AlignmentOptions { +export enum AlignmentType { START = "start", END = "end", CENTER = "center", BOTH = "both", + JUSTIFIED = "both", DISTRIBUTE = "distribute", LEFT = "left", RIGHT = "right", } -export class AlignmentAttributes extends XmlAttributeComponent<{ readonly val: AlignmentOptions }> { +export class AlignmentAttributes extends XmlAttributeComponent<{ readonly val: AlignmentType }> { protected readonly xmlKeys = { val: "w:val" }; } export class Alignment extends XmlComponent { - constructor(type: AlignmentOptions) { + constructor(type: AlignmentType) { super("w:jc"); this.root.push(new AlignmentAttributes({ val: type })); } diff --git a/src/file/paragraph/formatting/border-attributes.ts b/src/file/paragraph/formatting/border-attributes.ts new file mode 100644 index 0000000000..d389f7adc7 --- /dev/null +++ b/src/file/paragraph/formatting/border-attributes.ts @@ -0,0 +1,17 @@ +import { XmlAttributeComponent } from "file/xml-components"; + +export interface IBorderAttributesProperties { + readonly color: string; + readonly space: number; + readonly val: string; + readonly sz: number; +} + +export class BorderAttributes extends XmlAttributeComponent { + protected readonly xmlKeys = { + val: "w:val", + color: "w:color", + space: "w:space", + sz: "w:sz", + }; +} diff --git a/src/file/paragraph/formatting/border.spec.ts b/src/file/paragraph/formatting/border.spec.ts index 20b8e4309e..f07a297479 100644 --- a/src/file/paragraph/formatting/border.spec.ts +++ b/src/file/paragraph/formatting/border.spec.ts @@ -35,8 +35,8 @@ describe("ThematicBreak", () => { "w:bottom": { _attr: { "w:color": "auto", - "w:space": "1", - "w:sz": "6", + "w:space": 1, + "w:sz": 6, "w:val": "single", }, }, diff --git a/src/file/paragraph/formatting/border.ts b/src/file/paragraph/formatting/border.ts index f37854a3c7..9fdb9b65c3 100644 --- a/src/file/paragraph/formatting/border.ts +++ b/src/file/paragraph/formatting/border.ts @@ -1,63 +1,70 @@ // http://officeopenxml.com/WPborders.php -import { Attributes, XmlComponent } from "file/xml-components"; +import { XmlComponent } from "file/xml-components"; +import { BorderAttributes } from "./border-attributes"; + +interface IBorderPropertyOptions { + readonly color: string; + readonly space: number; + readonly value: string; + readonly size: number; +} + +export interface IBorderOptions { + readonly top?: IBorderPropertyOptions; + readonly bottom?: IBorderPropertyOptions; + readonly left?: IBorderPropertyOptions; + readonly right?: IBorderPropertyOptions; +} class BorderProperty extends XmlComponent { - public setProperties(color: string, space: string, value: string, size: string): XmlComponent { - const attrs = new Attributes({ - color: color, - space: space, - val: value, - sz: size, + constructor(rootKey: string, options: IBorderPropertyOptions = { color: "auto", space: 1, value: "single", size: 6 }) { + super(rootKey); + + const attrs = new BorderAttributes({ + color: options.color, + space: options.space, + val: options.value, + sz: options.size, }); this.root.push(attrs); - - return this; } } export class Border extends XmlComponent { - constructor() { + constructor(options: IBorderOptions) { super("w:pBdr"); - } - public addTopBorder(color: string = "auto", space: string = "1", value: string = "single", size: string = "6"): XmlComponent { - const top = new BorderProperty("w:top"); - top.setProperties(color, space, value, size); - this.root.push(top); + if (options.top !== undefined) { + const borderProperty = new BorderProperty("w:top", options.top); + this.root.push(borderProperty); + } - return this; - } + if (options.bottom !== undefined) { + const borderProperty = new BorderProperty("w:bottom", options.bottom); + this.root.push(borderProperty); + } - public addBottomBorder(color: string = "auto", space: string = "1", value: string = "single", size: string = "6"): XmlComponent { - const bottom = new BorderProperty("w:bottom"); - bottom.setProperties(color, space, value, size); - this.root.push(bottom); + if (options.left !== undefined) { + const borderProperty = new BorderProperty("w:left", options.left); + this.root.push(borderProperty); + } - return this; - } - - public addLeftBorder(color: string = "auto", space: string = "1", value: string = "single", size: string = "6"): XmlComponent { - const left = new BorderProperty("w:left"); - left.setProperties(color, space, value, size); - this.root.push(left); - - return this; - } - - public addRightBorder(color: string = "auto", space: string = "1", value: string = "single", size: string = "6"): XmlComponent { - const right = new BorderProperty("w:right"); - right.setProperties(color, space, value, size); - this.root.push(right); - - return this; + if (options.right !== undefined) { + const borderProperty = new BorderProperty("w:right", options.right); + this.root.push(borderProperty); + } } } export class ThematicBreak extends XmlComponent { constructor() { super("w:pBdr"); - const bottom = new BorderProperty("w:bottom"); - bottom.setProperties("auto", "1", "single", "6"); + const bottom = new BorderProperty("w:bottom", { + color: "auto", + space: 1, + value: "single", + size: 6, + }); this.root.push(bottom); } } diff --git a/src/file/paragraph/formatting/page-break.ts b/src/file/paragraph/formatting/page-break.ts index 13556d12e2..af08f766d3 100644 --- a/src/file/paragraph/formatting/page-break.ts +++ b/src/file/paragraph/formatting/page-break.ts @@ -15,7 +15,7 @@ class Break extends XmlComponent { export class PageBreak extends Run { constructor() { - super(); + super({}); this.root.push(new Break()); } } diff --git a/src/file/paragraph/formatting/style.ts b/src/file/paragraph/formatting/style.ts index 30d57eb997..a493e4b025 100644 --- a/src/file/paragraph/formatting/style.ts +++ b/src/file/paragraph/formatting/style.ts @@ -1,5 +1,15 @@ import { Attributes, XmlComponent } from "file/xml-components"; +export enum HeadingLevel { + HEADING_1 = "Heading1", + HEADING_2 = "Heading2", + HEADING_3 = "Heading3", + HEADING_4 = "Heading4", + HEADING_5 = "Heading5", + HEADING_6 = "Heading6", + TITLE = "Title", +} + export class Style extends XmlComponent { public readonly styleId: string; diff --git a/src/file/paragraph/image.spec.ts b/src/file/paragraph/image.spec.ts index 6fb07e5294..715c1c93ab 100644 --- a/src/file/paragraph/image.spec.ts +++ b/src/file/paragraph/image.spec.ts @@ -1,12 +1,8 @@ // tslint:disable:object-literal-key-quotes -import { assert, expect } from "chai"; - -import { Formatter } from "export/formatter"; +import { assert } from "chai"; import { ImageParagraph } from "./image"; -import { EMPTY_OBJECT } from "file/xml-components"; - describe("Image", () => { let image: ImageParagraph; @@ -40,190 +36,4 @@ describe("Image", () => { assert.isTrue(true); }); }); - - describe("#scale()", () => { - it("should set the scale of the object properly", () => { - image.scale(2); - const tree = new Formatter().format(image); - expect(tree).to.deep.equal({ - "w:p": [ - { - "w:r": [ - { - "w:drawing": [ - { - "wp:inline": [ - { - _attr: { - distB: 0, - distL: 0, - distR: 0, - distT: 0, - }, - }, - { - "wp:extent": { - _attr: { - cx: 20, - cy: 20, - }, - }, - }, - { - "wp:effectExtent": { - _attr: { - b: 0, - l: 0, - r: 0, - t: 0, - }, - }, - }, - { - "wp:docPr": { - _attr: { - descr: "", - id: 0, - name: "", - }, - }, - }, - { - "wp:cNvGraphicFramePr": [ - { - "a:graphicFrameLocks": { - _attr: { - noChangeAspect: 1, - "xmlns:a": "http://schemas.openxmlformats.org/drawingml/2006/main", - }, - }, - }, - ], - }, - { - "a:graphic": [ - { - _attr: { - "xmlns:a": "http://schemas.openxmlformats.org/drawingml/2006/main", - }, - }, - { - "a:graphicData": [ - { - _attr: { - uri: "http://schemas.openxmlformats.org/drawingml/2006/picture", - }, - }, - { - "pic:pic": [ - { - _attr: { - "xmlns:pic": - "http://schemas.openxmlformats.org/drawingml/2006/picture", - }, - }, - { - "pic:nvPicPr": [ - { - "pic:cNvPr": { - _attr: { - desc: "", - id: 0, - name: "", - }, - }, - }, - { - "pic:cNvPicPr": [ - { - "a:picLocks": { - _attr: { - noChangeArrowheads: 1, - noChangeAspect: 1, - }, - }, - }, - ], - }, - ], - }, - { - "pic:blipFill": [ - { - "a:blip": { - _attr: { - cstate: "none", - "r:embed": "rId{test.png}", - }, - }, - }, - { - "a:srcRect": EMPTY_OBJECT, - }, - { - "a:stretch": [ - { - "a:fillRect": EMPTY_OBJECT, - }, - ], - }, - ], - }, - { - "pic:spPr": [ - { - _attr: { - bwMode: "auto", - }, - }, - { - "a:xfrm": [ - { - "a:ext": { - _attr: { - cx: 10, - cy: 10, - }, - }, - }, - { - "a:off": { - _attr: { - x: 0, - y: 0, - }, - }, - }, - ], - }, - { - "a:prstGeom": [ - { - _attr: { - prst: "rect", - }, - }, - { - "a:avLst": EMPTY_OBJECT, - }, - ], - }, - ], - }, - ], - }, - ], - }, - ], - }, - ], - }, - ], - }, - ], - }, - ], - }); - }); - }); }); diff --git a/src/file/paragraph/image.ts b/src/file/paragraph/image.ts index 634f76e517..4fa3d97b9f 100644 --- a/src/file/paragraph/image.ts +++ b/src/file/paragraph/image.ts @@ -7,15 +7,11 @@ export class ImageParagraph extends Paragraph { private readonly pictureRun: PictureRun; constructor(imageData: IMediaData, drawingOptions?: IDrawingOptions) { - super(); + super({}); this.pictureRun = new PictureRun(imageData, drawingOptions); this.root.push(this.pictureRun); } - public scale(factorX: number, factorY?: number): void { - this.pictureRun.scale(factorX, factorY); - } - public get Run(): PictureRun { return this.pictureRun; } diff --git a/src/file/paragraph/links/hyperlink.ts b/src/file/paragraph/links/hyperlink.ts index 3ed33f44ad..b41980ed77 100644 --- a/src/file/paragraph/links/hyperlink.ts +++ b/src/file/paragraph/links/hyperlink.ts @@ -20,7 +20,10 @@ export class Hyperlink extends XmlComponent { const attributes = new HyperlinkAttributes(props); this.root.push(attributes); - this.textRun = new TextRun(text).style("Hyperlink"); + this.textRun = new TextRun({ + text: text, + style: "Hyperlink", + }); this.root.push(this.textRun); } diff --git a/src/file/paragraph/links/outline-level.spec.ts b/src/file/paragraph/links/outline-level.spec.ts index 4b13ef03e2..96cb3ab500 100644 --- a/src/file/paragraph/links/outline-level.spec.ts +++ b/src/file/paragraph/links/outline-level.spec.ts @@ -9,12 +9,12 @@ describe("ParagraphOutlineLevel", () => { describe("#constructor()", () => { it("should create an outlineLevel with given value", () => { - outlineLevel = new OutlineLevel("0"); + outlineLevel = new OutlineLevel(0); const tree = new Formatter().format(outlineLevel); expect(tree).to.deep.equal({ "w:outlineLvl": { _attr: { - "w:val": "0", + "w:val": 0, }, }, }); diff --git a/src/file/paragraph/links/outline-level.ts b/src/file/paragraph/links/outline-level.ts index 512638bcc7..bb3258a02b 100644 --- a/src/file/paragraph/links/outline-level.ts +++ b/src/file/paragraph/links/outline-level.ts @@ -2,11 +2,9 @@ import { Attributes, XmlComponent } from "file/xml-components"; export class OutlineLevel extends XmlComponent { - public readonly level: string; - - constructor(level: string) { + constructor(public readonly level: number) { super("w:outlineLvl"); - this.level = level; + this.root.push( new Attributes({ val: level, diff --git a/src/file/paragraph/paragraph.spec.ts b/src/file/paragraph/paragraph.spec.ts index ed9dfbe6c4..91ee616a4e 100644 --- a/src/file/paragraph/paragraph.spec.ts +++ b/src/file/paragraph/paragraph.spec.ts @@ -1,22 +1,16 @@ import { assert, expect } from "chai"; import { Formatter } from "export/formatter"; -import * as file from "file"; - -import { Numbering } from "../numbering"; -import { LeaderType } from "./formatting"; - import { EMPTY_OBJECT } from "file/xml-components"; +import { Numbering } from "../numbering"; +import { AlignmentType, HeadingLevel, LeaderType } from "./formatting"; +import { Paragraph } from "./paragraph"; + describe("Paragraph", () => { - let paragraph: file.Paragraph; - - beforeEach(() => { - paragraph = new file.Paragraph(); - }); - describe("#constructor()", () => { it("should create valid JSON", () => { + const paragraph = new Paragraph(""); const stringifiedJson = JSON.stringify(paragraph); try { @@ -28,28 +22,18 @@ describe("Paragraph", () => { }); it("should create have valid properties", () => { + const paragraph = new Paragraph(""); const stringifiedJson = JSON.stringify(paragraph); const newJson = JSON.parse(stringifiedJson); assert.equal(newJson.root[0].rootKey, "w:pPr"); }); }); - describe("#createTextRun", () => { - it("should add a new run to the paragraph and return it", () => { - const run = paragraph.createTextRun("this is a test run"); - expect(run).to.be.instanceof(file.TextRun); - const tree = new Formatter().format(paragraph)["w:p"]; - expect(tree) - .to.be.an("array") - .which.includes({ - "w:r": [{ "w:t": [{ _attr: { "xml:space": "preserve" } }, "this is a test run"] }], - }); - }); - }); - describe("#heading1()", () => { it("should add heading style to JSON", () => { - paragraph.heading1(); + const paragraph = new Paragraph({ + heading: HeadingLevel.HEADING_1, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -63,7 +47,9 @@ describe("Paragraph", () => { describe("#heading2()", () => { it("should add heading style to JSON", () => { - paragraph.heading2(); + const paragraph = new Paragraph({ + heading: HeadingLevel.HEADING_2, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -77,7 +63,9 @@ describe("Paragraph", () => { describe("#heading3()", () => { it("should add heading style to JSON", () => { - paragraph.heading3(); + const paragraph = new Paragraph({ + heading: HeadingLevel.HEADING_3, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -91,7 +79,9 @@ describe("Paragraph", () => { describe("#heading4()", () => { it("should add heading style to JSON", () => { - paragraph.heading4(); + const paragraph = new Paragraph({ + heading: HeadingLevel.HEADING_4, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -105,7 +95,9 @@ describe("Paragraph", () => { describe("#heading5()", () => { it("should add heading style to JSON", () => { - paragraph.heading5(); + const paragraph = new Paragraph({ + heading: HeadingLevel.HEADING_5, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -119,7 +111,9 @@ describe("Paragraph", () => { describe("#heading6()", () => { it("should add heading style to JSON", () => { - paragraph.heading6(); + const paragraph = new Paragraph({ + heading: HeadingLevel.HEADING_6, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -133,7 +127,9 @@ describe("Paragraph", () => { describe("#title()", () => { it("should add title style to JSON", () => { - paragraph.title(); + const paragraph = new Paragraph({ + heading: HeadingLevel.TITLE, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -147,7 +143,9 @@ describe("Paragraph", () => { describe("#center()", () => { it("should add center alignment to JSON", () => { - paragraph.center(); + const paragraph = new Paragraph({ + alignment: AlignmentType.CENTER, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -161,7 +159,9 @@ describe("Paragraph", () => { describe("#left()", () => { it("should add left alignment to JSON", () => { - paragraph.left(); + const paragraph = new Paragraph({ + alignment: AlignmentType.LEFT, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -175,7 +175,9 @@ describe("Paragraph", () => { describe("#right()", () => { it("should add right alignment to JSON", () => { - paragraph.right(); + const paragraph = new Paragraph({ + alignment: AlignmentType.RIGHT, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -189,7 +191,9 @@ describe("Paragraph", () => { describe("#start()", () => { it("should add start alignment to JSON", () => { - paragraph.start(); + const paragraph = new Paragraph({ + alignment: AlignmentType.START, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -203,7 +207,9 @@ describe("Paragraph", () => { describe("#end()", () => { it("should add end alignment to JSON", () => { - paragraph.end(); + const paragraph = new Paragraph({ + alignment: AlignmentType.END, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -217,7 +223,9 @@ describe("Paragraph", () => { describe("#distribute()", () => { it("should add distribute alignment to JSON", () => { - paragraph.distribute(); + const paragraph = new Paragraph({ + alignment: AlignmentType.DISTRIBUTE, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -231,7 +239,9 @@ describe("Paragraph", () => { describe("#justified()", () => { it("should add justified alignment to JSON", () => { - paragraph.justified(); + const paragraph = new Paragraph({ + alignment: AlignmentType.JUSTIFIED, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -245,7 +255,11 @@ describe("Paragraph", () => { describe("#maxRightTabStop()", () => { it("should add maxRightTabStop to JSON", () => { - paragraph.maxRightTabStop(); + const paragraph = new Paragraph({ + tabStop: { + maxRight: {}, + }, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -272,7 +286,14 @@ describe("Paragraph", () => { describe("#leftTabStop()", () => { it("should add leftTabStop to JSON", () => { - paragraph.leftTabStop(100, LeaderType.HYPHEN); + const paragraph = new Paragraph({ + tabStop: { + left: { + position: 100, + leader: LeaderType.HYPHEN, + }, + }, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -300,7 +321,14 @@ describe("Paragraph", () => { describe("#rightTabStop()", () => { it("should add rightTabStop to JSON", () => { - paragraph.rightTabStop(100, LeaderType.DOT); + const paragraph = new Paragraph({ + tabStop: { + right: { + position: 100, + leader: LeaderType.DOT, + }, + }, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -328,7 +356,14 @@ describe("Paragraph", () => { describe("#centerTabStop()", () => { it("should add centerTabStop to JSON", () => { - paragraph.centerTabStop(100, LeaderType.MIDDLE_DOT); + const paragraph = new Paragraph({ + tabStop: { + center: { + position: 100, + leader: LeaderType.MIDDLE_DOT, + }, + }, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -356,7 +391,9 @@ describe("Paragraph", () => { describe("#contextualSpacing()", () => { it("should add contextualSpacing to JSON, and set 1 if true", () => { - paragraph.contextualSpacing(true); + const paragraph = new Paragraph({ + contextualSpacing: true, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -366,23 +403,13 @@ describe("Paragraph", () => { ], }); }); - - it("should add contextualSpacing to JSON, and set 0 if false", () => { - paragraph.contextualSpacing(false); - const tree = new Formatter().format(paragraph); - expect(tree).to.deep.equal({ - "w:p": [ - { - "w:pPr": [{ "w:contextualSpacing": { _attr: { "w:val": 0 } } }], - }, - ], - }); - }); }); describe("#thematicBreak()", () => { it("should add thematic break to JSON", () => { - paragraph.thematicBreak(); + const paragraph = new Paragraph({ + thematicBreak: true, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -395,8 +422,8 @@ describe("Paragraph", () => { _attr: { "w:val": "single", "w:color": "auto", - "w:space": "1", - "w:sz": "6", + "w:space": 1, + "w:sz": 6, }, }, }, @@ -411,9 +438,22 @@ describe("Paragraph", () => { describe("#paragraphBorders()", () => { it("should add a left and right border to a paragraph", () => { - paragraph.createBorder(); - paragraph.Borders.addLeftBorder(); - paragraph.Borders.addRightBorder(); + const paragraph = new Paragraph({ + border: { + left: { + color: "auto", + space: 1, + value: "single", + size: 6, + }, + right: { + color: "auto", + space: 1, + value: "single", + size: 6, + }, + }, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -425,8 +465,8 @@ describe("Paragraph", () => { "w:left": { _attr: { "w:color": "auto", - "w:space": "1", - "w:sz": "6", + "w:space": 1, + "w:sz": 6, "w:val": "single", }, }, @@ -435,8 +475,8 @@ describe("Paragraph", () => { "w:right": { _attr: { "w:color": "auto", - "w:space": "1", - "w:sz": "6", + "w:space": 1, + "w:sz": 6, "w:val": "single", }, }, @@ -452,6 +492,7 @@ describe("Paragraph", () => { describe("#pageBreak()", () => { it("should add page break to JSON", () => { + const paragraph = new Paragraph({}); paragraph.pageBreak(); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ @@ -466,7 +507,9 @@ describe("Paragraph", () => { describe("#pageBreakBefore()", () => { it("should add page break before to JSON", () => { - paragraph.pageBreakBefore(); + const paragraph = new Paragraph({ + pageBreakBefore: true, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -484,7 +527,11 @@ describe("Paragraph", () => { describe("#bullet()", () => { it("should default to 0 indent level if no bullet was specified", () => { - paragraph.bullet(); + const paragraph = new Paragraph({ + bullet: { + level: 0, + }, + }); const tree = new Formatter().format(paragraph); expect(tree) .to.have.property("w:p") @@ -500,7 +547,11 @@ describe("Paragraph", () => { }); it("should add list paragraph style to JSON", () => { - paragraph.bullet(0); + const paragraph = new Paragraph({ + bullet: { + level: 0, + }, + }); const tree = new Formatter().format(paragraph); expect(tree) .to.have.property("w:p") @@ -516,7 +567,11 @@ describe("Paragraph", () => { }); it("it should add numbered properties", () => { - paragraph.bullet(1); + const paragraph = new Paragraph({ + bullet: { + level: 1, + }, + }); const tree = new Formatter().format(paragraph); expect(tree) .to.have.property("w:p") @@ -539,7 +594,12 @@ describe("Paragraph", () => { numberedAbstract.createLevel(0, "lowerLetter", "%1)", "start"); const letterNumbering = numbering.createConcreteNumbering(numberedAbstract); - paragraph.setNumbering(letterNumbering, 0); + const paragraph = new Paragraph({ + numbering: { + num: letterNumbering, + level: 0, + }, + }); const tree = new Formatter().format(paragraph); expect(tree) .to.have.property("w:p") @@ -560,7 +620,12 @@ describe("Paragraph", () => { numberedAbstract.createLevel(0, "lowerLetter", "%1)", "start"); const letterNumbering = numbering.createConcreteNumbering(numberedAbstract); - paragraph.setNumbering(letterNumbering, 0); + const paragraph = new Paragraph({ + numbering: { + num: letterNumbering, + level: 0, + }, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -582,7 +647,9 @@ describe("Paragraph", () => { describe("#style", () => { it("should set the paragraph style to the given styleId", () => { - paragraph.style("myFancyStyle"); + const paragraph = new Paragraph({ + style: "myFancyStyle", + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -596,7 +663,9 @@ describe("Paragraph", () => { describe("#indent", () => { it("should set the paragraph indent to the given values", () => { - paragraph.indent({ left: 720 }); + const paragraph = new Paragraph({ + indent: { left: 720 }, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -610,7 +679,9 @@ describe("Paragraph", () => { describe("#spacing", () => { it("should set the paragraph spacing to the given values", () => { - paragraph.spacing({ before: 90, line: 50 }); + const paragraph = new Paragraph({ + spacing: { before: 90, line: 50 }, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ @@ -624,7 +695,9 @@ describe("Paragraph", () => { describe("#keepLines", () => { it("should set the paragraph keepLines sub-component", () => { - paragraph.keepLines(); + const paragraph = new Paragraph({ + keepLines: true, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [{ "w:pPr": [{ "w:keepLines": EMPTY_OBJECT }] }], @@ -634,7 +707,9 @@ describe("Paragraph", () => { describe("#keepNext", () => { it("should set the paragraph keepNext sub-component", () => { - paragraph.keepNext(); + const paragraph = new Paragraph({ + keepNext: true, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [{ "w:pPr": [{ "w:keepNext": EMPTY_OBJECT }] }], @@ -644,7 +719,9 @@ describe("Paragraph", () => { describe("#bidirectional", () => { it("set paragraph right to left layout", () => { - paragraph.bidirectional(); + const paragraph = new Paragraph({ + bidirectional: true, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [{ "w:pPr": [{ "w:bidi": EMPTY_OBJECT }] }], @@ -654,12 +731,14 @@ describe("Paragraph", () => { describe("#outlineLevel", () => { it("should set paragraph outline level to the given value", () => { - paragraph.outlineLevel("0"); + const paragraph = new Paragraph({ + outlineLevel: 0, + }); const tree = new Formatter().format(paragraph); expect(tree).to.deep.equal({ "w:p": [ { - "w:pPr": [{ "w:outlineLvl": { _attr: { "w:val": "0" } } }], + "w:pPr": [{ "w:outlineLvl": { _attr: { "w:val": 0 } } }], }, ], }); diff --git a/src/file/paragraph/paragraph.ts b/src/file/paragraph/paragraph.ts index cfd32322c2..3f39ba68bc 100644 --- a/src/file/paragraph/paragraph.ts +++ b/src/file/paragraph/paragraph.ts @@ -4,43 +4,172 @@ import { Image } from "file/media"; import { Num } from "file/numbering/num"; import { XmlComponent } from "file/xml-components"; -import { Alignment, AlignmentOptions } from "./formatting/alignment"; +import { Alignment, AlignmentType } from "./formatting/alignment"; import { Bidirectional } from "./formatting/bidirectional"; -import { Border, ThematicBreak } from "./formatting/border"; +import { IBorderOptions, ThematicBreak } from "./formatting/border"; import { IIndentAttributesProperties, Indent } from "./formatting/indent"; import { KeepLines, KeepNext } from "./formatting/keep"; import { PageBreak, PageBreakBefore } from "./formatting/page-break"; import { ContextualSpacing, ISpacingProperties, Spacing } from "./formatting/spacing"; -import { Style } from "./formatting/style"; +import { HeadingLevel, Style } from "./formatting/style"; import { CenterTabStop, LeaderType, LeftTabStop, MaxRightTabStop, RightTabStop } from "./formatting/tab-stop"; import { NumberProperties } from "./formatting/unordered-list"; import { Bookmark, Hyperlink, OutlineLevel } from "./links"; import { ParagraphProperties } from "./properties"; import { PictureRun, Run, SequentialIdentifier, TextRun } from "./run"; +interface ITabStopOptions { + readonly position: number; + readonly leader?: LeaderType; +} + +export interface IParagraphOptions { + readonly text?: string; + readonly border?: IBorderOptions; + readonly spacing?: ISpacingProperties; + readonly outlineLevel?: number; + readonly alignment?: AlignmentType; + readonly heading?: HeadingLevel; + readonly bidirectional?: boolean; + readonly thematicBreak?: boolean; + readonly pageBreakBefore?: boolean; + readonly contextualSpacing?: boolean; + readonly indent?: IIndentAttributesProperties; + readonly keepLines?: boolean; + readonly keepNext?: boolean; + readonly tabStop?: { + readonly left?: ITabStopOptions; + readonly right?: ITabStopOptions; + readonly maxRight?: { + readonly leader?: LeaderType; + }; + readonly center?: ITabStopOptions; + }; + readonly style?: string; + readonly bullet?: { + readonly level: number; + }; + readonly numbering?: { + readonly num: Num; + readonly level: number; + readonly custom?: boolean; + }; + readonly children?: Array; +} + export class Paragraph extends XmlComponent { private readonly properties: ParagraphProperties; - constructor(text?: string) { + constructor(options: string | PictureRun | IParagraphOptions) { super("w:p"); - this.properties = new ParagraphProperties(); - this.root.push(this.properties); - if (text !== undefined) { - this.root.push(new TextRun(text)); + + if (typeof options === "string") { + this.properties = new ParagraphProperties({}); + this.root.push(this.properties); + this.root.push(new TextRun(options)); + return; } - } - public get paragraphProperties(): ParagraphProperties { - return this.properties; - } + if (options instanceof PictureRun) { + this.properties = new ParagraphProperties({}); + this.root.push(this.properties); + this.root.push(options); + return; + } - public get Borders(): Border { - return this.properties.paragraphBorder; - } + this.properties = new ParagraphProperties({ + border: options.border, + }); - public createBorder(): Paragraph { - this.properties.createBorder(); - return this; + this.root.push(this.properties); + + if (options.text) { + this.root.push(new TextRun(options.text)); + } + + if (options.spacing) { + this.properties.push(new Spacing(options.spacing)); + } + + if (options.outlineLevel !== undefined) { + this.properties.push(new OutlineLevel(options.outlineLevel)); + } + + if (options.alignment) { + this.properties.push(new Alignment(options.alignment)); + } + + if (options.heading) { + this.properties.push(new Style(options.heading)); + } + + if (options.bidirectional) { + this.properties.push(new Bidirectional()); + } + + if (options.thematicBreak) { + this.properties.push(new ThematicBreak()); + } + + if (options.pageBreakBefore) { + this.properties.push(new PageBreakBefore()); + } + + if (options.contextualSpacing) { + this.properties.push(new ContextualSpacing(options.contextualSpacing)); + } + + if (options.indent) { + this.properties.push(new Indent(options.indent)); + } + + if (options.keepLines) { + this.properties.push(new KeepLines()); + } + + if (options.keepNext) { + this.properties.push(new KeepNext()); + } + + if (options.tabStop) { + if (options.tabStop.left) { + this.properties.push(new LeftTabStop(options.tabStop.left.position, options.tabStop.left.leader)); + } + + if (options.tabStop.right) { + this.properties.push(new RightTabStop(options.tabStop.right.position, options.tabStop.right.leader)); + } + + if (options.tabStop.maxRight) { + this.properties.push(new MaxRightTabStop(options.tabStop.maxRight.leader)); + } + + if (options.tabStop.center) { + this.properties.push(new CenterTabStop(options.tabStop.center.position, options.tabStop.center.leader)); + } + } + + if (options.style) { + this.properties.push(new Style(options.style)); + } + + if (options.bullet) { + this.properties.push(new Style("ListParagraph")); + this.properties.push(new NumberProperties(1, options.bullet.level)); + } + + if (options.numbering) { + if (!options.numbering.custom) { + this.properties.push(new Style("ListParagraph")); + } + this.properties.push(new NumberProperties(options.numbering.num.id, options.numbering.level)); + } + + if (options.children) { + for (const child of options.children) { + this.root.push(child); + } + } } public addRun(run: Run): Paragraph { @@ -61,12 +190,6 @@ export class Paragraph extends XmlComponent { return this; } - public createTextRun(text: string): TextRun { - const run = new TextRun(text); - this.addRun(run); - return run; - } - public addImage(image: Image): PictureRun { const run = image.Run; this.addRun(run); @@ -74,158 +197,11 @@ export class Paragraph extends XmlComponent { return run; } - public heading1(): Paragraph { - this.properties.push(new Style("Heading1")); - return this; - } - - public heading2(): Paragraph { - this.properties.push(new Style("Heading2")); - return this; - } - - public heading3(): Paragraph { - this.properties.push(new Style("Heading3")); - return this; - } - - public heading4(): Paragraph { - this.properties.push(new Style("Heading4")); - return this; - } - - public heading5(): Paragraph { - this.properties.push(new Style("Heading5")); - return this; - } - - public heading6(): Paragraph { - this.properties.push(new Style("Heading6")); - return this; - } - - public title(): Paragraph { - this.properties.push(new Style("Title")); - return this; - } - - public center(): Paragraph { - this.properties.push(new Alignment(AlignmentOptions.CENTER)); - return this; - } - - public left(): Paragraph { - this.properties.push(new Alignment(AlignmentOptions.LEFT)); - return this; - } - - public right(): Paragraph { - this.properties.push(new Alignment(AlignmentOptions.RIGHT)); - return this; - } - - public start(): Paragraph { - this.properties.push(new Alignment(AlignmentOptions.START)); - return this; - } - - public end(): Paragraph { - this.properties.push(new Alignment(AlignmentOptions.END)); - return this; - } - - public distribute(): Paragraph { - this.properties.push(new Alignment(AlignmentOptions.DISTRIBUTE)); - return this; - } - - public justified(): Paragraph { - this.properties.push(new Alignment(AlignmentOptions.BOTH)); - return this; - } - - public thematicBreak(): Paragraph { - this.properties.push(new ThematicBreak()); - return this; - } - public pageBreak(): Paragraph { this.root.push(new PageBreak()); return this; } - public pageBreakBefore(): Paragraph { - this.properties.push(new PageBreakBefore()); - return this; - } - - public maxRightTabStop(leader?: LeaderType): Paragraph { - this.properties.push(new MaxRightTabStop(leader)); - return this; - } - - public leftTabStop(position: number, leader?: LeaderType): Paragraph { - this.properties.push(new LeftTabStop(position, leader)); - return this; - } - - public rightTabStop(position: number, leader?: LeaderType): Paragraph { - this.properties.push(new RightTabStop(position, leader)); - return this; - } - - public centerTabStop(position: number, leader?: LeaderType): Paragraph { - this.properties.push(new CenterTabStop(position, leader)); - return this; - } - - public bullet(indentLevel: number = 0): Paragraph { - this.properties.push(new Style("ListParagraph")); - this.properties.push(new NumberProperties(1, indentLevel)); - return this; - } - - public setNumbering(numbering: Num, indentLevel: number): Paragraph { - this.properties.push(new Style("ListParagraph")); - this.properties.push(new NumberProperties(numbering.id, indentLevel)); - return this; - } - - public setCustomNumbering(numberId: number, indentLevel: number): Paragraph { - this.properties.push(new NumberProperties(numberId, indentLevel)); - return this; - } - - public style(styleId: string): Paragraph { - this.properties.push(new Style(styleId)); - return this; - } - - public indent(attrs: IIndentAttributesProperties): Paragraph { - this.properties.push(new Indent(attrs)); - return this; - } - - public spacing(params: ISpacingProperties): Paragraph { - this.properties.push(new Spacing(params)); - return this; - } - - public contextualSpacing(value: boolean): Paragraph { - this.properties.push(new ContextualSpacing(value)); - return this; - } - - public keepNext(): Paragraph { - this.properties.push(new KeepNext()); - return this; - } - - public keepLines(): Paragraph { - this.properties.push(new KeepLines()); - return this; - } - public referenceFootnote(id: number): Paragraph { this.root.push(new FootnoteReferenceRun(id)); return this; @@ -236,18 +212,8 @@ export class Paragraph extends XmlComponent { return this; } - public bidirectional(): Paragraph { - this.properties.push(new Bidirectional()); - return this; - } - public addSequentialIdentifier(identifier: string): Paragraph { this.root.push(new SequentialIdentifier(identifier)); return this; } - - public outlineLevel(level: string): Paragraph { - this.properties.push(new OutlineLevel(level)); - return this; - } } diff --git a/src/file/paragraph/properties.ts b/src/file/paragraph/properties.ts index 188960145c..35836ce30e 100644 --- a/src/file/paragraph/properties.ts +++ b/src/file/paragraph/properties.ts @@ -1,17 +1,19 @@ // http://officeopenxml.com/WPparagraphProperties.php import { IgnoreIfEmptyXmlComponent, XmlComponent } from "file/xml-components"; -import { Border } from "./formatting/border"; + +import { Border, IBorderOptions } from "./formatting/border"; + +interface IParagraphPropertiesOptions { + readonly border?: IBorderOptions; +} export class ParagraphProperties extends IgnoreIfEmptyXmlComponent { - public readonly paragraphBorder: Border; - - constructor() { + constructor(options: IParagraphPropertiesOptions) { super("w:pPr"); - this.paragraphBorder = new Border(); - } - public createBorder(): void { - this.push(this.paragraphBorder); + if (options.border) { + this.push(new Border(options.border)); + } } public push(item: XmlComponent): void { diff --git a/src/file/paragraph/run/formatting.ts b/src/file/paragraph/run/formatting.ts index 30d437e268..549f2ae552 100644 --- a/src/file/paragraph/run/formatting.ts +++ b/src/file/paragraph/run/formatting.ts @@ -113,7 +113,7 @@ export class Imprint extends XmlComponent { } } -export class Shadow extends XmlComponent { +/* export class Shadow extends XmlComponent { constructor() { super("w:shadow"); this.root.push( @@ -122,7 +122,7 @@ export class Shadow extends XmlComponent { }), ); } -} +} */ export class SmallCaps extends XmlComponent { constructor() { @@ -178,3 +178,51 @@ export class RightToLeft extends XmlComponent { ); } } + +export class Highlight extends XmlComponent { + constructor(color: string) { + super("w:highlight"); + this.root.push( + new Attributes({ + val: color, + }), + ); + } +} + +export class HighlightComplexScript extends XmlComponent { + constructor(color: string) { + super("w:highlightCs"); + this.root.push( + new Attributes({ + val: color, + }), + ); + } +} + +export class Shading extends XmlComponent { + constructor(value: string, fill: string, color: string) { + super("w:shd"); + this.root.push( + new Attributes({ + val: value, + fill: fill, + color: color, + }), + ); + } +} + +export class ShadowComplexScript extends XmlComponent { + constructor(value: string, fill: string, color: string) { + super("w:shdCs"); + this.root.push( + new Attributes({ + val: value, + fill: fill, + color: color, + }), + ); + } +} diff --git a/src/file/paragraph/run/picture-run.ts b/src/file/paragraph/run/picture-run.ts index 15da74eb56..c796beebfc 100644 --- a/src/file/paragraph/run/picture-run.ts +++ b/src/file/paragraph/run/picture-run.ts @@ -4,21 +4,15 @@ import { IMediaData } from "../../media/data"; import { Run } from "../run"; export class PictureRun extends Run { - private readonly drawing: Drawing; - constructor(imageData: IMediaData, drawingOptions?: IDrawingOptions) { - super(); + super({}); if (imageData === undefined) { throw new Error("imageData cannot be undefined"); } - this.drawing = new Drawing(imageData, drawingOptions); + const drawing = new Drawing(imageData, drawingOptions); - this.root.push(this.drawing); - } - - public scale(factorX: number = 1, factorY: number = factorX): void { - this.drawing.scale(factorX, factorY); + this.root.push(drawing); } } diff --git a/src/file/paragraph/run/run.spec.ts b/src/file/paragraph/run/run.spec.ts index 174ef86da0..87a947932a 100644 --- a/src/file/paragraph/run/run.spec.ts +++ b/src/file/paragraph/run/run.spec.ts @@ -1,19 +1,17 @@ import { expect } from "chai"; import { Formatter } from "export/formatter"; +import { ShadingType } from "file/table"; import { Run } from "./"; +import { UnderlineType } from "./underline"; describe("Run", () => { - let run: Run; - - beforeEach(() => { - run = new Run(); - }); - describe("#bold()", () => { it("it should add bold to the properties", () => { - run.bold(); + const run = new Run({ + bold: true, + }); const tree = new Formatter().format(run); expect(tree).to.deep.equal({ "w:r": [ @@ -36,7 +34,9 @@ describe("Run", () => { describe("#italics()", () => { it("it should add italics to the properties", () => { - run.italics(); + const run = new Run({ + italics: true, + }); const tree = new Formatter().format(run); expect(tree).to.deep.equal({ "w:r": [ @@ -59,7 +59,9 @@ describe("Run", () => { describe("#underline()", () => { it("should default to 'single' and no color", () => { - run.underline(); + const run = new Run({ + underline: {}, + }); const tree = new Formatter().format(run); expect(tree).to.deep.equal({ "w:r": [{ "w:rPr": [{ "w:u": { _attr: { "w:val": "single" } } }] }], @@ -67,7 +69,12 @@ describe("Run", () => { }); it("should set the style type and color if given", () => { - run.underline("double", "990011"); + const run = new Run({ + underline: { + type: UnderlineType.DOUBLE, + color: "990011", + }, + }); const tree = new Formatter().format(run); expect(tree).to.deep.equal({ "w:r": [{ "w:rPr": [{ "w:u": { _attr: { "w:val": "double", "w:color": "990011" } } }] }], @@ -77,7 +84,9 @@ describe("Run", () => { describe("#smallCaps()", () => { it("it should add smallCaps to the properties", () => { - run.smallCaps(); + const run = new Run({ + smallCaps: true, + }); const tree = new Formatter().format(run); expect(tree).to.deep.equal({ "w:r": [{ "w:rPr": [{ "w:smallCaps": {} }] }], @@ -87,7 +96,9 @@ describe("Run", () => { describe("#caps()", () => { it("it should add caps to the properties", () => { - run.allCaps(); + const run = new Run({ + allCaps: true, + }); const tree = new Formatter().format(run); expect(tree).to.deep.equal({ "w:r": [{ "w:rPr": [{ "w:caps": {} }] }], @@ -97,7 +108,9 @@ describe("Run", () => { describe("#strike()", () => { it("it should add strike to the properties", () => { - run.strike(); + const run = new Run({ + strike: true, + }); const tree = new Formatter().format(run); expect(tree).to.deep.equal({ "w:r": [{ "w:rPr": [{ "w:strike": { _attr: { "w:val": true } } }] }], @@ -107,7 +120,9 @@ describe("Run", () => { describe("#doubleStrike()", () => { it("it should add caps to the properties", () => { - run.doubleStrike(); + const run = new Run({ + doubleStrike: true, + }); const tree = new Formatter().format(run); expect(tree).to.deep.equal({ "w:r": [{ "w:rPr": [{ "w:dstrike": { _attr: { "w:val": true } } }] }], @@ -115,8 +130,65 @@ describe("Run", () => { }); }); + describe("#highlight()", () => { + it("it should add highlight to the properties", () => { + const run = new Run({ + highlight: "005599", + }); + const tree = new Formatter().format(run); + expect(tree).to.deep.equal({ + "w:r": [ + { + "w:rPr": [ + { "w:highlight": { _attr: { "w:val": "005599" } } }, + { + "w:highlightCs": { + _attr: { + "w:val": "005599", + }, + }, + }, + ], + }, + ], + }); + }); + }); + + describe("#shadow()", () => { + it("it should add shadow to the properties", () => { + const run = new Run({ + shading: { + type: ShadingType.PERCENT_10, + fill: "00FFFF", + color: "FF0000", + }, + }); + const tree = new Formatter().format(run); + expect(tree).to.deep.equal({ + "w:r": [ + { + "w:rPr": [ + { "w:shd": { _attr: { "w:val": "pct10", "w:fill": "00FFFF", "w:color": "FF0000" } } }, + { + "w:shdCs": { + _attr: { + "w:val": "pct10", + "w:fill": "00FFFF", + "w:color": "FF0000", + }, + }, + }, + ], + }, + ], + }); + }); + }); + describe("#break()", () => { it("it should add break to the run", () => { + const run = new Run({}); run.break(); const tree = new Formatter().format(run); expect(tree).to.deep.equal({ @@ -127,6 +199,7 @@ describe("Run", () => { describe("#tab()", () => { it("it should add break to the run", () => { + const run = new Run({}); run.tab(); const tree = new Formatter().format(run); expect(tree).to.deep.equal({ @@ -136,12 +209,12 @@ describe("Run", () => { }); describe("#font()", () => { - it("should allow chaining calls", () => { - expect(run.font("Times")).to.equal(run); - }); - it("should set the font as named", () => { - run.font("Times"); + const run = new Run({ + font: { + name: "Times", + }, + }); const tree = new Formatter().format(run); expect(tree).to.deep.equal({ "w:r": [ @@ -157,7 +230,9 @@ describe("Run", () => { describe("#color", () => { it("should set the run to the color given", () => { - run.color("001122"); + const run = new Run({ + color: "001122", + }); const tree = new Formatter().format(run); expect(tree).to.deep.equal({ "w:r": [{ "w:rPr": [{ "w:color": { _attr: { "w:val": "001122" } } }] }], @@ -167,7 +242,9 @@ describe("Run", () => { describe("#size", () => { it("should set the run to the given size", () => { - run.size(24); + const run = new Run({ + size: 24, + }); const tree = new Formatter().format(run); expect(tree).to.deep.equal({ "w:r": [ @@ -181,7 +258,9 @@ describe("Run", () => { describe("#rtl", () => { it("should set the run to the RTL mode", () => { - run.rightToLeft(); + const run = new Run({ + rightToLeft: true, + }); const tree = new Formatter().format(run); expect(tree).to.deep.equal({ "w:r": [{ "w:rPr": [{ "w:rtl": { _attr: { "w:val": true } } }] }], @@ -191,6 +270,7 @@ describe("Run", () => { describe("#numberOfTotalPages", () => { it("should set the run to the RTL mode", () => { + const run = new Run({}); run.numberOfTotalPages(); const tree = new Formatter().format(run); expect(tree).to.deep.equal({ @@ -221,6 +301,7 @@ describe("Run", () => { describe("#pageNumber", () => { it("should set the run to the RTL mode", () => { + const run = new Run({}); run.pageNumber(); const tree = new Formatter().format(run); expect(tree).to.deep.equal({ @@ -236,7 +317,9 @@ describe("Run", () => { describe("#style", () => { it("should set the style to the given styleId", () => { - run.style("myRunStyle"); + const run = new Run({ + style: "myRunStyle", + }); const tree = new Formatter().format(run); expect(tree).to.deep.equal({ "w:r": [{ "w:rPr": [{ "w:rStyle": { _attr: { "w:val": "myRunStyle" } } }] }], diff --git a/src/file/paragraph/run/run.ts b/src/file/paragraph/run/run.ts index 432a6c79e0..c147fe5e67 100644 --- a/src/file/paragraph/run/run.ts +++ b/src/file/paragraph/run/run.ts @@ -1,4 +1,7 @@ // http://officeopenxml.com/WPtext.php +import { ShadingType } from "file/table"; +import { XmlComponent } from "file/xml-components"; + import { Break } from "./break"; import { Caps, SmallCaps } from "./caps"; import { Begin, End, Separate } from "./field"; @@ -7,9 +10,13 @@ import { BoldComplexScript, Color, DoubleStrike, + Highlight, + HighlightComplexScript, Italics, ItalicsComplexScript, RightToLeft, + Shading, + ShadowComplexScript, Size, SizeComplexScript, Strike, @@ -20,50 +27,113 @@ import { RunFonts } from "./run-fonts"; import { SubScript, SuperScript } from "./script"; import { Style } from "./style"; import { Tab } from "./tab"; -import { Underline } from "./underline"; +import { Underline, UnderlineType } from "./underline"; -import { XmlComponent } from "file/xml-components"; +export interface IRunOptions { + readonly bold?: true; + readonly italics?: true; + readonly underline?: { + readonly color?: string; + readonly type?: UnderlineType; + }; + readonly color?: string; + readonly size?: number; + readonly rightToLeft?: boolean; + readonly smallCaps?: boolean; + readonly allCaps?: boolean; + readonly strike?: boolean; + readonly doubleStrike?: boolean; + readonly subScript?: boolean; + readonly superScript?: boolean; + readonly style?: string; + readonly font?: { + readonly name: string; + readonly hint?: string; + }; + readonly highlight?: string; + readonly shading?: { + readonly type: ShadingType; + readonly fill: string; + readonly color: string; + }; +} export class Run extends XmlComponent { protected readonly properties: RunProperties; - constructor() { + constructor(options: IRunOptions) { super("w:r"); this.properties = new RunProperties(); this.root.push(this.properties); - } - public bold(): Run { - this.properties.push(new Bold()); - this.properties.push(new BoldComplexScript()); - return this; - } + if (options.bold) { + this.properties.push(new Bold()); + this.properties.push(new BoldComplexScript()); + } - public italics(): Run { - this.properties.push(new Italics()); - this.properties.push(new ItalicsComplexScript()); - return this; - } + if (options.italics) { + this.properties.push(new Italics()); + this.properties.push(new ItalicsComplexScript()); + } - public underline(underlineType?: string, color?: string): Run { - this.properties.push(new Underline(underlineType, color)); - return this; - } + if (options.underline) { + this.properties.push(new Underline(options.underline.type, options.underline.color)); + } - public color(color: string): Run { - this.properties.push(new Color(color)); - return this; - } + if (options.color) { + this.properties.push(new Color(options.color)); + } - public size(size: number): Run { - this.properties.push(new Size(size)); - this.properties.push(new SizeComplexScript(size)); - return this; - } + if (options.size) { + this.properties.push(new Size(options.size)); + this.properties.push(new SizeComplexScript(options.size)); + } - public rightToLeft(): Run { - this.properties.push(new RightToLeft()); - return this; + if (options.rightToLeft) { + this.properties.push(new RightToLeft()); + } + + if (options.smallCaps) { + this.properties.push(new SmallCaps()); + } + + if (options.allCaps) { + this.properties.push(new Caps()); + } + + if (options.strike) { + this.properties.push(new Strike()); + } + + if (options.doubleStrike) { + this.properties.push(new DoubleStrike()); + } + + if (options.subScript) { + this.properties.push(new SubScript()); + } + + if (options.superScript) { + this.properties.push(new SuperScript()); + } + + if (options.style) { + this.properties.push(new Style(options.style)); + } + + if (options.font) { + this.properties.push(new RunFonts(options.font.name, options.font.hint)); + } + + if (options.highlight) { + this.properties.push(new Highlight(options.highlight)); + this.properties.push(new HighlightComplexScript(options.highlight)); + } + + if (options.shading) { + this.properties.push(new Shading(options.shading.type, options.shading.fill, options.shading.color)); + this.properties.push(new ShadowComplexScript(options.shading.type, options.shading.fill, options.shading.color)); + } } public break(): Run { @@ -99,44 +169,4 @@ export class Run extends XmlComponent { this.root.push(new End()); return this; } - - public smallCaps(): Run { - this.properties.push(new SmallCaps()); - return this; - } - - public allCaps(): Run { - this.properties.push(new Caps()); - return this; - } - - public strike(): Run { - this.properties.push(new Strike()); - return this; - } - - public doubleStrike(): Run { - this.properties.push(new DoubleStrike()); - return this; - } - - public subScript(): Run { - this.properties.push(new SubScript()); - return this; - } - - public superScript(): Run { - this.properties.push(new SuperScript()); - return this; - } - - public font(fontName: string, hint?: string | undefined): Run { - this.properties.push(new RunFonts(fontName, hint)); - return this; - } - - public style(styleId: string): Run { - this.properties.push(new Style(styleId)); - return this; - } } diff --git a/src/file/paragraph/run/sequential-identifier.ts b/src/file/paragraph/run/sequential-identifier.ts index 5536eca4ae..e193307e83 100644 --- a/src/file/paragraph/run/sequential-identifier.ts +++ b/src/file/paragraph/run/sequential-identifier.ts @@ -4,7 +4,7 @@ import { SequentialIdentifierInstruction } from "./sequential-identifier-instruc export class SequentialIdentifier extends Run { constructor(identifier: string) { - super(); + super({}); this.root.push(new Begin(true)); this.root.push(new SequentialIdentifierInstruction(identifier)); this.root.push(new Separate()); diff --git a/src/file/paragraph/run/text-run.ts b/src/file/paragraph/run/text-run.ts index 4b0474edc6..eeacf2dfd5 100644 --- a/src/file/paragraph/run/text-run.ts +++ b/src/file/paragraph/run/text-run.ts @@ -1,9 +1,19 @@ -import { Run } from "../run"; +import { IRunOptions, Run } from "./run"; import { Text } from "./run-components/text"; +export interface ITextRunOptions extends IRunOptions { + readonly text: string; +} + export class TextRun extends Run { - constructor(text: string) { - super(); - this.root.push(new Text(text)); + constructor(options: ITextRunOptions | string) { + if (typeof options === "string") { + super({}); + this.root.push(new Text(options)); + return; + } + + super(options); + this.root.push(new Text(options.text)); } } diff --git a/src/file/paragraph/run/underline.ts b/src/file/paragraph/run/underline.ts index bb994e040b..7d4a1c98d1 100644 --- a/src/file/paragraph/run/underline.ts +++ b/src/file/paragraph/run/underline.ts @@ -1,5 +1,25 @@ import { Attributes, XmlComponent } from "file/xml-components"; +export enum UnderlineType { + SINGLE = "single", + WORDS = "words", + DOUBLE = "double", + THICK = "thick", + DOTTED = "dotted", + DOTTEDHEAVY = "dottedHeavy", + DASH = "dash", + DASHEDHEAVY = "dashedHeavy", + DASHLONG = "dashLong", + DASHLONGHEAVY = "dashLongHeavy", + DOTDASH = "dotDash", + DASHDOTHEAVY = "dashDotHeavy", + DOTDOTDASH = "dotDotDash", + DASHDOTDOTHEAVY = "dashDotDotHeavy", + WAVE = "wave", + WAVYHEAVY = "wavyHeavy", + WAVYDOUBLE = "wavyDouble", +} + export abstract class BaseUnderline extends XmlComponent { constructor(underlineType: string, color?: string) { super("w:u"); diff --git a/src/file/styles/defaults/paragraph-properties.ts b/src/file/styles/defaults/paragraph-properties.ts index 1ab3b623d6..c5f2bee86c 100644 --- a/src/file/styles/defaults/paragraph-properties.ts +++ b/src/file/styles/defaults/paragraph-properties.ts @@ -4,6 +4,6 @@ import { XmlComponent } from "file/xml-components"; export class ParagraphPropertiesDefaults extends XmlComponent { constructor() { super("w:pPrDefault"); - this.root.push(new ParagraphProperties()); + this.root.push(new ParagraphProperties({})); } } diff --git a/src/file/styles/style/character-style.spec.ts b/src/file/styles/style/character-style.spec.ts index 793ead4ff2..c7594f3829 100644 --- a/src/file/styles/style/character-style.spec.ts +++ b/src/file/styles/style/character-style.spec.ts @@ -307,5 +307,51 @@ describe("CharacterStyle", () => { ], }); }); + + it("#highlight", () => { + const style = new CharacterStyle("myStyleId").highlight("005599"); + const tree = new Formatter().format(style); + expect(tree).to.deep.equal({ + "w:style": [ + { _attr: { "w:type": "character", "w:styleId": "myStyleId" } }, + { + "w:rPr": [{ "w:highlight": { _attr: { "w:val": "005599" } } }], + }, + { + "w:uiPriority": { + _attr: { + "w:val": "99", + }, + }, + }, + { + "w:unhideWhenUsed": EMPTY_OBJECT, + }, + ], + }); + }); + + it("#shadow", () => { + const style = new CharacterStyle("myStyleId").shadow("pct10", "00FFFF", "FF0000"); + const tree = new Formatter().format(style); + expect(tree).to.deep.equal({ + "w:style": [ + { _attr: { "w:type": "character", "w:styleId": "myStyleId" } }, + { + "w:rPr": [{ "w:shd": { _attr: { "w:val": "pct10", "w:fill": "00FFFF", "w:color": "FF0000" } } }], + }, + { + "w:uiPriority": { + _attr: { + "w:val": "99", + }, + }, + }, + { + "w:unhideWhenUsed": EMPTY_OBJECT, + }, + ], + }); + }); }); }); diff --git a/src/file/styles/style/character-style.ts b/src/file/styles/style/character-style.ts index c7f677b331..c60cca9394 100644 --- a/src/file/styles/style/character-style.ts +++ b/src/file/styles/style/character-style.ts @@ -58,4 +58,12 @@ export class CharacterStyle extends Style { this.root.push(new SemiHidden()); return this; } + + public highlight(color: string): CharacterStyle { + return this.addRunProperty(new formatting.Highlight(color)); + } + + public shadow(value: string, fill: string, color: string): CharacterStyle { + return this.addRunProperty(new formatting.Shading(value, fill, color)); + } } diff --git a/src/file/styles/style/paragraph-style.spec.ts b/src/file/styles/style/paragraph-style.spec.ts index 41ef0fddab..91f109e11e 100644 --- a/src/file/styles/style/paragraph-style.spec.ts +++ b/src/file/styles/style/paragraph-style.spec.ts @@ -166,9 +166,9 @@ describe("ParagraphStyle", () => { "w:bottom": { _attr: { "w:color": "auto", - "w:space": "1", + "w:space": 1, "w:val": "single", - "w:sz": "6", + "w:sz": 6, }, }, }, @@ -231,12 +231,12 @@ describe("ParagraphStyle", () => { }); it("#outlineLevel", () => { - const style = new ParagraphStyle("myStyleId").outlineLevel("1"); + const style = new ParagraphStyle("myStyleId").outlineLevel(1); const tree = new Formatter().format(style); expect(tree).to.deep.equal({ "w:style": [ { _attr: { "w:type": "paragraph", "w:styleId": "myStyleId" } }, - { "w:pPr": [{ "w:outlineLvl": { _attr: { "w:val": "1" } } }] }, + { "w:pPr": [{ "w:outlineLvl": { _attr: { "w:val": 1 } } }] }, ], }); }); @@ -375,6 +375,32 @@ describe("ParagraphStyle", () => { }); }); + it("#highlight", () => { + const style = new ParagraphStyle("myStyleId").highlight("005599"); + const tree = new Formatter().format(style); + expect(tree).to.deep.equal({ + "w:style": [ + { _attr: { "w:type": "paragraph", "w:styleId": "myStyleId" } }, + { + "w:rPr": [{ "w:highlight": { _attr: { "w:val": "005599" } } }], + }, + ], + }); + }); + + it("#shadow", () => { + const style = new ParagraphStyle("myStyleId").shadow("pct10", "00FFFF", "FF0000"); + const tree = new Formatter().format(style); + expect(tree).to.deep.equal({ + "w:style": [ + { _attr: { "w:type": "paragraph", "w:styleId": "myStyleId" } }, + { + "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 style = new ParagraphStyle("myStyleId").underline(); diff --git a/src/file/styles/style/paragraph-style.ts b/src/file/styles/style/paragraph-style.ts index d231c58f33..e79c6abe17 100644 --- a/src/file/styles/style/paragraph-style.ts +++ b/src/file/styles/style/paragraph-style.ts @@ -1,6 +1,6 @@ import { Alignment, - AlignmentOptions, + AlignmentType, Indent, ISpacingProperties, KeepLines, @@ -24,7 +24,7 @@ export class ParagraphStyle extends Style { constructor(styleId: string, name?: string) { super({ type: "paragraph", styleId: styleId }, name); - this.paragraphProperties = new ParagraphProperties(); + this.paragraphProperties = new ParagraphProperties({}); this.runProperties = new RunProperties(); this.root.push(this.paragraphProperties); this.root.push(this.runProperties); @@ -35,7 +35,7 @@ export class ParagraphStyle extends Style { return this; } - public outlineLevel(level: string): ParagraphStyle { + public outlineLevel(level: number): ParagraphStyle { this.paragraphProperties.push(new OutlineLevel(level)); return this; } @@ -114,22 +114,30 @@ export class ParagraphStyle extends Style { return this.addRunProperty(new formatting.CharacterSpacing(value)); } + public highlight(color: string): ParagraphStyle { + return this.addRunProperty(new formatting.Highlight(color)); + } + + public shadow(value: string, fill: string, color: string): ParagraphStyle { + return this.addRunProperty(new formatting.Shading(value, fill, color)); + } + // --------------------- Paragraph formatting ------------------------ // public center(): ParagraphStyle { - return this.addParagraphProperty(new Alignment(AlignmentOptions.CENTER)); + return this.addParagraphProperty(new Alignment(AlignmentType.CENTER)); } public left(): ParagraphStyle { - return this.addParagraphProperty(new Alignment(AlignmentOptions.LEFT)); + return this.addParagraphProperty(new Alignment(AlignmentType.LEFT)); } public right(): ParagraphStyle { - return this.addParagraphProperty(new Alignment(AlignmentOptions.RIGHT)); + return this.addParagraphProperty(new Alignment(AlignmentType.RIGHT)); } public justified(): ParagraphStyle { - return this.addParagraphProperty(new Alignment(AlignmentOptions.BOTH)); + return this.addParagraphProperty(new Alignment(AlignmentType.BOTH)); } public thematicBreak(): ParagraphStyle { diff --git a/src/file/table-of-contents/table-of-contents.ts b/src/file/table-of-contents/table-of-contents.ts index 7b1ff0f66d..57acbb3ace 100644 --- a/src/file/table-of-contents/table-of-contents.ts +++ b/src/file/table-of-contents/table-of-contents.ts @@ -16,16 +16,16 @@ export class TableOfContents extends XmlComponent { const content = new StructuredDocumentTagContent(); - const beginParagraph = new Paragraph(); - const beginRun = new Run(); + const beginParagraph = new Paragraph({}); + const beginRun = new Run({}); beginRun.addChildElement(new Begin(true)); beginRun.addChildElement(new FieldInstruction(properties)); beginRun.addChildElement(new Separate()); beginParagraph.addRun(beginRun); content.addChildElement(beginParagraph); - const endParagraph = new Paragraph(); - const endRun = new Run(); + const endParagraph = new Paragraph({}); + const endRun = new Run({}); endRun.addChildElement(new End()); endParagraph.addRun(endRun); content.addChildElement(endParagraph); diff --git a/src/file/table/table-cell/table-cell.ts b/src/file/table/table-cell/table-cell.ts index a3c8b427e1..1c546ab934 100644 --- a/src/file/table/table-cell/table-cell.ts +++ b/src/file/table/table-cell/table-cell.ts @@ -8,6 +8,10 @@ import { ITableCellMarginOptions } from "./cell-margin/table-cell-margins"; import { TableCellBorders, VerticalAlign, VMergeType } from "./table-cell-components"; import { TableCellProperties } from "./table-cell-properties"; +export interface ITableCellOptions { + readonly shading?: ITableShadingAttributesProperties; +} + export class TableCell extends XmlComponent { private readonly properties: TableCellProperties; @@ -18,31 +22,21 @@ export class TableCell extends XmlComponent { this.root.push(this.properties); } - public addParagraph(content: Paragraph): TableCell { - this.root.push(content); - return this; - } + public add(item: Paragraph | Table): TableCell { + this.root.push(item); - public addTable(content: Table): TableCell { - this.root.push(content); return this; } public prepForXml(): IXmlableObject | undefined { // Cells must end with a paragraph if (!(this.root[this.root.length - 1] instanceof Paragraph)) { - this.createParagraph(); + const para = new Paragraph({}); + this.add(para); } return super.prepForXml(); } - public createParagraph(text?: string): Paragraph { - const para = new Paragraph(text); - this.addParagraph(para); - - return para; - } - public setVerticalAlign(type: VerticalAlign): TableCell { this.properties.setVerticalAlign(type); diff --git a/src/file/table/table-properties/index.ts b/src/file/table/table-properties/index.ts index 913c3a7839..dde973ee7a 100644 --- a/src/file/table/table-properties/index.ts +++ b/src/file/table/table-properties/index.ts @@ -1,2 +1,3 @@ export * from "./table-properties"; export * from "./table-float-properties"; +export * from "./table-layout"; diff --git a/src/file/table/table-properties/table-properties.spec.ts b/src/file/table/table-properties/table-properties.spec.ts index c5bc54d2b9..dbd1c6b371 100644 --- a/src/file/table/table-properties/table-properties.spec.ts +++ b/src/file/table/table-properties/table-properties.spec.ts @@ -3,6 +3,7 @@ import { expect } from "chai"; import { Formatter } from "export/formatter"; import { WidthType } from "../table-cell"; +import { TableLayoutType } from "./table-layout"; import { TableProperties } from "./table-properties"; describe("TableProperties", () => { @@ -35,9 +36,10 @@ describe("TableProperties", () => { }); }); - describe("#setFixedWidthLayout", () => { + describe("#setLayout", () => { it("sets the table to fixed width layout", () => { - const tp = new TableProperties().setFixedWidthLayout(); + const tp = new TableProperties(); + tp.setLayout(TableLayoutType.FIXED); const tree = new Formatter().format(tp); expect(tree).to.deep.equal({ "w:tblPr": [{ "w:tblLayout": { _attr: { "w:type": "fixed" } } }], diff --git a/src/file/table/table-properties/table-properties.ts b/src/file/table/table-properties/table-properties.ts index 4067b2b3dc..fd1f844978 100644 --- a/src/file/table/table-properties/table-properties.ts +++ b/src/file/table/table-properties/table-properties.ts @@ -23,9 +23,8 @@ export class TableProperties extends IgnoreIfEmptyXmlComponent { return this; } - public setFixedWidthLayout(): TableProperties { - this.root.push(new TableLayout(TableLayoutType.FIXED)); - return this; + public setLayout(type: TableLayoutType): void { + this.root.push(new TableLayout(type)); } public setBorder(): TableProperties { diff --git a/src/file/table/table.spec.ts b/src/file/table/table.spec.ts index 0407b85718..7c93c5fc8e 100644 --- a/src/file/table/table.spec.ts +++ b/src/file/table/table.spec.ts @@ -9,6 +9,7 @@ import { Table } from "./table"; import { RelativeHorizontalPosition, RelativeVerticalPosition, TableAnchorType } from "./table-properties"; import { EMPTY_OBJECT } from "file/xml-components"; +import { TableLayoutType } from "./table-properties/table-layout"; const DEFAULT_TABLE_PROPERTIES = { "w:tblCellMar": [ @@ -134,6 +135,22 @@ describe("Table", () => { ], }); }); + + it("sets the table to fixed width layout", () => { + const table = new Table({ + rows: 1, + columns: 1, + layout: TableLayoutType.FIXED, + }); + const tree = new Formatter().format(table); + expect(tree) + .to.have.property("w:tbl") + .which.is.an("array") + .with.has.length.at.least(1); + expect(tree["w:tbl"][0]).to.deep.equal({ + "w:tblPr": [DEFAULT_TABLE_PROPERTIES, BORDERS, WIDTHS, { "w:tblLayout": { _attr: { "w:type": "fixed" } } }], + }); + }); }); describe("#getRow and Row#getCell", () => { @@ -146,19 +163,19 @@ describe("Table", () => { table .getRow(0) .getCell(0) - .addParagraph(new Paragraph("A1")); + .add(new Paragraph("A1")); table .getRow(0) .getCell(1) - .addParagraph(new Paragraph("B1")); + .add(new Paragraph("B1")); table .getRow(1) .getCell(0) - .addParagraph(new Paragraph("A2")); + .add(new Paragraph("A2")); table .getRow(1) .getCell(1) - .addParagraph(new Paragraph("B2")); + .add(new Paragraph("B2")); const tree = new Formatter().format(table); const cell = (c) => ({ "w:tc": [ @@ -204,10 +221,10 @@ describe("Table", () => { rows: 2, columns: 2, }); - table.getCell(0, 0).addParagraph(new Paragraph("A1")); - table.getCell(0, 1).addParagraph(new Paragraph("B1")); - table.getCell(1, 0).addParagraph(new Paragraph("A2")); - table.getCell(1, 1).addParagraph(new Paragraph("B2")); + table.getCell(0, 0).add(new Paragraph("A1")); + table.getCell(0, 1).add(new Paragraph("B1")); + table.getCell(1, 0).add(new Paragraph("A2")); + table.getCell(1, 1).add(new Paragraph("B2")); const tree = new Formatter().format(table); const cell = (c) => ({ "w:tc": [ @@ -252,23 +269,6 @@ describe("Table", () => { // }); // }); - describe("#setFixedWidthLayout", () => { - it("sets the table to fixed width layout", () => { - const table = new Table({ - rows: 1, - columns: 1, - }).setFixedWidthLayout(); - const tree = new Formatter().format(table); - expect(tree) - .to.have.property("w:tbl") - .which.is.an("array") - .with.has.length.at.least(1); - expect(tree["w:tbl"][0]).to.deep.equal({ - "w:tblPr": [DEFAULT_TABLE_PROPERTIES, BORDERS, WIDTHS, { "w:tblLayout": { _attr: { "w:type": "fixed" } } }], - }); - }); - }); - describe("Cell", () => { describe("#prepForXml", () => { it("inserts a paragraph at the end of the cell if it is empty", () => { @@ -295,7 +295,7 @@ describe("Table", () => { rows: 1, columns: 1, }); - parentTable.getCell(0, 0).addTable( + parentTable.getCell(0, 0).add( new Table({ rows: 1, columns: 1, @@ -322,7 +322,7 @@ describe("Table", () => { rows: 1, columns: 1, }); - parentTable.getCell(0, 0).addParagraph(new Paragraph("Hello")); + parentTable.getCell(0, 0).add(new Paragraph("Hello")); const tree = new Formatter().format(parentTable); expect(tree) .to.have.property("w:tbl") @@ -341,37 +341,6 @@ describe("Table", () => { }); }); }); - - describe("#createParagraph", () => { - it("inserts a new paragraph in the cell", () => { - const table = new Table({ - rows: 1, - columns: 1, - }); - const para = table.getCell(0, 0).createParagraph("Test paragraph"); - expect(para).to.be.an.instanceof(Paragraph); - const tree = new Formatter().format(table); - expect(tree) - .to.have.property("w:tbl") - .which.is.an("array"); - const row = tree["w:tbl"].find((x) => x["w:tr"]); - expect(row).not.to.be.undefined; - expect(row["w:tr"]) - .to.be.an("array") - .which.has.length.at.least(1); - expect(row["w:tr"].find((x) => x["w:tc"])).to.deep.equal({ - "w:tc": [ - { - "w:p": [ - { - "w:r": [{ "w:t": [{ _attr: { "xml:space": "preserve" } }, "Test paragraph"] }], - }, - ], - }, - ], - }); - }); - }); }); describe("#float", () => { diff --git a/src/file/table/table.ts b/src/file/table/table.ts index 9a99ce0408..c56bc4d62c 100644 --- a/src/file/table/table.ts +++ b/src/file/table/table.ts @@ -5,6 +5,7 @@ import { TableGrid } from "./grid"; import { TableCell, WidthType } from "./table-cell"; import { TableColumn } from "./table-column"; import { ITableFloatOptions, TableProperties } from "./table-properties"; +import { TableLayoutType } from "./table-properties/table-layout"; import { TableRow } from "./table-row"; /* 0-width columns don't get rendered correctly, so we need @@ -30,6 +31,7 @@ export interface ITableOptions { readonly left?: number; }; readonly float?: ITableFloatOptions; + readonly layout?: TableLayoutType; } export class Table extends XmlComponent { @@ -44,6 +46,7 @@ export class Table extends XmlComponent { columnWidths = Array(columns).fill(100), margins: { marginUnitType, top, bottom, right, left } = { marginUnitType: WidthType.AUTO, top: 0, bottom: 0, right: 0, left: 0 }, float, + layout, }: ITableOptions) { super("w:tbl"); this.properties = new TableProperties(); @@ -73,6 +76,10 @@ export class Table extends XmlComponent { if (float) { this.properties.setTableFloatProperties(float); } + + if (layout) { + this.properties.setLayout(layout); + } } public getRow(index: number): TableRow { @@ -94,9 +101,4 @@ export class Table extends XmlComponent { public getCell(row: number, col: number): TableCell { return this.getRow(row).getCell(col); } - - public setFixedWidthLayout(): Table { - this.properties.setFixedWidthLayout(); - return this; - } } diff --git a/src/file/xml-components/attributes.ts b/src/file/xml-components/attributes.ts index 02ed46b434..703ee1a679 100644 --- a/src/file/xml-components/attributes.ts +++ b/src/file/xml-components/attributes.ts @@ -3,6 +3,7 @@ import { XmlAttributeComponent } from "./default-attributes"; export interface IAttributesProperties { readonly val?: string | number | boolean; readonly color?: string; + readonly fill?: string; readonly space?: string; readonly sz?: string; readonly type?: string; @@ -26,6 +27,7 @@ export class Attributes extends XmlAttributeComponent { protected readonly xmlKeys = { val: "w:val", color: "w:color", + fill: "w:fill", space: "w:space", sz: "w:sz", type: "w:type",