JavaScript API: addList

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

addList

PREMIUM

TRIAL / ADVANCED

Adds list.

Note

You are reading the JavaScript API documentation. For the PHP API method please go to addList.

Description

addList (items: ListNested[], options: OptionsList = {}): this

type ListNested = string | WordFragment | ListNested[];

interface OptionsList extends OptionsParagraph {
    /** Custom numId */
    numId?: number;
    /** Paragraph style. Default as ListParagraph */
    pStyle?: string;
    /** List type: bullets (default), numbering, clear or custom list style */
    type?: "bullets" | "numbering" | string;
}

interface OptionsParagraph extends OptionsRpr {
    /** Alignment */
    align?: string;
    /** Background color: HEX value */
    backgroundColor?: string;
    /** Bidi */
    bidi?: boolean;
    /** Contextual spacing. Don't added space between paragraphs of the same style */
    contextualSpacing?: boolean;
    /** Indentations: twips value */
    indentation?: {
        firstLine?: number;
        hanging?: number;
        left?: number;
        right?: number;
    };
    /** Keep lines together */
    keepLines?: boolean;
    /** Keep with next */
    keepNext?: boolean;
    /** Spacing: twips value */
    spacing?: {
        line?: number;
        after?: number;
        before?: number;
    };
    /** Outline level (heading level): 1, 2, 3... */
    outlineLvl?: number;
    /** Paragraph style */
    pStyle?: string;
    /** Parse line breaks. Default as true */
    parseLineBreaks?: boolean;
    /** Parse tabs. Default as true */
    parseTabs?: boolean;
    /** Parse break before */
    pageBreakBefore?: boolean;
    /** RTL */
    rtl?: boolean;
    /** Shading color: HEX value */
    shading?: string;
    /** Text direction */
    textDirection?: "lrTb" | "tbRl" | "btLr" | "lrTbV" | "tbRlV" | "tbLrV";
    /** Widow control */
    widowControl?: boolean;
    /** Word wrap */
    wordWrap?: boolean;
}

interface OptionsRpr {
    /** Bold */
    bold?: boolean;
    /** Capital letters */
    caps?: boolean;
    /** Character spacing: twips value */
    characterSpacing?: number;
    /** Color: HEX value */
    color?: string;
    /** Em */
    em?: "circle" | "comma" | "dot" | "none" | "underDot";
    /** Emboss */
    emboss?: boolean;
    /** Font family */
    font?: string;
    /** Font size: point values */
    fontSize?: number;
    /** Highligh color */
    highlight?:
        | "black"
        | "blue"
        | "cyan"
        | "green"
        | "magenta"
        | "red"
        | "yellow"
        | "white"
        | "darkBlue"
        | "darkCyan"
        | "darkGreen"
        | "darkMagenta"
        | "darkRed"
        | "darkYellow"
        | "darkGray"
        | "lightGray"
        | "none";
    /** Italic */
    italic?: boolean;
    /** Language */
    lang?: string;
    /** Do not check spelling or grammar */
    noProof?: boolean;
    /** Vertically raised or lowered text: half-points value */
    position?: number;
    /** Character style */
    rStyle?: string;
    /** Shadow */
    shadow?: boolean;
    /** Small caps */
    smallCaps?: boolean;
    /** Strikethrough */
    strikethrough?: boolean;
    /** Underline */
    underline?:
        | "single"
        | "words"
        | "double"
        | "thic"
        | "dotted"
        | "dottedHeavy"
        | "dash"
        | "dashedHeavy"
        | "dashLong"
        | "dashLongHeavy"
        | "dotDash"
        | "dashDotHeavy"
        | "dotDotDash"
        | "dashDotDotHeavy"
        | "wave"
        | "wavyHeavy"
        | "wavyDouble"
        | "none";
    /** Underline color: HEX value */
    underlineColor?: string;
    /** Hidden text */
    vanish?: boolean;
    /** Vertical position */
    verticalAlign?: "baseline" | "superscript" | "subscript";
}

Code samples

Example #1

import { CreateDocx, ListNested, OptionsList } from "build";
import * as fs from "fs";

const docx = new CreateDocx();

docx.addText("Bullets list:");

const items: ListNested = [
    "Item 1",
    "Item 2",
    ["Item A", "Item B", "Item C", ["Item C.1", "Item C.2"]],
    "Item 3",
    "Item 4",
    "Item 5",
];
const optionsListBullets: OptionsList = {
    type: "bullets",
};
docx.addList(items, optionsListBullets);

docx.addText("Numbering list:");

const optionsListNumerical: OptionsList = {
    type: "numbering",
};
docx.addList(items, optionsListNumerical);
docx.addList(items, optionsListNumerical);

docx.save().then(contents => {
    fs.writeFileSync("addList_1.docx", Buffer.from(contents));
});

The resulting Word document looks like:

Example #2

import {
    CreateDocx,
    ListNested,
    OptionsLink,
    OptionsList,
    OptionsText,
    WordFragment,
} from "build";
import * as fs from "fs";

const docx = new CreateDocx();

docx.addText("Bullets list:");

// create a link WordFragment
const wordFragmentLink = new WordFragment();
const optionsLink: OptionsLink = {
    link: "https://www.phpdocx.com",
    text: "phpdocx",
};
wordFragmentLink.addLink(optionsLink);

// create a text WordFragment
const wordFragmentText = new WordFragment();
const textA: OptionsText = {
    bold: false,
    italic: true,
    fontSize: 14,
    text: "A content with styles ",
};
const textB: OptionsText = {
    color: "0000FF",
    font: "Times New Roman",
    text: "in the same list item.",
};
wordFragmentText.addText([textA, textB]);

const items: ListNested = [
    "Item 1",
    wordFragmentLink,
    ["Item A", "Item B", "Item C", ["Item C.1", "Item C.2"]],
    wordFragmentText,
    "Item 4",
    ["Item 4.1", "Item 4.2"],
    "Item 5",
];
const optionsListBullets: OptionsList = {
    type: "bullets",
};
docx.addList(items, optionsListBullets);

docx.save().then(contents => {
    fs.writeFileSync("addList_2.docx", Buffer.from(contents));
});

The resulting Word document looks like:

Release notes

phpdocx 15.0:
- new method.