feat: add column header styling support

ChronicStone · Apr 29, 2024 · 0e217ca · 0e217ca
1 parent 7b18fb7
commit 0e217ca
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 11 deletions.
diff --git a/examples/financial-report.xlsx b/examples/financial-report.xlsx
diff --git a/examples/kitchen-sink.xlsx b/examples/kitchen-sink.xlsx
diff --git a/examples/playground.xlsx b/examples/playground.xlsx
diff --git a/src/index.ts b/src/index.ts
@@ -192,7 +192,7 @@ export class ExcelBuilder<UsedSheetKeys extends string = never> {
             worksheet[headerCellRef] = createCell({
               value: column.label,
               bordered: params?.bordered ?? true,
-              style: getColumnHeaderStyle({ bordered: params?.bordered ?? true }),
+              style: getColumnHeaderStyle({ bordered: params?.bordered ?? true, customStyle: column._ref.headerStyle }),
             })
 
             tableConfig.content.forEach((row, rowIndex) => {

diff --git a/src/types.ts b/src/types.ts
@@ -84,6 +84,7 @@ export type Column<
   default?: CellValue
   format?: string | ((rowData: T, rowIndex: number, subRowIndex: number) => string)
   cellStyle?: CellStyle | ((rowData: T, rowIndex: number, subRowIndex: number) => CellStyle)
+  headerStyle?: CellStyle
   summary?: Array<{
     value: (data: T[]) => BaseCellValue
     format?: string | ((data: T[]) => string)

diff --git a/src/utils.ts b/src/utils.ts
@@ -104,15 +104,18 @@ export function buildSheetConfig(sheets: Array<SheetConfig>) {
   }))
 }
 
-export function getColumnHeaderStyle(params: { bordered: boolean }) {
-  return {
-    font: { bold: true },
-    alignment: { horizontal: 'center', vertical: 'center' },
-    fill: { fgColor: { rgb: 'E9E9E9' } },
-    border: (params?.bordered ?? true)
-      ? THICK_BORDER_STYLE
-      : {},
-  } satisfies CellStyle
+export function getColumnHeaderStyle(params: { bordered: boolean, customStyle?: CellStyle }) {
+  return deepmerge(
+    {
+      font: { bold: true },
+      alignment: { horizontal: 'center', vertical: 'center' },
+      fill: { fgColor: { rgb: 'E9E9E9' } },
+      border: (params?.bordered ?? true)
+        ? THICK_BORDER_STYLE
+        : {},
+    },
+    params?.customStyle ?? {},
+  ) satisfies CellStyle
 }
 
 export function getWorksheetColumnWidths(worksheet: WorkSheet, extraLength: number = 1) {

diff --git a/test/play.test.ts b/test/play.test.ts
@@ -9,7 +9,11 @@ describe('should generate the play excel file', () => {
     // Group definition within the schema
     const schema = ExcelSchemaBuilder.create<User>()
       .column('id', { key: 'id' })
-      .column('name', { key: 'name' })
+      .column('name', {
+        key: 'name',
+        cellStyle: { fill: { fgColor: { rgb: 'FFFF00' } } },
+        headerStyle: { fill: { fgColor: { rgb: '00FF00' } } },
+      })
       .build()
 
     const users: User[] = Array.from({ length: 100000 }, (_, i) => ({