Merge branch '21128-toolbar-context-menu'

[arvados-workbench2.git] / src / components / data-table / data-column.ts

diff --git a/src/components/data-table/data-column.ts b/src/components/data-table/data-column.ts
index 06744c3a21bce90b9246ed74c06c984f9020cdf7..35655fb7dfea02aa9170cbfb2952f9a1eb2ad4c9 100644 (file)
--- a/src/components/data-table/data-column.ts
+++ b/src/components/data-table/data-column.ts
@@ -2,38 +2,56 @@
 //
 // SPDX-License-Identifier: AGPL-3.0
 
-import { DataTableFilterItem } from "../data-table-filters/data-table-filters";
+import React from "react";
+import { DataTableFilters } from "../data-table-filters/data-table-filters-tree";
+import { createTree } from 'models/tree';
 
-export interface DataColumn<T, F extends DataTableFilterItem = DataTableFilterItem> {
+/**
+ *
+ * @template I Type of dataexplorer item reference
+ * @template R Type of resource to use to restrict values of column sort.field
+ */
+export interface DataColumn<I, R> {
+    key?: React.Key;
     name: string;
     selected: boolean;
-    configurable?: boolean;
-    key?: React.Key;
-    sortDirection?: SortDirection;
-    filters?: F[];
-    render: (item: T) => React.ReactElement<void>;
-    renderHeader?: () => React.ReactElement<void> | null;
-    width?: string;
+    configurable: boolean;
+
+    /**
+     * If set to true, filters on this column will be displayed in a
+     * radio group and only one filter can be selected at a time.
+     */
+    mutuallyExclusiveFilters?: boolean;
+    sort?: {direction: SortDirection, field: keyof R};
+    filters: DataTableFilters;
+    render: (item: I) => React.ReactElement<any>;
+    renderHeader?: () => React.ReactElement<any>;
 }
 
 export enum SortDirection {
-    Asc = "asc",
-    Desc = "desc",
-    None = "none"
+    ASC = "asc",
+    DESC = "desc",
+    NONE = "none"
 }
 
-export const isColumnConfigurable = <T>(column: DataColumn<T>) => {
-    return column.configurable === undefined || column.configurable;
-};
-
-export const toggleSortDirection = <T>(column: DataColumn<T>): DataColumn<T> => {
-    return column.sortDirection
-        ? column.sortDirection === SortDirection.Asc
-            ? { ...column, sortDirection: SortDirection.Desc }
-            : { ...column, sortDirection: SortDirection.Asc }
+export const toggleSortDirection = <I, R>(column: DataColumn<I, R>): DataColumn<I, R> => {
+    return column.sort
+        ? column.sort.direction === SortDirection.ASC
+            ? { ...column, sort: {...column.sort, direction: SortDirection.DESC} }
+            : { ...column, sort: {...column.sort, direction: SortDirection.ASC} }
         : column;
 };
 
-export const resetSortDirection = <T>(column: DataColumn<T>): DataColumn<T> => {
-    return column.sortDirection ? { ...column, sortDirection: SortDirection.None } : column;
+export const resetSortDirection = <I, R>(column: DataColumn<I, R>): DataColumn<I, R> => {
+    return column.sort ? { ...column, sort: {...column.sort, direction: SortDirection.NONE} } : column;
 };
+
+export const createDataColumn = <I, R>(dataColumn: Partial<DataColumn<I, R>>): DataColumn<I, R> => ({
+    key: '',
+    name: '',
+    selected: true,
+    configurable: true,
+    filters: createTree(),
+    render: () => React.createElement('span'),
+    ...dataColumn,
+});