Preserve QExcell sheet tab colors in XLSX

This commit is contained in:
Курнат Андрей
2026-06-01 12:56:24 +03:00
parent 5ebc9639dc
commit 3d4e1d51ef
4 changed files with 74 additions and 7 deletions
+47
View File
@@ -6,6 +6,7 @@ import {
buildAutoFilterXml,
buildHyperlinksXml,
buildMergeCellsXml,
buildSheetPrXml,
buildSheetViewsXml,
createCellStyleRegistry,
buildWorksheetRelationshipsXml,
@@ -23,6 +24,7 @@ import {
worksheetXmlToFrozenPane,
worksheetXmlToHyperlinks,
worksheetXmlToMergedCells,
worksheetXmlToTabColor,
xlsxStylesXmlToCellFormatTable,
xlsxThemeXmlToColors,
xlsxCellToText
@@ -681,6 +683,51 @@ describe("excellOffice OOXML helpers", () => {
expect(imported.sheets[0].autoFilter).toBe("A1:D20");
});
it("читает и записывает цвет вкладки листа XLSX через sheetPr tabColor", async () => {
expect(
worksheetXmlToTabColor({
worksheet: {
sheetPr: { tabColor: { rgb: "FF0F766E" } }
}
})
).toBe("0F766E");
expect(
worksheetXmlToTabColor(
{
worksheet: {
sheetPr: { tabColor: { theme: "4" } }
}
},
["000000", "FFFFFF", "1F497D", "EEECE1", "123456"]
)
).toBe("123456");
expect(buildSheetPrXml("#0f766e")).toBe('<sheetPr><tabColor rgb="FF0F766E"/></sheetPr>');
expect(buildSheetPrXml("bad")).toBe("");
const blob = await exportXlsxBlob({
id: "book-1",
title: "Tab color.xlsx",
updatedAt: "2026-06-01T00:00:00.000Z",
activeSheet: "sheet-1",
sheets: [
{
id: "sheet-1",
name: "Color",
tabColor: "#0f766e",
frozenPane: { rows: 1 },
cells: { A1: "Header" }
}
]
});
const zip = await JSZip.loadAsync(await blob.arrayBuffer());
const sheetXml = (await zip.file("xl/worksheets/sheet1.xml")?.async("string")) ?? "";
const imported = await importXlsxFile(new File([blob], "Tab color.xlsx", { type: blob.type }));
expect(sheetXml).toContain('<sheetPr><tabColor rgb="FF0F766E"/></sheetPr>');
expect(sheetXml.indexOf("<sheetPr>")).toBeLessThan(sheetXml.indexOf("<sheetViews>"));
expect(imported.sheets[0].tabColor).toBe("0F766E");
});
it("создает OOXML chart part для диаграммы XLSX", () => {
const xml = buildChartXml(
{
+24 -5
View File
@@ -11,6 +11,7 @@ export interface ImportedExcellWorkbook {
visibility?: "hidden" | "veryHidden";
frozenPane?: SheetFrozenPane;
autoFilter?: string;
tabColor?: string;
cells: Record<string, string>;
mergedCells?: MergedCellRange[];
hyperlinks?: Record<string, string>;
@@ -60,6 +61,7 @@ interface ParsedSheet {
visibility?: "hidden" | "veryHidden";
frozenPane?: SheetFrozenPane;
autoFilter?: string;
tabColor?: string;
cells: Record<string, string>;
mergedCells?: MergedCellRange[];
hyperlinks?: Record<string, string>;
@@ -211,7 +213,7 @@ export async function importXlsxFile(file: File): Promise<ImportedExcellWorkbook
const sheetPath = resolveWorkbookTarget(target);
const sheetXml = parser.parse(await readZipText(zip, sheetPath));
const sheetRelationshipsXml = await readOptionalSheetRelationships(zip, parser, sheetPath);
const parsedSheet = parsedWorksheetToSheet(sheetXml, sheet, index, sharedStrings, sheetRelationshipsXml, styleTable);
const parsedSheet = parsedWorksheetToSheet(sheetXml, sheet, index, sharedStrings, sheetRelationshipsXml, styleTable, themeColors);
const charts = await worksheetXmlToCharts(zip, parser, sheetXml, sheetRelationshipsXml, sheetPath, parsedSheet.name);
return { ...parsedSheet, charts };
})
@@ -264,7 +266,8 @@ export async function exportXlsxBlob(workbook: Workbook): Promise<Blob> {
styleRegistry,
drawingRelationshipId,
sheet.frozenPane,
sheet.autoFilter
sheet.autoFilter,
sheet.tabColor
)
);
const relationshipsXml = buildWorksheetRelationshipsXml(
@@ -294,10 +297,12 @@ export function parsedWorksheetToSheet(
index: number,
sharedStrings: string[],
relationshipsXml?: unknown,
styleTable: Array<CellFormat | undefined> = []
styleTable: Array<CellFormat | undefined> = [],
themeColors: string[] = defaultXlsxThemeColors
): ParsedSheet {
const frozenPane = worksheetXmlToFrozenPane(worksheetXml);
const autoFilter = worksheetXmlToAutoFilter(worksheetXml);
const tabColor = worksheetXmlToTabColor(worksheetXml, themeColors);
return {
id: sheet.id || `sheet-${index + 1}`,
@@ -305,6 +310,7 @@ export function parsedWorksheetToSheet(
...(sheet.visibility ? { visibility: sheet.visibility } : {}),
...(frozenPane ? { frozenPane } : {}),
...(autoFilter ? { autoFilter } : {}),
...(tabColor ? { tabColor } : {}),
cells: worksheetXmlToCells(worksheetXml, sharedStrings),
mergedCells: worksheetXmlToMergedCells(worksheetXml),
hyperlinks: worksheetXmlToHyperlinks(worksheetXml, relationshipsXml),
@@ -429,6 +435,12 @@ export function worksheetXmlToAutoFilter(worksheetXml: unknown) {
return normalizeCellRange(String(autoFilter.ref ?? ""));
}
export function worksheetXmlToTabColor(worksheetXml: unknown, themeColors: string[] = defaultXlsxThemeColors) {
const worksheet = childRecord(worksheetXml, "worksheet");
const sheetPr = childRecord(worksheet, "sheetPr");
return colorRecordToHex(childRecord(sheetPr, "tabColor"), themeColors);
}
async function worksheetXmlToCharts(
zip: ZipInstance,
parser: InstanceType<XmlParserConstructor>,
@@ -601,7 +613,8 @@ export function buildWorksheetXml(
styleRegistry = createCellStyleRegistry([cellFormats]),
drawingRelationshipId = "",
frozenPane?: SheetFrozenPane,
autoFilter?: string
autoFilter?: string,
tabColor?: string
) {
const rows = sortedWorksheetEntries(cells, cellFormats).reduce<Record<number, Array<[string, string]>>>((grouped, entry) => {
const rowNumber = cellRowNumber(entry[0]);
@@ -623,10 +636,11 @@ export function buildWorksheetXml(
const autoFilterXml = buildAutoFilterXml(autoFilter);
const hyperlinksXml = buildHyperlinksXml(hyperlinks);
const drawingXml = drawingRelationshipId ? `<drawing r:id="${escapeXmlAttribute(drawingRelationshipId)}"/>` : "";
const sheetPrXml = buildSheetPrXml(tabColor);
const sheetViewsXml = buildSheetViewsXml(frozenPane);
return xmlDeclaration(
`<worksheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">${sheetViewsXml}<sheetData>${rowXml}</sheetData>${autoFilterXml}${mergeCellsXml}${hyperlinksXml}${drawingXml}</worksheet>`
`<worksheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">${sheetPrXml}${sheetViewsXml}<sheetData>${rowXml}</sheetData>${autoFilterXml}${mergeCellsXml}${hyperlinksXml}${drawingXml}</worksheet>`
);
}
@@ -702,6 +716,11 @@ export function buildSheetViewsXml(frozenPane?: SheetFrozenPane) {
return `<sheetViews><sheetView workbookViewId="0"><pane ${attributes}/></sheetView></sheetViews>`;
}
export function buildSheetPrXml(tabColor?: string) {
const color = normalizeFillColor(tabColor);
return color ? `<sheetPr><tabColor rgb="FF${color}"/></sheetPr>` : "";
}
export function buildAutoFilterXml(autoFilter?: string) {
const ref = normalizeCellRange(autoFilter ?? "");
return ref ? `<autoFilter ref="${escapeXmlAttribute(ref)}"/>` : "";