1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
5 import React from 'react';
19 } from '@material-ui/core';
20 import classnames from 'classnames';
21 import { DataColumn, SortDirection } from './data-column';
22 import { DataTableDefaultView } from '../data-table-default-view/data-table-default-view';
23 import { DataTableFilters } from '../data-table-filters/data-table-filters-tree';
24 import { DataTableMultiselectPopover } from '../data-table-multiselect-popover/data-table-multiselect-popover';
25 import { DataTableFiltersPopover } from '../data-table-filters/data-table-filters-popover';
26 import { countNodes, getTreeDirty } from 'models/tree';
27 import { IconType, PendingIcon } from 'components/icon/icon';
28 import { SvgIconProps } from '@material-ui/core/SvgIcon';
29 import ArrowDownwardIcon from '@material-ui/icons/ArrowDownward';
30 import { createTree } from 'models/tree';
31 import arraysAreCongruent from 'validators/arrays-are-congruent';
32 import { DataTableMultiselectOption } from '../data-table-multiselect-popover/data-table-multiselect-popover';
34 export type DataColumns<I, R> = Array<DataColumn<I, R>>;
36 export enum DataTableFetchMode {
41 export interface DataTableDataProps<I> {
43 columns: DataColumns<I, any>;
44 onRowClick: (event: React.MouseEvent<HTMLTableRowElement>, item: I) => void;
45 onContextMenu: (event: React.MouseEvent<HTMLElement>, item: I) => void;
46 onRowDoubleClick: (event: React.MouseEvent<HTMLTableRowElement>, item: I) => void;
47 onSortToggle: (column: DataColumn<I, any>) => void;
48 onFiltersChange: (filters: DataTableFilters, column: DataColumn<I, any>) => void;
49 extractKey?: (item: I) => React.Key;
51 defaultViewIcon?: IconType;
52 defaultViewMessages?: string[];
53 currentItemUuid?: string;
54 currentRoute?: string;
68 | 'tableCellWorkflows'
71 const styles: StyleRulesCallback<CssRules> = (theme: Theme) => ({
76 display: 'inline-block',
80 background: theme.palette.background.paper,
89 padding: theme.spacing.unit,
103 wordWrap: 'break-word',
104 paddingRight: '24px',
107 tableCellWorkflows: {
108 '&:nth-last-child(2)': {
114 paddingRight: '24px',
122 color: theme.palette.text.primary,
126 type DataTableState = {
128 checkedList: Record<string, boolean>;
131 type DataTableProps<T> = DataTableDataProps<T> & WithStyles<CssRules>;
133 const multiselectOptions: DataTableMultiselectOption[] = [
134 { name: 'First Option', fn: (checkedList) => console.log('one', checkedList) },
135 { name: 'Second Option', fn: (checkedList) => console.log('two', checkedList) },
136 { name: 'Third Option', fn: (checkedList) => console.log('three', checkedList) },
139 export const DataTable = withStyles(styles)(
140 class Component<T> extends React.Component<DataTableProps<T>> {
141 state: DataTableState = {
146 componentDidMount(): void {
147 this.initializeCheckedList(this.props.items);
150 componentDidUpdate(prevProps: Readonly<DataTableProps<T>>) {
151 if (!arraysAreCongruent(prevProps.items, this.props.items)) {
152 this.initializeCheckedList(this.props.items);
156 checkBoxColumn: DataColumn<any, any> = {
157 name: 'checkBoxColumn',
160 filters: createTree(),
165 className={this.props.classes.checkBox}
166 checked={this.state.checkedList[uuid] ?? false}
167 onChange={() => this.handleCheck(uuid)}
168 onDoubleClick={(ev) => ev.stopPropagation()}
173 initializeCheckedList = (uuids: any[]): void => {
174 const { checkedList } = this.state;
175 uuids.forEach((uuid) => {
176 if (!checkedList.hasOwnProperty[uuid]) {
177 checkedList[uuid] = false;
182 handleSelectorSelect = (): void => {
183 const { isSelected, checkedList } = this.state;
184 const newCheckedList = { ...checkedList };
185 for (const key in newCheckedList) {
186 newCheckedList[key] = !isSelected;
188 this.setState({ isSelected: !isSelected, checkedList: newCheckedList });
191 handleCheck = (uuid: string): void => {
192 const { checkedList } = this.state;
193 const newCheckedList = { ...checkedList };
194 newCheckedList[uuid] = !checkedList[uuid];
195 this.setState({ checkedList: newCheckedList });
198 handleInvertSelect = (): void => {
199 const { checkedList } = this.state;
200 const newCheckedList = { ...checkedList };
201 for (const key in newCheckedList) {
202 newCheckedList[key] = !checkedList[key];
204 this.setState({ checkedList: newCheckedList });
208 const { items, classes, working, columns } = this.props;
209 if (columns[0].name === this.checkBoxColumn.name) columns.shift();
210 columns.unshift(this.checkBoxColumn);
213 <div className={classes.root}>
214 <div className={classes.content}>
217 <TableRow>{this.mapVisibleColumns(this.renderHeadCell)}</TableRow>
219 <TableBody className={classes.tableBody}>{!working && items.map(this.renderBodyRow)}</TableBody>
222 <div className={classes.loader}>
223 <DataTableDefaultView icon={PendingIcon} messages={['Loading data, please wait.']} />
226 {items.length === 0 && !working && this.renderNoItemsPlaceholder(this.props.columns)}
232 renderNoItemsPlaceholder = (columns: DataColumns<T, any>) => {
233 const dirty = columns.some((column) => getTreeDirty('')(column.filters));
234 return <DataTableDefaultView icon={this.props.defaultViewIcon} messages={this.props.defaultViewMessages} filtersApplied={dirty} />;
237 renderHeadCell = (column: DataColumn<T, any>, index: number) => {
238 const { name, key, renderHeader, filters, sort } = column;
239 const { onSortToggle, onFiltersChange, classes } = this.props;
240 return index === 0 ? (
241 <TableCell key={key || index} className={classes.checkBoxCell}>
242 <div className={classes.checkBoxHead}>
243 <Tooltip title={this.state.isSelected ? 'Deselect All' : 'Select All'}>
244 <input type='checkbox' className={classes.checkBox} checked={this.state.isSelected} onChange={this.handleSelectorSelect}></input>
246 <DataTableMultiselectPopover name={`Options`} options={multiselectOptions} checkedList={this.state.checkedList}></DataTableMultiselectPopover>
250 <TableCell className={classes.tableCell} key={key || index}>
253 ) : countNodes(filters) > 0 ? (
254 <DataTableFiltersPopover
255 name={`${name} filters`}
256 mutuallyExclusive={column.mutuallyExclusiveFilters}
257 onChange={(filters) => onFiltersChange && onFiltersChange(filters, column)}
261 </DataTableFiltersPopover>
264 active={sort.direction !== SortDirection.NONE}
265 direction={sort.direction !== SortDirection.NONE ? sort.direction : undefined}
266 IconComponent={this.ArrowIcon}
268 onClick={() => onSortToggle && onSortToggle(column)}
279 ArrowIcon = ({ className, ...props }: SvgIconProps) => (
280 <IconButton component='span' className={this.props.classes.arrowButton} tabIndex={-1}>
281 <ArrowDownwardIcon {...props} className={classnames(className, this.props.classes.arrow)} />
285 renderBodyRow = (item: any, index: number) => {
286 const { onRowClick, onRowDoubleClick, extractKey, classes, currentItemUuid, currentRoute } = this.props;
290 key={extractKey ? extractKey(item) : index}
291 onClick={(event) => onRowClick && onRowClick(event, item)}
292 onContextMenu={this.handleRowContextMenu(item)}
293 onDoubleClick={(event) => onRowDoubleClick && onRowDoubleClick(event, item)}
294 selected={item === currentItemUuid}
296 {this.mapVisibleColumns((column, index) => (
298 key={column.key || index}
299 className={currentRoute === '/workflows' ? classes.tableCellWorkflows : index === 0 ? classes.checkBoxCell : classes.tableCell}
301 {column.render(item)}
308 mapVisibleColumns = (fn: (column: DataColumn<T, any>, index: number) => React.ReactElement<any>) => {
309 return this.props.columns.filter((column) => column.selected).map(fn);
312 handleRowContextMenu = (item: T) => (event: React.MouseEvent<HTMLElement>) => this.props.onContextMenu(event, item);