1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
5 import React from "react";
6 import { Grid, Paper, Toolbar, StyleRulesCallback, withStyles, WithStyles, TablePagination, IconButton, Tooltip, Button } from "@material-ui/core";
7 import { ColumnSelector } from "components/column-selector/column-selector";
8 import { DataTable, DataColumns, DataTableFetchMode } from "components/data-table/data-table";
9 import { DataColumn } from "components/data-table/data-column";
10 import { SearchInput } from "components/search-input/search-input";
11 import { ArvadosTheme } from "common/custom-theme";
12 import { MultiselectToolbar } from "components/multiselect-toolbar/MultiselectToolbar";
13 import { TCheckedList } from "components/data-table/data-table";
14 import { createTree } from "models/tree";
15 import { DataTableFilters } from "components/data-table-filters/data-table-filters-tree";
16 import { CloseIcon, IconType, MaximizeIcon, UnMaximizeIcon, MoreVerticalIcon } from "components/icon/icon";
17 import { PaperProps } from "@material-ui/core/Paper";
18 import { MPVPanelProps } from "components/multi-panel-view/multi-panel-view";
20 type CssRules = "titleWrapper" | "searchBox" | "headerMenu" | "toolbar" | "footer" | "root" | "moreOptionsButton" | "title" | 'subProcessTitle' | "dataTable" | "container";
22 const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
25 justifyContent: "space-between",
32 paddingRight: theme.spacing.unit,
45 display: "inline-block",
46 paddingLeft: theme.spacing.unit * 2,
47 paddingTop: theme.spacing.unit * 2,
52 display: "inline-block",
53 paddingLeft: theme.spacing.unit * 2,
54 paddingTop: theme.spacing.unit * 2,
73 interface DataExplorerDataProps<T> {
74 fetchMode: DataTableFetchMode;
76 itemsAvailable: number;
77 columns: DataColumns<T, any>;
81 rowsPerPageOptions: number[];
83 contextMenuColumn: boolean;
84 defaultViewIcon?: IconType;
85 defaultViewMessages?: string[];
87 currentRoute?: string;
88 hideColumnSelector?: boolean;
89 paperProps?: PaperProps;
90 actions?: React.ReactNode;
91 hideSearchInput?: boolean;
92 title?: React.ReactNode;
93 progressBar?: React.ReactNode;
95 currentItemUuid: string;
97 isMSToolbarVisible: boolean;
98 checkedList: TCheckedList;
102 interface DataExplorerActionProps<T> {
103 onSetColumns: (columns: DataColumns<T, any>) => void;
104 onSearch: (value: string) => void;
105 onRowClick: (item: T) => void;
106 onRowDoubleClick: (item: T) => void;
107 onColumnToggle: (column: DataColumn<T, any>) => void;
108 onContextMenu: (event: React.MouseEvent<HTMLElement>, item: T) => void;
109 onSortToggle: (column: DataColumn<T, any>) => void;
110 onFiltersChange: (filters: DataTableFilters, column: DataColumn<T, any>) => void;
111 onChangePage: (page: number) => void;
112 onChangeRowsPerPage: (rowsPerPage: number) => void;
113 onLoadMore: (page: number) => void;
114 extractKey?: (item: T) => React.Key;
115 toggleMSToolbar: (isVisible: boolean) => void;
116 setCheckedListOnStore: (checkedList: TCheckedList) => void;
119 type DataExplorerProps<T> = DataExplorerDataProps<T> & DataExplorerActionProps<T> & WithStyles<CssRules> & MPVPanelProps;
121 export const DataExplorer = withStyles(styles)(
122 class DataExplorerGeneric<T> extends React.Component<DataExplorerProps<T>> {
124 multiSelectToolbarInTitle = !this.props.title && !this.props.progressBar;
126 componentDidMount() {
127 if (this.props.onSetColumns) {
128 this.props.onSetColumns(this.props.columns);
169 setCheckedListOnStore,
175 className={classes.root}
178 data-cy={this.props["data-cy"]}
184 className={classes.container}
186 <div className={classes.titleWrapper} style={currentRoute?.includes('search-results') || !!progressBar ? {marginBottom: '-20px'} : {}}>
191 className={!!progressBar ? classes.subProcessTitle : classes.title}
196 {!!progressBar && progressBar}
197 {this.multiSelectToolbarInTitle && <MultiselectToolbar />}
198 {(!hideColumnSelector || !hideSearchInput || !!actions) && (
200 className={classes.headerMenu}
204 <Toolbar className={classes.toolbar}>
205 <Grid container justify="space-between" wrap="nowrap" alignItems="center">
206 {!hideSearchInput && (
207 <div className={classes.searchBox}>
208 {!hideSearchInput && (
219 {!hideColumnSelector && (
222 onColumnToggle={onColumnToggle}
226 {doUnMaximizePanel && panelMaximized && (
228 title={`Unmaximize ${panelName || "panel"}`}
231 <IconButton onClick={doUnMaximizePanel}>
236 {doMaximizePanel && !panelMaximized && (
238 title={`Maximize ${panelName || "panel"}`}
241 <IconButton onClick={doMaximizePanel}>
248 title={`Close ${panelName || "panel"}`}
252 disabled={panelMaximized}
253 onClick={doHidePanel}
263 {!this.multiSelectToolbarInTitle && <MultiselectToolbar />}
267 className={classes.dataTable}
268 style={currentRoute?.includes('search-results') || !!progressBar ? {marginTop: '-10px'} : {}}
271 columns={this.props.contextMenuColumn ? [...columns, this.contextMenuColumn] : columns}
273 onRowClick={(_, item: T) => onRowClick(item)}
274 onContextMenu={onContextMenu}
275 onRowDoubleClick={(_, item: T) => onRowDoubleClick(item)}
276 onFiltersChange={onFiltersChange}
277 onSortToggle={onSortToggle}
278 extractKey={extractKey}
279 defaultViewIcon={defaultViewIcon}
280 defaultViewMessages={defaultViewMessages}
281 currentItemUuid={currentItemUuid}
282 currentRoute={paperKey}
283 toggleMSToolbar={toggleMSToolbar}
284 setCheckedListOnStore={setCheckedListOnStore}
285 checkedList={checkedList}
287 isNotFound={this.props.isNotFound}
294 <Toolbar className={classes.footer}>
297 <span data-cy="element-path">{elementPath}</span>
301 container={!elementPath}
304 {fetchMode === DataTableFetchMode.PAGINATED ? (
306 count={itemsAvailable}
307 rowsPerPage={rowsPerPage}
308 rowsPerPageOptions={rowsPerPageOptions}
309 page={this.props.page}
310 onChangePage={this.changePage}
311 onChangeRowsPerPage={this.changeRowsPerPage}
312 // Disable next button on empty lists since that's not default behavior
313 nextIconButtonProps={itemsAvailable > 0 ? {} : { disabled: true }}
320 onClick={this.loadMore}
333 changePage = (event: React.MouseEvent<HTMLButtonElement>, page: number) => {
334 this.props.onChangePage(page);
337 changeRowsPerPage: React.ChangeEventHandler<HTMLTextAreaElement | HTMLInputElement> = event => {
338 this.props.onChangeRowsPerPage(parseInt(event.target.value, 10));
342 this.props.onLoadMore(this.props.page + 1);
345 renderContextMenuTrigger = (item: T) => (
355 className={this.props.classes.moreOptionsButton}
357 event.stopPropagation()
358 this.props.onContextMenu(event, item)
367 contextMenuColumn: DataColumn<any, any> = {
371 filters: createTree(),
372 key: "context-actions",
373 render: this.renderContextMenuTrigger,