Add text frame documentation

2021-03-14 18:12:52 +00:00
parent e7eca14e1e
commit cc32a7b2d3
6 changed files with 90 additions and 6 deletions
--- a/demo/61-text-frame.ts
+++ b/demo/61-text-frame.ts
@ -0,0 +1,71 @@
+// Text Frame (Text Box) example
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, FrameAnchorType, HorizontalPositionAlign, Packer, Paragraph, TextRun, VerticalPositionAlign } from "../build";
+
+const doc = new Document();
+
+doc.addSection({
+    properties: {},
+    children: [
+        new Paragraph({
+            frame: {
+                position: {
+                    x: 1000,
+                    y: 3000,
+                },
+                width: 4000,
+                height: 1000,
+                anchor: {
+                    horizontal: FrameAnchorType.MARGIN,
+                    vertical: FrameAnchorType.MARGIN,
+                },
+                alignment: {
+                    x: HorizontalPositionAlign.CENTER,
+                    y: VerticalPositionAlign.TOP,
+                },
+            },
+            border: {
+                top: {
+                    color: "auto",
+                    space: 1,
+                    value: "single",
+                    size: 6,
+                },
+                bottom: {
+                    color: "auto",
+                    space: 1,
+                    value: "single",
+                    size: 6,
+                },
+                left: {
+                    color: "auto",
+                    space: 1,
+                    value: "single",
+                    size: 6,
+                },
+                right: {
+                    color: "auto",
+                    space: 1,
+                    value: "single",
+                    size: 6,
+                },
+            },
+            children: [
+                new TextRun("Hello World"),
+                new TextRun({
+                    text: "Foo Bar",
+                    bold: true,
+                }),
+                new TextRun({
+                    text: "\tGithub is the best",
+                    bold: true,
+                }),
+            ],
+        }),
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});