smartyellow/docx-js
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added border specs, createBorder method, and color attribute to setProperties

Browse Source
This commit is contained in:
Noah Schechter
2018-08-19 19:37:36 -04:00
parent 0411153832
commit e97c432a64
5 changed files with 69 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
demo/demo26.js
View File

@ -10,14 +10,11 @@ let paragraph = new docx.Paragraph("No border!");
doc.addParagraph(paragraph);
let borderParagraph = new docx.Paragraph("I have a border on all but one side!");
console.log(borderParagraph.Borders);
let borderParagraph = new docx.Paragraph("I have borders on my top and bottom sides!").createBorder();
borderParagraph.Borders.addTopBorder();
borderParagraph.Borders.addBottomBorder();
borderParagraph.Borders.addLeftBorder();
console.log(borderParagraph.Borders);
doc.addParagraph(borderParagraph);
let exporter = new docx.LocalPacker(doc);
exporter.packPdf('My Document');
exporter.pack('My Document');

22
src/file/paragraph/formatting/border.ts
View File

@ -2,11 +2,12 @@
import { Attributes, XmlComponent } from "file/xml-components";
class BorderProperty extends XmlComponent {
public setProperties(space: string, value: string, size: string): XmlComponent {
public setProperties(color: string, space: string, value: string, size: string): XmlComponent {
const attrs = new Attributes({
color: color,
space: space,
val: value,
sz: size
sz: size,
});
this.root.push(attrs);
@ -19,33 +20,33 @@ export class Border extends XmlComponent {
super("w:pBdr");
}
public addTopBorder(space: string = "1", value: string = "single", size: string = "6"): XmlComponent {
public addTopBorder(color: string = "auto", space: string = "1", value: string = "single", size: string = "6"): XmlComponent {
const top = new BorderProperty("w:top");
top.setProperties(space, value, size);
top.setProperties(color, space, value, size);
this.root.push(top);
return this;
}
public addBottomBorder(space: string = "1", value: string = "single", size: string = "6"): XmlComponent {
public addBottomBorder(color: string = "auto", space: string = "1", value: string = "single", size: string = "6"): XmlComponent {
const bottom = new BorderProperty("w:bottom");
bottom.setProperties(space, value, size);
bottom.setProperties(color, space, value, size);
this.root.push(bottom);
return this;
}
public addLeftBorder(space: string = "1", value: string = "single", size: string = "6"): XmlComponent {
public addLeftBorder(color: string = "auto", space: string = "1", value: string = "single", size: string = "6"): XmlComponent {
const left = new BorderProperty("w:left");
left.setProperties(space, value, size);
left.setProperties(color, space, value, size);
this.root.push(left);
return this;
}
public addRightBorder(space: string = "1", value: string = "single", size: string = "6"): XmlComponent {
public addRightBorder(color: string = "auto", space: string = "1", value: string = "single", size: string = "6"): XmlComponent {
const right = new BorderProperty("w:right");
right.setProperties(space, value, size);
right.setProperties(color, space, value, size);
this.root.push(right);
return this;
@ -56,6 +57,7 @@ export class ThematicBreak extends XmlComponent {
constructor() {
super("w:pBdr");
const bottom = new BorderProperty("w:bottom");
bottom.setProperties("auto", "1", "single", "6");
this.root.push(bottom);
}
}

45
src/file/paragraph/paragraph.spec.ts
View File

@ -144,6 +144,51 @@ describe("Paragraph", () => {
});
});
describe("#paragraphBorders()", () => {
it("should add a left and right border to a paragraph", () => {
paragraph.createBorder();
paragraph.Borders.addLeftBorder();
paragraph.Borders.addRightBorder();
const tree = new Formatter().format(paragraph);
expect(tree).to.deep.equal({
"w:p": [
{
"w:pPr": [
{
"w:pBdr": [
{
"w:left": [
{
_attr: {
"w:color": "auto",
"w:space": "1",
"w:sz": "6",
"w:val": "single",
},
},
],
},
{
"w:right": [
{
_attr: {
"w:color": "auto",
"w:space": "1",
"w:sz": "6",
"w:val": "single",
},
},
],
},
],
},
],
},
],
});
});
});
describe("#pageBreak()", () => {
it("should add page break to JSON", () => {
paragraph.pageBreak();

7
src/file/paragraph/paragraph.ts
View File

@ -6,7 +6,7 @@ import { XmlComponent } from "file/xml-components";
import { Alignment } from "./formatting/alignment";
import { Bidirectional } from "./formatting/bidirectional";
import { ThematicBreak, Border } from "./formatting/border";
import { Border, ThematicBreak } from "./formatting/border";
import { Indent } from "./formatting/indent";
import { KeepLines, KeepNext } from "./formatting/keep";
import { PageBreak, PageBreakBefore } from "./formatting/page-break";
@ -34,6 +34,11 @@ export class Paragraph extends XmlComponent {
return this.properties.paragraphBorder;
}
public createBorder(): Paragraph {
this.properties.createBorder();
return this;
}
public addRun(run: Run): Paragraph {
this.root.push(run);
return this;

3
src/file/paragraph/properties.ts
View File

@ -8,6 +8,9 @@ export class ParagraphProperties extends XmlComponent {
constructor() {
super("w:pPr");
this.paragraphBorder = new Border();
}
public createBorder(): void {
this.push(this.paragraphBorder);
}