Merge pull request #119

Add ability to set Bullet Text content from array

Author: singerla

README.md

@@ -665,7 +665,30 @@ pres
   });
 ```
 
-# Tipps and Tricks
+## Add Bulleted List
+
+You can add a bulleted list to a shape.
+
+```ts
+// Remove existing charts, images or shapes from added slide.
+const bulletPoints = ['first line', 'second line', 'third line'];
+const indentedBulletPoints = ['first line', [ 'indent 1-1', 'indent 1-2', [ 'indent 2-1', 'indent 2-2', ] ], 'second line', 'third line'];
+
+  pres.addSlide('general', 2, (slide) => {
+      slide.modifyElement(
+              'replaceText', //shape selector
+              modify.setBulletList(bulletPoints),
+      );
+    })
+    .addSlide('general', 2, (slide) => {
+      slide.modifyElement(
+              'replaceText', //shape selector
+              modify.setBulletList(indentedBulletPoints),
+      );
+    });
+```
+
+# Tips and Tricks
 
 ## Loop through the slides of a presentation
 

__tests__/modify-bullet-text.test.ts

@@ -0,0 +1,41 @@
+import Automizer, { modify } from '../src/index';
+
+const bulletPoints = ['first line', 'second line', 'third line'];
+const multiLevelBullet = [
+  'top line 1',
+  [
+    'indent 1-1',
+    'indent 1-2',
+    [
+      'indent 2-1',
+      'indent 2-2',
+    ],
+  ],
+  'top line 2',
+];
+
+test('create presentation, replace bullet list text.', async () => {
+  const automizer = new Automizer({
+    templateDir: `${__dirname}/pptx-templates`,
+    outputDir: `${__dirname}/pptx-output`,
+  });
+
+  const pres = automizer.loadRoot(`RootTemplate.pptx`).load(`TextReplace.pptx`);
+
+  const result = await pres
+
+    .addSlide('TextReplace.pptx', 2, (slide) => {
+      slide.modifyElement(
+        'replaceTextBullet1',
+        modify.setBulletList(bulletPoints),
+      );
+    }).addSlide('TextReplace.pptx', 2, (slide) => {
+      slide.modifyElement(
+        'replaceTextBullet1',
+        modify.setBulletList(multiLevelBullet),
+      );
+    })
+    .write(`replace-bullet-text.test.pptx`);
+
+   expect(result.slides).toBe(3);
+});

src/helper/modify-shape-helper.ts

@@ -40,6 +40,15 @@ export default class ModifyShapeHelper {
       ModifyTextHelper.setText(text)(element as XmlElement);
     };
 
+  /**
+   * Set content to bulleted list of modified shape
+   */
+  static setBulletList =
+    (list) =>
+    (element: XmlElement): void => {
+      ModifyTextHelper.setBulletList(list)(element as XmlElement);
+    };
+
   /**
    * Replace tagged text content within modified shape
    */

src/helper/modify-text-helper.ts

@@ -3,6 +3,7 @@ import ModifyColorHelper from './modify-color-helper';
 import ModifyXmlHelper from './modify-xml-helper';
 import { XmlElement } from '../types/xml-types';
 import { vd } from './general-helper';
+import XmlElements from './xml-elements';
 
 export default class ModifyTextHelper {
   /**
@@ -33,6 +34,12 @@ export default class ModifyTextHelper {
       }
     };
 
+  static setBulletList =
+    (list) => (element: XmlElement): void => {
+      const xmlElements = new XmlElements(element);
+      xmlElements.addBulletList(list);
+    };
+
   static content =
     (label: number | string | undefined) =>
     (element: XmlElement): void => {
@@ -42,7 +49,7 @@ export default class ModifyTextHelper {
     };
 
   /**
-   * Set text style insinde an <a:rPr> element
+   * Set text style inside an <a:rPr> element
    */
   static style =
     (style: TextStyle) =>
@@ -72,7 +79,7 @@ export default class ModifyTextHelper {
     };
 
   /**
-   * Set size of text insinde an <a:rPr> element
+   * Set size of text inside an <a:rPr> element
    */
   static setSize =
     (size: number) =>

src/helper/xml-elements.ts

@@ -42,6 +42,66 @@ export default class XmlElements {
     return this;
   }
 
+  createTextBody(): XmlElement {
+    let txBody = this.element.getElementsByTagName('p:txBody')[0];
+    if (!txBody) {
+      txBody = this.document.createElement('p:txBody');
+      this.element.appendChild(txBody);
+    } else {
+      while (txBody.firstChild) {
+        txBody.removeChild(txBody.firstChild);
+      }
+    }
+    return txBody;
+  }
+
+  createBodyProperties(txBody: XmlElement): XmlElement {
+    const bodyPr = this.document.createElement('a:bodyPr');
+    txBody.appendChild(bodyPr);
+    return bodyPr;
+  }
+
+  addBulletList(list: []): void {
+    const txBody = this.createTextBody();
+    this.createBodyProperties(txBody);
+    this.processList(txBody, list, 0);
+  }
+
+  processList(txBody: XmlElement, items: [], level: number): void {
+    items.forEach((item) => {
+      if (Array.isArray(item)) {
+        this.processList(txBody, item, level + 1);
+      } else {
+        const p = this.createParagraph(level);
+        const r = this.createTextRun(String(item));
+        p.appendChild(r);
+        txBody.appendChild(p);
+      }
+    });
+  }
+
+  createParagraph(level: number): XmlElement {
+    const p = this.document.createElement('a:p');
+    const pPr = this.document.createElement('a:pPr');
+    if (level > 0) {
+      pPr.setAttribute('lvl', String(level));
+    }
+    p.appendChild(pPr);
+    return p;
+  }
+
+  createTextRun(text: string): XmlElement {
+    const r = this.document.createElement('a:r');
+    const rPr = this.document.createElement('a:rPr');
+    r.appendChild(rPr);
+
+    const t = this.document.createElement('a:t');
+    t.textContent = String(text);
+
+    r.appendChild(t);
+    return r;
+  }
+
   paragraphProps() {
     const p = this.element.getElementsByTagName('a:p').item(0);
     p.appendChild(this.document.createElement('a:pPr'));

src/index.ts

@@ -48,6 +48,7 @@ const setAttribute = ModifyHelper.setAttribute;
 
 const setSolidFill = ModifyShapeHelper.setSolidFill;
 const setText = ModifyShapeHelper.setText;
+const setBulletList = ModifyShapeHelper.setBulletList;
 const replaceText = ModifyShapeHelper.replaceText;
 const setPosition = ModifyShapeHelper.setPosition;
 const updatePosition = ModifyShapeHelper.updatePosition;
@@ -119,6 +120,7 @@ export const modify = {
   setAttribute,
   setSolidFill,
   setText,
+  setBulletList,
   replaceText,
   setPosition,
   updatePosition,