#1529 Add word break feature

src/file/paragraph/links/pageref-field-instruction.ts

@@ -1,10 +1,8 @@
 import { SpaceType } from "file/space-type";
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
-import { IPageReferenceOptions } from "./pageref-properties";
+import { XmlComponent } from "file/xml-components";
 
-class TextAttributes extends XmlAttributeComponent<{ readonly space: SpaceType }> {
-    protected readonly xmlKeys = { space: "xml:space" };
-}
+import { TextAttributes } from "../run/text-attributes";
+import { IPageReferenceOptions } from "./pageref-properties";
 
 export class PageReferenceFieldInstruction extends XmlComponent {
     constructor(bookmarkId: string, options: IPageReferenceOptions = {}) {

src/file/paragraph/run/page-number.ts

@@ -1,9 +1,7 @@
 import { SpaceType } from "file/space-type";
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+import { XmlComponent } from "file/xml-components";
 
-class TextAttributes extends XmlAttributeComponent<{ readonly space: SpaceType }> {
-    protected readonly xmlKeys = { space: "xml:space" };
-}
+import { TextAttributes } from "./text-attributes";
 
 export class Page extends XmlComponent {
     constructor() {

src/file/paragraph/run/properties.ts

@@ -1,8 +1,9 @@
-import { ChangeAttributes, IChangedAttributesProperties } from "../../track-revision/track-revision";
-
 import { BorderElement, IBorderOptions } from "file/border";
 import { IShadingAttributesProperties, Shading } from "file/shading";
+import { SpaceType } from "file/space-type";
+import { ChangeAttributes, IChangedAttributesProperties } from "file/track-revision/track-revision";
 import { HpsMeasureElement, IgnoreIfEmptyXmlComponent, OnOffElement, StringValueElement, XmlComponent } from "file/xml-components";
+
 import { EmphasisMark, EmphasisMarkType } from "./emphasis-mark";
 import { CharacterSpacing, Color, Highlight, HighlightComplexScript } from "./formatting";
 import { IFontAttributesProperties, RunFonts } from "./run-fonts";
@@ -45,6 +46,7 @@ export interface IRunStylePropertiesOptions {
     readonly imprint?: boolean;
     readonly revision?: IRunPropertiesChangeOptions;
     readonly border?: IBorderOptions;
+    readonly space?: SpaceType;
 }
 
 export interface IRunPropertiesOptions extends IRunStylePropertiesOptions {

src/file/paragraph/run/run-components/text.ts

@@ -1,9 +1,7 @@
 import { SpaceType } from "file/space-type";
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+import { XmlComponent } from "file/xml-components";
 
-class TextAttributes extends XmlAttributeComponent<{ readonly space: SpaceType }> {
-    protected readonly xmlKeys = { space: "xml:space" };
-}
+import { TextAttributes } from "../text-attributes";
 
 export class Text extends XmlComponent {
     constructor(text: string) {

src/file/paragraph/run/run.spec.ts

@@ -4,6 +4,7 @@ import { Formatter } from "export/formatter";
 import { BorderStyle } from "file/border";
 // import { FootnoteReferenceRun } from "file/footnotes/footnote/run/reference-run";
 import { ShadingType } from "file/shading";
+import { SpaceType } from "file/space-type";
 
 import { Run } from "./";
 import { EmphasisMarkType } from "./emphasis-mark";
@@ -521,4 +522,20 @@ describe("Run", () => {
             });
         });
     });
+
+    describe("#space", () => {
+        it("should correctly set the border", () => {
+            const run = new Run({
+                space: SpaceType.PRESERVE,
+            });
+            const tree = new Formatter().format(run);
+            expect(tree).to.deep.equal({
+                "w:r": {
+                    _attr: {
+                        "xml:space": "preserve",
+                    },
+                },
+            });
+        });
+    });
 });

src/file/paragraph/run/run.ts

@@ -3,11 +3,13 @@ import { XmlComponent } from "file/xml-components";
 
 import { FootnoteReferenceRun } from "file/footnotes/footnote/run/reference-run";
 import { FieldInstruction } from "file/table-of-contents/field-instruction";
+
 import { Break } from "./break";
 import { Begin, End, Separate } from "./field";
 import { NumberOfPages, NumberOfPagesSection, Page } from "./page-number";
 import { IRunPropertiesOptions, RunProperties } from "./properties";
 import { Text } from "./run-components/text";
+import { TextAttributes } from "./text-attributes";
 
 export interface IRunOptions extends IRunPropertiesOptions {
     readonly children?: (Begin | FieldInstruction | Separate | End | PageNumber | FootnoteReferenceRun | string)[];
@@ -35,6 +37,10 @@ export class Run extends XmlComponent {
             }
         }
 
+        if (options.space) {
+            this.root.push(new TextAttributes({ space: options.space }));
+        }
+
         if (options.children) {
             for (const child of options.children) {
                 if (typeof child === "string") {

src/file/paragraph/run/sequential-identifier-instruction.ts

@@ -1,10 +1,8 @@
 // http://officeopenxml.com/WPfieldInstructions.php
 import { SpaceType } from "file/space-type";
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+import { XmlComponent } from "file/xml-components";
 
-class TextAttributes extends XmlAttributeComponent<{ readonly space: SpaceType }> {
-    protected readonly xmlKeys = { space: "xml:space" };
-}
+import { TextAttributes } from "./text-attributes";
 
 export class SequentialIdentifierInstruction extends XmlComponent {
     constructor(identifier: string) {

src/file/paragraph/run/text-attributes.ts

@@ -0,0 +1,6 @@
+import { SpaceType } from "file/space-type";
+import { XmlAttributeComponent } from "file/xml-components";
+
+export class TextAttributes extends XmlAttributeComponent<{ readonly space: SpaceType }> {
+    protected readonly xmlKeys = { space: "xml:space" };
+}