feat: add APIs that return added class names

packages/toast-ui.grid/cypress/integration/attributes.spec.ts

@@ -94,6 +94,29 @@ describe('className', () => {
       cy.wrap($el).should('not.have.class', 'tui-grid-row-test');
     });
   });
+
+  it('getRowClassName() / getColumnClassName() / getCellClassName()', () => {
+    cy.gridInstance().invoke('addRowClassName', 0, 'tui-grid-row-test');
+    cy.gridInstance().invoke('addColumnClassName', 'age', 'tui-grid-column-test');
+    cy.gridInstance().invoke('addCellClassName', 0, 'age', 'tui-grid-cell-test');
+
+    cy.gridInstance()
+      .invoke('getRowClassName', 0)
+      .should('deep.equal', ['row-test-a', 'tui-grid-row-test']);
+
+    cy.gridInstance()
+      .invoke('getColumnClassName', 'age')
+      .should('deep.equal', ['tui-grid-column-test']);
+
+    cy.gridInstance()
+      .invoke('getCellClassName', 0, 'age')
+      .should('deep.equal', [
+        'row-test-a',
+        'tui-grid-row-test',
+        'tui-grid-cell-test',
+        'tui-grid-column-test',
+      ]);
+  });
 });
 
 describe('row disabled', () => {

packages/toast-ui.grid/src/grid.tsx

@@ -51,6 +51,9 @@ import {
   pick,
   deepCopy,
   find,
+  includes,
+  isEmpty,
+  isNil,
 } from './helper/common';
 import { Observable, getOriginObject } from './helper/observable';
 import { createEventBus, EventBus } from './event/eventBus';
@@ -1325,6 +1328,36 @@ export default class Grid implements TuiGrid {
     this.dispatch('removeRowClassName', rowKey, className);
   }
 
+  /**
+   * Return a list of class names of specific cell.
+   * @param {number|string} rowKey - The unique key of the row
+   * @param {string} columnName - The name of the column
+   * @returns {Array} - A list of class names
+   */
+  public getCellClassName(rowKey: RowKey, columnName: string) {
+    const targetRow = this.getRow(rowKey);
+    const isExistColumnName = this.store.column.allColumns.some(({ name }) => name === columnName);
+
+    if (!isNil(targetRow) && isExistColumnName) {
+      const { row, column } = targetRow._attributes.className;
+
+      return [...row, ...(column[columnName] ?? [])];
+    }
+
+    return [];
+  }
+
+  /**
+   * Return a list of class names of specific row.
+   * @param {number|string} rowKey - The unique key of the row
+   * @returns {Array} - A list of class names
+   */
+  public getRowClassName(rowKey: RowKey) {
+    const targetRow = this.getRow(rowKey);
+
+    return isNil(targetRow) ? [] : targetRow._attributes.className.row;
+  }
+
   /**
    * Add custom event to grid.
    * @param {string} eventName - custom event name
@@ -1687,6 +1720,32 @@ export default class Grid implements TuiGrid {
     this.dispatch('removeColumnClassName', columnName, className);
   }
 
+  /**
+   * Return a list of class names of specific column.
+   * @param {string} columnName - The name of the column
+   * @returns {Array} - A list of class names
+   */
+  public getColumnClassName(columnName: string) {
+    const { rawData } = this.store.data;
+    const classNamesOfFirstRow: string[] = rawData[0]._attributes.className.column[columnName];
+
+    if (isEmpty(classNamesOfFirstRow)) {
+      return [];
+    }
+
+    return rawData.slice(1).reduce((acc, row, _, arr) => {
+      const classNames = row._attributes.className.column[columnName];
+
+      if (isEmpty(classNames) || isEmpty(acc)) {
+        arr.splice(0);
+
+        return [];
+      }
+
+      return acc.filter((className) => includes(classNames, className));
+    }, classNamesOfFirstRow);
+  }
+
   /**
    * Set new data to the row identified by the specified rowKey.
    * @param {number|string} rowKey - The unique key of the row

packages/toast-ui.grid/types/index.d.ts

@@ -212,6 +212,10 @@ declare namespace tui {
 
     public removeRowClassName(rowKey: RowKey, className: string): void;
 
+    public getCellClassName(rowKey: RowKey, columnName: string): string[];
+
+    public getRowClassName(rowKey: RowKey): string[];
+
     public on(eventName: GridEventName, fn: GridEventListener): void;
 
     public off(eventName: GridEventName, fn?: GridEventListener): void;
@@ -275,6 +279,8 @@ declare namespace tui {
 
     public removeColumnClassName(columnName: string, className: string): void;
 
+    public getColumnClassName(columnName: string): string[];
+
     public setRow(rowKey: RowKey, row: OptRow): void;
 
     public moveRow(rowKey: RowKey, targetIndex: number, options: OptMoveRow): void;