docx/src/file/paragraph/formatting/tab-stop.ts

Generate .docx documents with JavaScript (formerly Office-Clippy)

// http://officeopenxml.com/WPtab.php
import { XmlAttributeComponent, XmlComponent } from "file/xml-components";

export class TabStop extends XmlComponent {
    constructor(tab: Tab) {
        super("w:tabs");
        this.root.push(tab);
    }
}

export type TabValue = "left" | "right" | "center" | "bar" | "clear" | "decimal" | "end" | "num" | "start";

export class TabAttributes extends XmlAttributeComponent<{ val: TabValue; pos: string | number }> {
    protected xmlKeys = { val: "w:val", pos: "w:pos" };
}

export class Tab extends XmlComponent {
    constructor(value: TabValue, position: string | number) {
        super("w:tab");
        this.root.push(
            new TabAttributes({
                val: value,
                pos: position,
            }),
        );
    }
}

export class MaxRightTabStop extends TabStop {
    constructor() {
        super(new Tab("right", 9026));
    }
}

export class LeftTabStop extends TabStop {
    constructor(position: number) {
        super(new Tab("left", position));
    }
}

export class RightTabStop extends TabStop {
    constructor(position: number) {
        super(new Tab("right", position));
    }
}

export class CenterTabStop extends TabStop {
    constructor(position: number) {
        super(new Tab("center", position));
    }
}