src/components/data-table/data-column.ts

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import { DataTableFilterItem } from "../data-table-filters/data-table-filters";
   6
   7 export interface DataColumn<T, F extends DataTableFilterItem = DataTableFilterItem> {
   8     name: string;
   9     selected: boolean;
  10     configurable?: boolean;
  11     key?: React.Key;
  12     sortDirection?: SortDirection;
  13     filters?: F[];
  14     render: (item: T) => React.ReactElement<void>;
  15     renderHeader?: () => React.ReactElement<void> | null;
  16     width?: string;
  17 }
  18
  19 export enum SortDirection {
  20     ASC = "asc",
  21     DESC = "desc",
  22     NONE = "none"
  23 }
  24
  25 export const isColumnConfigurable = <T>(column: DataColumn<T>) => {
  26     return column.configurable === undefined || column.configurable;
  27 };
  28
  29 export const toggleSortDirection = <T>(column: DataColumn<T>): DataColumn<T> => {
  30     return column.sortDirection
  31         ? column.sortDirection === SortDirection.ASC
  32             ? { ...column, sortDirection: SortDirection.DESC }
  33             : { ...column, sortDirection: SortDirection.ASC }
  34         : column;
  35 };
  36
  37 export const resetSortDirection = <T>(column: DataColumn<T>): DataColumn<T> => {
  38     return column.sortDirection ? { ...column, sortDirection: SortDirection.NONE } : column;
  39 };