All files / roosterjs-content-model-dom/lib/modelToDom/handlers handleList.ts

100% Statements 51/51
100% Branches 47/47
100% Functions 1/1
100% Lines 49/49

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 1361x 1x 1x 1x                   1x             299x 299x   299x 94x             299x 304x 304x 304x   304x   304x               57x 247x   129x     247x           1x         299x   14x 2x   2x       299x     299x 206x 206x   206x 206x 206x   206x   206x 7x   7x           7x               199x 199x   199x 199x               199x 2x       206x     206x     206x 206x   206x 199x       299x    
import { applyFormat } from '../utils/applyFormat';
import { applyMetadata } from '../utils/applyMetadata';
import { cleanUpRestNodes } from '../utils/cleanUpRestNodes';
import { reuseCachedElement } from '../../domUtils/reuseCachedElement';
import type {
    ContentModelBlockHandler,
    ContentModelListItem,
    ModelToDomContext,
} from 'roosterjs-content-model-types';
 
/**
 * @internal
 */
export const handleList: ContentModelBlockHandler<ContentModelListItem> = (
    doc: Document,
    parent: Node,
    listItem: ContentModelListItem,
    context: ModelToDomContext,
    refNode: Node | null
) => {
    let layer = 0;
    const { nodeStack } = context.listFormat;
 
    if (nodeStack.length == 0) {
        nodeStack.push({
            node: parent,
            refNode,
        });
    }
 
    // Skip existing list levels that has same properties so we can reuse them
    for (; layer < listItem.levels.length && layer + 1 < nodeStack.length; layer++) {
        const parentLevel = nodeStack[layer];
        const stackLevel = nodeStack[layer + 1];
        const itemLevel = listItem.levels[layer];
 
        context.listFormat.currentLevel = layer;
 
        if (
            stackLevel.listType != itemLevel.listType ||
            stackLevel.dataset?.editingInfo != itemLevel.dataset.editingInfo ||
            (itemLevel.listType == 'OL' &&
                typeof itemLevel.format.startNumberOverride === 'number') ||
            (itemLevel.listType == 'UL' &&
                itemLevel.format.listStyleType != stackLevel.format?.listStyleType)
        ) {
            break;
        } else if (itemLevel.listType == 'UL') {
            // Apply metadata to list level to make sure list style is correct after rendering
            applyMetadata(itemLevel, context.metadataAppliers.listLevel, itemLevel.format, context);
        }
 
        if (
            context.allowCacheListItem &&
            parentLevel.refNode &&
            itemLevel.cachedElement == parentLevel.refNode
        ) {
            // Move refNode to next node since we are reusing this cached element
            parentLevel.refNode = parentLevel.refNode.nextSibling;
        }
    }
 
    // Cut off remained list levels that we can't reuse
    if (context.allowCacheListItem) {
        // Clean up all rest nodes in the reused list levels
        for (let i = layer + 1; i < nodeStack.length; i++) {
            const stackLevel = nodeStack[i];
 
            cleanUpRestNodes(stackLevel.refNode, context.rewriteFromModel);
        }
    }
 
    nodeStack.splice(layer + 1);
 
    // Create new list levels that are after reused ones
    for (; layer < listItem.levels.length; layer++) {
        const level = listItem.levels[layer];
        const lastParent = nodeStack[nodeStack.length - 1].node;
 
        let newList: HTMLOListElement | HTMLUListElement;
        let isNewlyCreated = false;
        const levelRefNode = nodeStack[layer].refNode ?? null;
 
        context.listFormat.currentLevel = layer;
 
        if (context.allowCacheListItem && level.cachedElement) {
            newList = level.cachedElement;
 
            nodeStack[layer].refNode = reuseCachedElement(
                lastParent,
                level.cachedElement,
                levelRefNode,
                context.rewriteFromModel
            );
            nodeStack.push({
                node: newList,
                refNode: newList.firstChild,
                listType: level.listType,
                format: { ...level.format },
                dataset: { ...level.dataset },
            });
        } else {
            newList = doc.createElement(level.listType == 'OL' ? 'ol' : 'ul');
            isNewlyCreated = true;
 
            lastParent.insertBefore(newList, levelRefNode);
            nodeStack.push({
                node: newList,
                refNode: null,
                listType: level.listType,
                format: { ...level.format },
                dataset: { ...level.dataset },
            });
 
            if (context.allowCacheListItem) {
                level.cachedElement = newList;
            }
        }
 
        applyFormat(newList, context.formatAppliers.listLevelThread, level.format, context);
 
        // Need to apply metadata after applying list level format since the list numbers value relies on the result of list thread handling
        applyMetadata(level, context.metadataAppliers.listLevel, level.format, context);
 
        // Need to apply listItemElement formats after applying metadata since the list numbers value relies on the result of metadata handling
        applyFormat(newList, context.formatAppliers.listLevel, level.format, context);
        applyFormat(newList, context.formatAppliers.dataset, level.dataset, context);
 
        if (isNewlyCreated) {
            context.onNodeCreated?.(level, newList);
        }
    }
 
    return nodeStack[0].refNode;
};