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 } 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 { DataTableMultiselectOption } from "../data-table-multiselect-popover/data-table-multiselect-popover";
32 import { isExactlyOneSelected } from "store/multiselect/multiselect-actions";
33 import { PendingIcon } from "components/icon/icon";
35 export type DataColumns<I, R> = Array<DataColumn<I, R>>;
37 export enum DataTableFetchMode {
42 export interface DataTableDataProps<I> {
44 columns: DataColumns<I, any>;
45 onRowClick: (event: React.MouseEvent<HTMLTableRowElement>, item: I) => void;
46 onContextMenu: (event: React.MouseEvent<HTMLElement>, item: I) => void;
47 onRowDoubleClick: (event: React.MouseEvent<HTMLTableRowElement>, item: I) => void;
48 onSortToggle: (column: DataColumn<I, any>) => void;
49 onFiltersChange: (filters: DataTableFilters, column: DataColumn<I, any>) => void;
50 extractKey?: (item: I) => React.Key;
52 defaultViewIcon?: IconType;
53 defaultViewMessages?: string[];
54 toggleMSToolbar: (isVisible: boolean) => void;
55 setCheckedListOnStore: (checkedList: TCheckedList) => void;
56 currentRoute?: string;
57 currentRouteUuid: string;
58 checkedList: TCheckedList;
59 selectedResourceUuid: string;
60 setSelectedUuid: (uuid: string | null) => void;
77 | "tableCellWorkflows";
79 const styles: StyleRulesCallback<CssRules> = (theme: Theme) => ({
84 display: "inline-block",
88 background: theme.palette.background.paper,
92 padding: theme.spacing.unit,
99 paddingLeft: '0.9rem',
100 marginRight: '0.5rem'
109 paddingLeft: '0.35rem',
110 paddingTop: '0.1rem',
111 marginLeft: '0.5rem',
118 wordWrap: "break-word",
119 paddingRight: "24px",
125 tableCellWorkflows: {
126 "&:nth-last-child(2)": {
132 paddingRight: "24px",
140 color: theme.palette.text.primary,
144 export type TCheckedList = Record<string, boolean>;
146 type DataTableState = {
151 type DataTableProps<T> = DataTableDataProps<T> & WithStyles<CssRules>;
153 export const DataTable = withStyles(styles)(
154 class Component<T> extends React.Component<DataTableProps<T>> {
155 state: DataTableState = {
160 componentDidMount(): void {
161 this.initializeCheckedList([]);
164 componentDidUpdate(prevProps: Readonly<DataTableProps<T>>, prevState: DataTableState) {
165 const { items, currentRouteUuid, setCheckedListOnStore } = this.props;
166 const { isSelected } = this.state;
167 const singleSelected = isExactlyOneSelected(this.props.checkedList);
168 if (prevProps.items !== items) {
169 if (isSelected === true) this.setState({ isSelected: false });
170 if (items.length) this.initializeCheckedList(items);
171 else setCheckedListOnStore({});
173 if (prevProps.currentRoute !== this.props.currentRoute) {
174 this.initializeCheckedList([])
176 if (singleSelected && singleSelected !== isExactlyOneSelected(prevProps.checkedList)) {
177 this.props.setSelectedUuid(singleSelected);
179 if (!singleSelected && !!currentRouteUuid && !this.isAnySelected()) {
180 this.props.setSelectedUuid(currentRouteUuid);
182 if (!singleSelected && this.isAnySelected()) {
183 this.props.setSelectedUuid(null);
185 if(prevProps.working === true && this.props.working === false) {
186 this.setState({ isLoaded: true });
188 if((this.props.items.length > 0) && !this.state.isLoaded) {
189 this.setState({ isLoaded: true });
193 componentWillUnmount(): void {
194 this.initializeCheckedList([])
197 checkBoxColumn: DataColumn<any, any> = {
198 name: "checkBoxColumn",
201 filters: createTree(),
203 const { classes, checkedList } = this.props;
206 className={classes.clickBox}
209 this.handleSelectOne(uuid)
211 onDoubleClick={(ev) => ev.stopPropagation()}
214 data-cy={`multiselect-checkbox-${uuid}`}
217 className={classes.checkBox}
218 checked={checkedList && checkedList[uuid] ? checkedList[uuid] : false}
219 onChange={() => this.handleSelectOne(uuid)}
220 onDoubleClick={(ev) => ev.stopPropagation()}
227 multiselectOptions: DataTableMultiselectOption[] = [
228 { name: "All", fn: list => this.handleSelectAll(list) },
229 { name: "None", fn: list => this.handleSelectNone(list) },
230 { name: "Invert", fn: list => this.handleInvertSelect(list) },
233 initializeCheckedList = (uuids: any[]): void => {
234 const newCheckedList = { ...this.props.checkedList };
236 if(Object.keys(newCheckedList).length === 0){
237 for(const uuid of uuids){
238 newCheckedList[uuid] = false
242 for (const key in newCheckedList) {
243 if (!uuids.includes(key)) {
244 delete newCheckedList[key];
247 this.props.setCheckedListOnStore(newCheckedList);
250 isAllSelected = (list: TCheckedList): boolean => {
251 for (const key in list) {
252 if (list[key] === false) return false;
257 isAnySelected = (): boolean => {
258 const { checkedList } = this.props;
259 if (!Object.keys(checkedList).length) return false;
260 for (const key in checkedList) {
261 if (checkedList[key] === true) return true;
266 handleSelectOne = (uuid: string): void => {
267 const { checkedList } = this.props;
268 const newCheckedList = { ...checkedList };
269 newCheckedList[uuid] = !checkedList[uuid];
270 this.setState({ isSelected: this.isAllSelected(newCheckedList) });
271 this.props.setCheckedListOnStore(newCheckedList);
274 handleSelectorSelect = (): void => {
275 const { checkedList } = this.props;
276 const { isSelected } = this.state;
277 isSelected ? this.handleSelectNone(checkedList) : this.handleSelectAll(checkedList);
280 handleSelectAll = (list: TCheckedList): void => {
281 if (Object.keys(list).length) {
282 const newCheckedList = { ...list };
283 for (const key in newCheckedList) {
284 newCheckedList[key] = true;
286 this.setState({ isSelected: true });
287 this.props.setCheckedListOnStore(newCheckedList);
291 handleSelectNone = (list: TCheckedList): void => {
292 const newCheckedList = { ...list };
293 for (const key in newCheckedList) {
294 newCheckedList[key] = false;
296 this.setState({ isSelected: false });
297 this.props.setCheckedListOnStore(newCheckedList);
300 handleInvertSelect = (list: TCheckedList): void => {
301 if (Object.keys(list).length) {
302 const newCheckedList = { ...list };
303 for (const key in newCheckedList) {
304 newCheckedList[key] = !list[key];
306 this.setState({ isSelected: this.isAllSelected(newCheckedList) });
307 this.props.setCheckedListOnStore(newCheckedList);
312 const { items, classes, columns, isNotFound } = this.props;
313 const { isLoaded } = this.state;
314 if (columns[0].name === this.checkBoxColumn.name) columns.shift();
315 columns.unshift(this.checkBoxColumn);
317 <div className={classes.root}>
318 <div className={classes.content}>
321 <TableRow>{this.mapVisibleColumns(this.renderHeadCell)}</TableRow>
323 <TableBody className={classes.tableBody}>{(isLoaded && !isNotFound) && items.map(this.renderBodyRow)}</TableBody>
325 {(!isLoaded || isNotFound || items.length === 0) && this.renderNoItemsPlaceholder(this.props.columns)}
331 renderNoItemsPlaceholder = (columns: DataColumns<T, any>) => {
332 const { isLoaded } = this.state;
333 const { working, isNotFound } = this.props;
334 const dirty = columns.some(column => getTreeDirty("")(column.filters));
335 if (isNotFound && isLoaded) {
337 <DataTableDefaultView
338 icon={this.props.defaultViewIcon}
339 messages={["No items found"]}
343 if (isLoaded === false || working === true) {
345 <DataTableDefaultView
347 messages={["Loading data, please wait"]}
351 // isLoaded && !working && !isNotFound
353 <DataTableDefaultView
354 icon={this.props.defaultViewIcon}
355 messages={this.props.defaultViewMessages}
356 filtersApplied={dirty}
362 renderHeadCell = (column: DataColumn<T, any>, index: number) => {
363 const { name, key, renderHeader, filters, sort } = column;
364 const { onSortToggle, onFiltersChange, classes, checkedList } = this.props;
365 const { isSelected } = this.state;
366 return column.name === "checkBoxColumn" ? (
369 className={classes.checkBoxCell}>
370 <div className={classes.checkBoxHead}>
371 <Tooltip title={this.state.isSelected ? "Deselect All" : "Select All"}>
374 className={classes.checkBox}
376 disabled={!this.props.items.length}
377 onChange={this.handleSelectorSelect}></input>
379 <DataTableMultiselectPopover
381 disabled={!this.props.items.length}
382 options={this.multiselectOptions}
383 checkedList={checkedList}></DataTableMultiselectPopover>
388 className={index === 1 ? classes.firstTableCell : classes.tableCell}
392 ) : countNodes(filters) > 0 ? (
393 <DataTableFiltersPopover
394 name={`${name} filters`}
395 mutuallyExclusive={column.mutuallyExclusiveFilters}
396 onChange={filters => onFiltersChange && onFiltersChange(filters, column)}
399 </DataTableFiltersPopover>
402 active={sort.direction !== SortDirection.NONE}
403 direction={sort.direction !== SortDirection.NONE ? sort.direction : undefined}
404 IconComponent={this.ArrowIcon}
406 onClick={() => onSortToggle && onSortToggle(column)}>
416 ArrowIcon = ({ className, ...props }: SvgIconProps) => (
419 className={this.props.classes.arrowButton}
423 className={classnames(className, this.props.classes.arrow)}
428 renderBodyRow = (item: any, index: number) => {
429 const { onRowClick, onRowDoubleClick, extractKey, classes, selectedResourceUuid, currentRoute } = this.props;
432 data-cy={'data-table-row'}
434 key={extractKey ? extractKey(item) : index}
435 onClick={event => onRowClick && onRowClick(event, item)}
436 onContextMenu={this.handleRowContextMenu(item)}
437 onDoubleClick={event => onRowDoubleClick && onRowDoubleClick(event, item)}
438 selected={item === selectedResourceUuid}>
439 {this.mapVisibleColumns((column, index) => (
441 key={column.key || index}
443 currentRoute === "/workflows"
444 ? classes.tableCellWorkflows
446 ? classes.checkBoxCell
447 : `${classes.tableCell} ${index === 1 ? classes.firstTableCell : ""}`
449 {column.render(item)}
456 mapVisibleColumns = (fn: (column: DataColumn<T, any>, index: number) => React.ReactElement<any>) => {
457 return this.props.columns.filter(column => column.selected).map(fn);
460 handleRowContextMenu = (item: T) => (event: React.MouseEvent<HTMLElement>) => this.props.onContextMenu(event, item);