All files / roosterjs-content-model-dom/lib/modelApi/editing applyTableFormat.ts

81.67% Statements 98/120
78.57% Branches 77/98
88.46% Functions 23/26
81.31% Lines 87/107

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 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 3361x 1x 1x 1x 1x 1x 1x               1x                                                     1x         42x 42x   42x 42x           42x   42x 42x 42x   42x               42x           42x 81x 81x 81x   81x 81x 81x   81x 212x 212x 2x 2x   210x   212x 212x   212x         42x                   1x 123x               12x 12x 12x 12x 12x           12x           12x           12x           12x           12x           12x                     210x   42x 81x 212x     212x       207x             207x             207x 828x   828x                 212x 211x 211x     211x               211x                 212x         212x                   1x         42x 42x                                                                               42x 22x     20x   20x 42x   42x 42x   42x 42x 42x               42x 42x 42x                     126x 126x 126x 126x       954x    
import { BorderKeys } from '../../formatHandlers/common/borderFormatHandler';
import { combineBorderValue, extractBorderValues } from '../../domUtils/style/borderValues';
import { mutateBlock } from '../common/mutate';
import { setTableCellBackgroundColor } from './setTableCellBackgroundColor';
import { TableBorderFormat } from '../../constants/TableBorderFormat';
import { updateTableCellMetadata } from '../metadata/updateTableCellMetadata';
import { updateTableMetadata } from '../metadata/updateTableMetadata';
import type {
    BorderFormat,
    ReadonlyContentModelTable,
    ShallowMutableContentModelTableRow,
    TableMetadataFormat,
} from 'roosterjs-content-model-types';
 
const DEFAULT_FORMAT: Required<TableMetadataFormat> = {
    topBorderColor: '#ABABAB',
    bottomBorderColor: '#ABABAB',
    verticalBorderColor: '#ABABAB',
    hasHeaderRow: false,
    hasFirstColumn: false,
    hasBandedRows: false,
    hasBandedColumns: false,
    bgColorEven: null,
    bgColorOdd: '#ABABAB20',
    headerRowColor: '#ABABAB',
    tableBorderFormat: TableBorderFormat.Default,
    verticalAlign: null,
};
 
type MetaOverrides = {
    bgColorOverrides: boolean[][];
    vAlignOverrides: boolean[][];
    borderOverrides: boolean[][];
};
 
/**
 * Apply table format from table metadata and the passed in new format
 * @param table The table to apply format to
 * @param newFormat @optional New format to apply. When passed, this value will be merged into existing metadata format and default format
 * @param keepCellShade @optional When pass true, table cells with customized shade color will not be overwritten. @default false
 */
export function applyTableFormat(
    table: ReadonlyContentModelTable,
    newFormat?: TableMetadataFormat,
    keepCellShade?: boolean
) {
    const mutableTable = mutateBlock(table);
    const { rows } = mutableTable;
 
    updateTableMetadata(mutableTable, format => {
        const effectiveMetadata = {
            ...DEFAULT_FORMAT,
            ...format,
            ...newFormat,
        };
 
        const metaOverrides: MetaOverrides = updateOverrides(rows, !keepCellShade);
 
        formatCells(rows, effectiveMetadata, metaOverrides);
        setFirstColumnFormatBorders(rows, effectiveMetadata);
        setHeaderRowFormat(rows, effectiveMetadata, metaOverrides);
 
        return effectiveMetadata;
    });
}
 
function updateOverrides(
    rows: ShallowMutableContentModelTableRow[],
    removeCellShade: boolean
): MetaOverrides {
    const overrides: MetaOverrides = {
        bgColorOverrides: [],
        vAlignOverrides: [],
        borderOverrides: [],
    };
 
    rows.forEach(row => {
        const bgColorOverrides: boolean[] = [];
        const vAlignOverrides: boolean[] = [];
        const borderOverrides: boolean[] = [];
 
        overrides.bgColorOverrides.push(bgColorOverrides);
        overrides.vAlignOverrides.push(vAlignOverrides);
        overrides.borderOverrides.push(borderOverrides);
 
        row.cells.forEach(cell => {
            updateTableCellMetadata(mutateBlock(cell), metadata => {
                if (metadata && removeCellShade) {
                    bgColorOverrides.push(false);
                    delete metadata.bgColorOverride;
                } else {
                    bgColorOverrides.push(!!metadata?.bgColorOverride);
                }
                vAlignOverrides.push(!!metadata?.vAlignOverride);
                borderOverrides.push(!!metadata?.borderOverride);
 
                return metadata;
            });
        });
    });
 
    return overrides;
}
 
type ShouldUseTransparentBorder = (indexProp: {
    firstRow: boolean;
    lastRow: boolean;
    firstColumn: boolean;
    lastColumn: boolean;
}) => [boolean, boolean, boolean, boolean];
 
const BorderFormatters: Record<number, ShouldUseTransparentBorder | undefined> = {
    [TableBorderFormat.Default]: _ => [false, false, false, false],
    [TableBorderFormat.ListWithSideBorders]: ({ lastColumn, firstColumn }) => [
        false,
        !lastColumn,
        false,
        !firstColumn,
    ],
    [TableBorderFormat.FirstColumnHeaderExternal]: ({
        firstColumn,
        firstRow,
        lastColumn,
        lastRow,
    }) => [
        !firstRow,
        (!lastColumn && !firstColumn) || (firstColumn && firstRow),
        !lastRow && !firstRow,
        !firstColumn,
    ],
    [TableBorderFormat.NoHeaderBorders]: ({ firstRow, firstColumn, lastColumn }) => [
        firstRow,
        firstRow || lastColumn,
        false,
        firstRow || firstColumn,
    ],
    [TableBorderFormat.NoSideBorders]: ({ firstColumn, lastColumn }) => [
        false,
        lastColumn,
        false,
        firstColumn,
    ],
    [TableBorderFormat.EspecialType1]: ({ firstRow, firstColumn }) => [
        firstColumn && !firstRow,
        firstRow,
        firstColumn && !firstRow,
        firstRow && !firstColumn,
    ],
    [TableBorderFormat.EspecialType2]: ({ firstRow, firstColumn }) => [
        !firstRow,
        firstRow || !firstColumn,
        !firstRow,
        !firstColumn,
    ],
    [TableBorderFormat.EspecialType3]: ({ firstColumn, firstRow }) => [
        true,
        firstRow || !firstColumn,
        !firstRow,
        true,
    ],
    [TableBorderFormat.Clear]: () => [true, true, true, true],
};
 
/*
 * Apply vertical align, borders, and background color to all cells in the table
 */
function formatCells(
    rows: ShallowMutableContentModelTableRow[],
    format: TableMetadataFormat,
    metaOverrides: MetaOverrides
) {
    const { hasBandedRows, hasBandedColumns, bgColorOdd, bgColorEven, hasFirstColumn } = format;
 
    rows.forEach((row, rowIndex) => {
        row.cells.forEach((readonlyCell, colIndex) => {
            const cell = mutateBlock(readonlyCell);
 
            // Format Borders
            if (
                !metaOverrides.borderOverrides[rowIndex][colIndex] &&
                typeof format.tableBorderFormat == 'number'
            ) {
                const transparentBorderMatrix = BorderFormatters[format.tableBorderFormat]?.({
                    firstRow: rowIndex === 0,
                    lastRow: rowIndex === rows.length - 1,
                    firstColumn: colIndex === 0,
                    lastColumn: colIndex === row.cells.length - 1,
                });
 
                const formatColor = [
                    format.topBorderColor,
                    format.verticalBorderColor,
                    format.bottomBorderColor,
                    format.verticalBorderColor,
                ];
 
                transparentBorderMatrix?.forEach((alwaysUseTransparent, i) => {
                    const borderColor = (!alwaysUseTransparent && formatColor[i]) || '';
 
                    cell.format[BorderKeys[i]] = combineBorderValue({
                        style: getBorderStyleFromColor(borderColor),
                        width: '1px',
                        color: borderColor,
                    });
                });
            }
 
            // Format Background Color
            if (!metaOverrides.bgColorOverrides[rowIndex][colIndex]) {
                let color: string | null | undefined;
                Iif (hasFirstColumn && colIndex == 0 && rowIndex > 0) {
                    color = null;
                } else {
                    color =
                        hasBandedRows || hasBandedColumns
                            ? (hasBandedColumns && colIndex % 2 != 0) ||
                              (hasBandedRows && rowIndex % 2 != 0)
                                ? bgColorOdd
                                : bgColorEven
                            : bgColorEven; /* bgColorEven is the default color */
                }
                setTableCellBackgroundColor(
                    cell,
                    color,
                    false /*isColorOverride*/,
                    true /*applyToSegments*/
                );
            }
 
            // Format Vertical Align
            Iif (format.verticalAlign && !metaOverrides.vAlignOverrides[rowIndex][colIndex]) {
                cell.format.verticalAlign = format.verticalAlign;
            }
 
            // Format Header
            cell.isHeader = false;
        });
    });
}
 
/**
 * Set the first column format borders for the table as well as header property
 * @param rows The rows of the table
 * @param format The table metadata format
 */
export function setFirstColumnFormatBorders(
    rows: ShallowMutableContentModelTableRow[],
    format: Partial<TableMetadataFormat>
) {
    // Exit early hasFirstColumn is not set
    Eif (!format.hasFirstColumn) {
        return;
    }
 
    rows.forEach((row, rowIndex) => {
        row.cells.forEach((readonlyCell, cellIndex) => {
            const cell = mutateBlock(readonlyCell);
 
            if (cellIndex === 0) {
                cell.isHeader = true;
 
                switch (rowIndex) {
                    case 0:
                        cell.isHeader = !!format.hasHeaderRow;
 
                        if (cell.isHeader) {
                            cell.format.fontWeight = 'bold';
                        }
                        break;
                    case rows.length - 1:
                        setBorderColor(cell.format, 'borderTop');
                        break;
                    case 1:
                        setBorderColor(cell.format, 'borderBottom');
                        break;
                    default:
                        setBorderColor(cell.format, 'borderTop');
                        setBorderColor(cell.format, 'borderBottom');
                        break;
                }
            }
        });
    });
}
 
function setHeaderRowFormat(
    rows: ShallowMutableContentModelTableRow[],
    format: TableMetadataFormat,
    metaOverrides: MetaOverrides
) {
    // Exit early if hasHeaderRow is not set
    if (!format.hasHeaderRow) {
        return;
    }
 
    const rowIndex = 0;
 
    rows[rowIndex]?.cells.forEach((readonlyCell, cellIndex) => {
        const cell = mutateBlock(readonlyCell);
 
        cell.isHeader = true;
        cell.format.fontWeight = 'bold';
 
        Eif (format.headerRowColor) {
            Eif (!metaOverrides.bgColorOverrides[rowIndex][cellIndex]) {
                setTableCellBackgroundColor(
                    cell,
                    format.headerRowColor,
                    false /*isColorOverride*/,
                    true /*applyToSegments*/
                );
            }
 
            setBorderColor(cell.format, 'borderTop', format.headerRowColor);
            setBorderColor(cell.format, 'borderRight', format.headerRowColor);
            setBorderColor(cell.format, 'borderLeft', format.headerRowColor);
        }
    });
}
 
/**
 * @param format The cell format to set the border color
 * @param key The border key to set the color
 * @param value The color to set. If not given, it removes the color and sets the style to transparent
 */
function setBorderColor(format: BorderFormat, key: keyof BorderFormat, value?: string) {
    const border = extractBorderValues(format[key]);
    border.color = value || '';
    border.style = getBorderStyleFromColor(border.color);
    format[key] = combineBorderValue(border);
}
 
function getBorderStyleFromColor(color?: string): string {
    return !color || color == 'transparent' ? 'none' : 'solid';
}