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;
72 | "tableCellWorkflows"
75 const styles: StyleRulesCallback<CssRules> = (theme: Theme) => ({
80 display: "inline-block",
84 background: theme.palette.background.paper,
93 padding: theme.spacing.unit,
100 paddingLeft: '0.9rem',
101 marginRight: '0.5rem'
110 paddingLeft: '0.35rem',
111 paddingTop: '0.1rem',
112 marginLeft: '0.5rem',
119 wordWrap: "break-word",
120 paddingRight: "24px",
126 tableCellWorkflows: {
127 "&:nth-last-child(2)": {
133 paddingRight: "24px",
141 color: theme.palette.text.primary,
145 export type TCheckedList = Record<string, boolean>;
147 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 = {
159 componentDidMount(): void {
160 this.initializeCheckedList([]);
163 componentDidUpdate(prevProps: Readonly<DataTableProps<T>>, prevState: DataTableState) {
164 const { items, setCheckedListOnStore } = this.props;
165 const { isSelected } = this.state;
166 if (prevProps.items !== items) {
167 if (isSelected === true) this.setState({ isSelected: false });
168 if (items.length) this.initializeCheckedList(items);
169 else setCheckedListOnStore({});
171 if (prevProps.currentRoute !== this.props.currentRoute) {
172 this.initializeCheckedList([])
176 componentWillUnmount(): void {
177 this.initializeCheckedList([])
180 checkBoxColumn: DataColumn<any, any> = {
181 name: "checkBoxColumn",
184 filters: createTree(),
186 const { classes, checkedList } = this.props;
189 className={classes.clickBox}
192 this.handleSelectOne(uuid)
194 onDoubleClick={(ev) => ev.stopPropagation()}
197 data-cy={`multiselect-checkbox-${uuid}`}
200 className={classes.checkBox}
201 checked={checkedList && checkedList[uuid] ? checkedList[uuid] : false}
202 onChange={() => this.handleSelectOne(uuid)}
203 onDoubleClick={(ev) => ev.stopPropagation()}
210 multiselectOptions: DataTableMultiselectOption[] = [
211 { name: "All", fn: list => this.handleSelectAll(list) },
212 { name: "None", fn: list => this.handleSelectNone(list) },
213 { name: "Invert", fn: list => this.handleInvertSelect(list) },
216 initializeCheckedList = (uuids: any[]): void => {
217 const newCheckedList = { ...this.props.checkedList };
219 uuids.forEach(uuid => {
220 if (!newCheckedList.hasOwnProperty(uuid)) {
221 newCheckedList[uuid] = false;
224 for (const key in newCheckedList) {
225 if (!uuids.includes(key)) {
226 delete newCheckedList[key];
229 this.props.setCheckedListOnStore(newCheckedList);
232 isAllSelected = (list: TCheckedList): boolean => {
233 for (const key in list) {
234 if (list[key] === false) return false;
239 isAnySelected = (): boolean => {
240 const { checkedList } = this.props;
241 if (!Object.keys(checkedList).length) return false;
242 for (const key in checkedList) {
243 if (checkedList[key] === true) return true;
248 handleSelectOne = (uuid: string): void => {
249 const { checkedList } = this.props;
250 const newCheckedList = { ...checkedList };
251 newCheckedList[uuid] = !checkedList[uuid];
252 this.setState({ isSelected: this.isAllSelected(newCheckedList) });
253 this.props.setCheckedListOnStore(newCheckedList);
256 handleSelectorSelect = (): void => {
257 const { checkedList } = this.props;
258 const { isSelected } = this.state;
259 isSelected ? this.handleSelectNone(checkedList) : this.handleSelectAll(checkedList);
262 handleSelectAll = (list: TCheckedList): void => {
263 if (Object.keys(list).length) {
264 const newCheckedList = { ...list };
265 for (const key in newCheckedList) {
266 newCheckedList[key] = true;
268 this.setState({ isSelected: true });
269 this.props.setCheckedListOnStore(newCheckedList);
273 handleSelectNone = (list: TCheckedList): void => {
274 const newCheckedList = { ...list };
275 for (const key in newCheckedList) {
276 newCheckedList[key] = false;
278 this.setState({ isSelected: false });
279 this.props.setCheckedListOnStore(newCheckedList);
282 handleInvertSelect = (list: TCheckedList): void => {
283 if (Object.keys(list).length) {
284 const newCheckedList = { ...list };
285 for (const key in newCheckedList) {
286 newCheckedList[key] = !list[key];
288 this.setState({ isSelected: this.isAllSelected(newCheckedList) });
289 this.props.setCheckedListOnStore(newCheckedList);
294 const { items, classes, working, columns } = this.props;
295 if (columns[0].name === this.checkBoxColumn.name) columns.shift();
296 columns.unshift(this.checkBoxColumn);
298 <div className={classes.root}>
299 <div className={classes.content}>
302 <TableRow>{this.mapVisibleColumns(this.renderHeadCell)}</TableRow>
304 <TableBody className={classes.tableBody}>{!working && items.map(this.renderBodyRow)}</TableBody>
307 <div className={classes.loader}>
308 <DataTableDefaultView
310 messages={["Loading data, please wait."]}
314 {items.length === 0 && !working && this.renderNoItemsPlaceholder(this.props.columns)}
320 renderNoItemsPlaceholder = (columns: DataColumns<T, any>) => {
321 const dirty = columns.some(column => getTreeDirty("")(column.filters));
323 <DataTableDefaultView
324 icon={this.props.defaultViewIcon}
325 messages={this.props.defaultViewMessages}
326 filtersApplied={dirty}
331 renderHeadCell = (column: DataColumn<T, any>, index: number) => {
332 const { name, key, renderHeader, filters, sort } = column;
333 const { onSortToggle, onFiltersChange, classes, checkedList } = this.props;
334 const { isSelected } = this.state;
335 return column.name === "checkBoxColumn" ? (
338 className={classes.checkBoxCell}>
339 <div className={classes.checkBoxHead}>
340 <Tooltip title={this.state.isSelected ? "Deselect All" : "Select All"}>
343 className={classes.checkBox}
345 disabled={!this.props.items.length}
346 onChange={this.handleSelectorSelect}></input>
348 <DataTableMultiselectPopover
350 disabled={!this.props.items.length}
351 options={this.multiselectOptions}
352 checkedList={checkedList}></DataTableMultiselectPopover>
357 className={index === 1 ? classes.firstTableCell : classes.tableCell}
361 ) : countNodes(filters) > 0 ? (
362 <DataTableFiltersPopover
363 name={`${name} filters`}
364 mutuallyExclusive={column.mutuallyExclusiveFilters}
365 onChange={filters => onFiltersChange && onFiltersChange(filters, column)}
368 </DataTableFiltersPopover>
371 active={sort.direction !== SortDirection.NONE}
372 direction={sort.direction !== SortDirection.NONE ? sort.direction : undefined}
373 IconComponent={this.ArrowIcon}
375 onClick={() => onSortToggle && onSortToggle(column)}>
385 ArrowIcon = ({ className, ...props }: SvgIconProps) => (
388 className={this.props.classes.arrowButton}
392 className={classnames(className, this.props.classes.arrow)}
397 renderBodyRow = (item: any, index: number) => {
398 const { onRowClick, onRowDoubleClick, extractKey, classes, currentItemUuid, currentRoute } = this.props;
401 data-cy={'data-table-row'}
403 key={extractKey ? extractKey(item) : index}
404 onClick={event => onRowClick && onRowClick(event, item)}
405 onContextMenu={this.handleRowContextMenu(item)}
406 onDoubleClick={event => onRowDoubleClick && onRowDoubleClick(event, item)}
407 selected={item === currentItemUuid}>
408 {this.mapVisibleColumns((column, index) => (
410 key={column.key || index}
412 currentRoute === "/workflows"
413 ? classes.tableCellWorkflows
415 ? classes.checkBoxCell
416 : `${classes.tableCell} ${index === 1 ? classes.firstTableCell : ""}`
418 {column.render(item)}
425 mapVisibleColumns = (fn: (column: DataColumn<T, any>, index: number) => React.ReactElement<any>) => {
426 return this.props.columns.filter(column => column.selected).map(fn);
429 handleRowContextMenu = (item: T) => (event: React.MouseEvent<HTMLElement>) => this.props.onContextMenu(event, item);