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

#1529 Add word break feature

Browse Source
This commit is contained in:
Dolan
2022-06-15 00:07:12 +01:00
parent bdbd15e7d9
commit f414b4ee9a
13 changed files with 87 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
demo/72-word-wrap.ts Normal file
View File

@ -0,0 +1,37 @@
// Example on how to preserve word wrap text. Works with all languages.
// Import from 'docx' rather than '../build' if you install from npm
import * as fs from "fs";
import { Document, Packer, Paragraph, TextRun, SpaceType } from "../build";
const doc = new Document({
sections: [
{
children: [
new Paragraph({
children: [
new TextRun("我今天遛狗去公园"),
new TextRun({
text: "456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345",
space: SpaceType.PRESERVE,
}),
],
}),
new Paragraph({
children: [
new TextRun(
"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua",
),
new TextRun({
text: "456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345",
space: SpaceType.PRESERVE,
}),
],
}),
],
},
],
});
Packer.toBuffer(doc).then((buffer) => {
fs.writeFileSync("My Document.docx", buffer);
});

1
src/file/index.ts
View File

@ -19,3 +19,4 @@ export * from "./shared";
export * from "./border";
export * from "./values";
export * from "./vertical-align";
export * from "./space-type";

8
src/file/paragraph/links/pageref-field-instruction.ts
View File

@ -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 = {}) {

6
src/file/paragraph/run/page-number.ts
View File

@ -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() {

6
src/file/paragraph/run/properties.ts
View File

@ -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 {

6
src/file/paragraph/run/run-components/text.ts
View File

@ -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) {

17
src/file/paragraph/run/run.spec.ts
View File

@ -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",
},
},
});
});
});
});

6
src/file/paragraph/run/run.ts
View File

@ -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") {

6
src/file/paragraph/run/sequential-identifier-instruction.ts
View File

@ -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) {

6
src/file/paragraph/run/text-attributes.ts Normal file
View File

@ -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" };
}

8
src/file/table-of-contents/field-instruction.ts
View File

@ -1,11 +1,9 @@
// http://officeopenxml.com/WPfieldInstructions.php
import { TextAttributes } from "file/paragraph/run/text-attributes";
import { SpaceType } from "file/space-type";
import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
import { ITableOfContentsOptions } from "./table-of-contents-properties";
import { XmlComponent } from "file/xml-components";
class TextAttributes extends XmlAttributeComponent<{ readonly space: SpaceType }> {
protected readonly xmlKeys = { space: "xml:space" };
}
import { ITableOfContentsOptions } from "./table-of-contents-properties";
export class FieldInstruction extends XmlComponent {
private readonly properties: ITableOfContentsOptions;

7
src/file/track-revision/track-revision-components/deleted-page-number.ts
View File

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

7
src/file/track-revision/track-revision-components/deleted-text.ts
View File

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