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 { DataTableMultiselectOption } from "../data-table-multiselect-popover/data-table-multiselect-popover";
33 export type DataColumns<I, R> = Array<DataColumn<I, R>>;
35 export enum DataTableFetchMode {
40 export interface DataTableDataProps<I> {
42 columns: DataColumns<I, any>;
43 onRowClick: (event: React.MouseEvent<HTMLTableRowElement>, item: I) => void;
44 onContextMenu: (event: React.MouseEvent<HTMLElement>, item: I) => void;
45 onRowDoubleClick: (event: React.MouseEvent<HTMLTableRowElement>, item: I) => void;
46 onSortToggle: (column: DataColumn<I, any>) => void;
47 onFiltersChange: (filters: DataTableFilters, column: DataColumn<I, any>) => void;
48 extractKey?: (item: I) => React.Key;
50 defaultViewIcon?: IconType;
51 defaultViewMessages?: string[];
52 currentItemUuid?: string;
53 currentRoute?: string;
54 toggleMSToolbar: (isVisible: boolean) => void;
55 setCheckedListOnStore: (checkedList: TCheckedList) => void;
56 checkedList: TCheckedList;
71 | "tableCellWorkflows"
74 const styles: StyleRulesCallback<CssRules> = (theme: Theme) => ({
79 display: "inline-block",
83 background: theme.palette.background.paper,
92 padding: theme.spacing.unit,
106 wordWrap: "break-word",
107 paddingRight: "24px",
113 tableCellWorkflows: {
114 "&:nth-last-child(2)": {
120 paddingRight: "24px",
128 color: theme.palette.text.primary,
132 export type TCheckedList = Record<string, boolean>;
134 type DataTableState = {
138 type DataTableProps<T> = DataTableDataProps<T> & WithStyles<CssRules>;
140 export const DataTable = withStyles(styles)(
141 class Component<T> extends React.Component<DataTableProps<T>> {
142 state: DataTableState = {
146 componentDidMount(): void {
147 this.initializeCheckedList(this.props.items);
150 componentDidUpdate(prevProps: Readonly<DataTableProps<T>>, prevState: DataTableState) {
151 const { items, setCheckedListOnStore } = this.props;
152 const { isSelected } = this.state;
153 if (prevProps.items !== items) {
154 if (isSelected === true) this.setState({ isSelected: false });
155 if (items.length) this.initializeCheckedList(items);
156 else setCheckedListOnStore({});
158 if (prevProps.currentRoute !== this.props.currentRoute) {
159 this.initializeCheckedList([])
163 componentWillUnmount(): void {
164 this.initializeCheckedList([])
167 checkBoxColumn: DataColumn<any, any> = {
168 name: "checkBoxColumn",
171 filters: createTree(),
173 const { classes, checkedList } = this.props;
176 data-cy={`multiselect-checkbox-${uuid}`}
179 className={classes.checkBox}
180 checked={checkedList && checkedList[uuid] ? checkedList[uuid] : false}
181 onChange={() => this.handleSelectOne(uuid)}
182 onDoubleClick={ev => ev.stopPropagation()}></input>
187 multiselectOptions: DataTableMultiselectOption[] = [
188 { name: "All", fn: list => this.handleSelectAll(list) },
189 { name: "None", fn: list => this.handleSelectNone(list) },
190 { name: "Invert", fn: list => this.handleInvertSelect(list) },
193 initializeCheckedList = (uuids: any[]): void => {
194 const newCheckedList = { ...this.props.checkedList };
196 uuids.forEach(uuid => {
197 if (!newCheckedList.hasOwnProperty(uuid)) {
198 newCheckedList[uuid] = false;
201 for (const key in newCheckedList) {
202 if (!uuids.includes(key)) {
203 delete newCheckedList[key];
206 this.props.setCheckedListOnStore(newCheckedList);
209 isAllSelected = (list: TCheckedList): boolean => {
210 for (const key in list) {
211 if (list[key] === false) return false;
216 isAnySelected = (): boolean => {
217 const { checkedList } = this.props;
218 if (!Object.keys(checkedList).length) return false;
219 for (const key in checkedList) {
220 if (checkedList[key] === true) return true;
225 handleSelectOne = (uuid: string): void => {
226 const { checkedList } = this.props;
227 const newCheckedList = { ...checkedList };
228 newCheckedList[uuid] = !checkedList[uuid];
229 this.setState({ isSelected: this.isAllSelected(newCheckedList) });
230 this.props.setCheckedListOnStore(newCheckedList);
233 handleSelectorSelect = (): void => {
234 const { checkedList } = this.props;
235 const { isSelected } = this.state;
236 isSelected ? this.handleSelectNone(checkedList) : this.handleSelectAll(checkedList);
239 handleSelectAll = (list: TCheckedList): void => {
240 if (Object.keys(list).length) {
241 const newCheckedList = { ...list };
242 for (const key in newCheckedList) {
243 newCheckedList[key] = true;
245 this.setState({ isSelected: true });
246 this.props.setCheckedListOnStore(newCheckedList);
250 handleSelectNone = (list: TCheckedList): void => {
251 const newCheckedList = { ...list };
252 for (const key in newCheckedList) {
253 newCheckedList[key] = false;
255 this.setState({ isSelected: false });
256 this.props.setCheckedListOnStore(newCheckedList);
259 handleInvertSelect = (list: TCheckedList): void => {
260 if (Object.keys(list).length) {
261 const newCheckedList = { ...list };
262 for (const key in newCheckedList) {
263 newCheckedList[key] = !list[key];
265 this.setState({ isSelected: this.isAllSelected(newCheckedList) });
266 this.props.setCheckedListOnStore(newCheckedList);
271 const { items, classes, working, columns } = this.props;
272 if (columns[0].name === this.checkBoxColumn.name) columns.shift();
273 columns.unshift(this.checkBoxColumn);
275 <div className={classes.root}>
276 <div className={classes.content}>
279 <TableRow>{this.mapVisibleColumns(this.renderHeadCell)}</TableRow>
281 <TableBody className={classes.tableBody}>{!working && items.map(this.renderBodyRow)}</TableBody>
284 <div className={classes.loader}>
285 <DataTableDefaultView
287 messages={["Loading data, please wait."]}
291 {items.length === 0 && !working && this.renderNoItemsPlaceholder(this.props.columns)}
297 renderNoItemsPlaceholder = (columns: DataColumns<T, any>) => {
298 const dirty = columns.some(column => getTreeDirty("")(column.filters));
300 <DataTableDefaultView
301 icon={this.props.defaultViewIcon}
302 messages={this.props.defaultViewMessages}
303 filtersApplied={dirty}
308 renderHeadCell = (column: DataColumn<T, any>, index: number) => {
309 const { name, key, renderHeader, filters, sort } = column;
310 const { onSortToggle, onFiltersChange, classes, checkedList } = this.props;
311 const { isSelected } = this.state;
312 return column.name === "checkBoxColumn" ? (
315 className={classes.checkBoxCell}>
316 <div className={classes.checkBoxHead}>
317 <Tooltip title={this.state.isSelected ? "Deselect All" : "Select All"}>
320 className={classes.checkBox}
322 disabled={!this.props.items.length}
323 onChange={this.handleSelectorSelect}></input>
325 <DataTableMultiselectPopover
327 disabled={!this.props.items.length}
328 options={this.multiselectOptions}
329 checkedList={checkedList}></DataTableMultiselectPopover>
334 className={index === 1 ? classes.firstTableCell : classes.tableCell}
338 ) : countNodes(filters) > 0 ? (
339 <DataTableFiltersPopover
340 name={`${name} filters`}
341 mutuallyExclusive={column.mutuallyExclusiveFilters}
342 onChange={filters => onFiltersChange && onFiltersChange(filters, column)}
345 </DataTableFiltersPopover>
348 active={sort.direction !== SortDirection.NONE}
349 direction={sort.direction !== SortDirection.NONE ? sort.direction : undefined}
350 IconComponent={this.ArrowIcon}
352 onClick={() => onSortToggle && onSortToggle(column)}>
362 ArrowIcon = ({ className, ...props }: SvgIconProps) => (
365 className={this.props.classes.arrowButton}
369 className={classnames(className, this.props.classes.arrow)}
374 renderBodyRow = (item: any, index: number) => {
375 const { onRowClick, onRowDoubleClick, extractKey, classes, currentItemUuid, currentRoute } = this.props;
378 data-cy={'data-table-row'}
380 key={extractKey ? extractKey(item) : index}
381 onClick={event => onRowClick && onRowClick(event, item)}
382 onContextMenu={this.handleRowContextMenu(item)}
383 onDoubleClick={event => onRowDoubleClick && onRowDoubleClick(event, item)}
384 selected={item === currentItemUuid}>
385 {this.mapVisibleColumns((column, index) => (
387 key={column.key || index}
389 currentRoute === "/workflows"
390 ? classes.tableCellWorkflows
392 ? classes.checkBoxCell
393 : `${classes.tableCell} ${index === 1 ? classes.firstTableCell : ""}`
395 {column.render(item)}
402 mapVisibleColumns = (fn: (column: DataColumn<T, any>, index: number) => React.ReactElement<any>) => {
403 return this.props.columns.filter(column => column.selected).map(fn);
406 handleRowContextMenu = (item: T) => (event: React.MouseEvent<HTMLElement>) => this.props.onContextMenu(event, item);