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" | "msToolbarStyles" | "subpanelToolbarStyles" | "searchBox" | "headerMenu" | "toolbar" | "footer" | "root" | "moreOptionsButton" | "title" | 'subProcessTitle' | "dataTable" | "container";
22 const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
25 justifyContent: "space-between",
30 subpanelToolbarStyles: {
38 paddingRight: theme.spacing.unit,
53 display: "inline-block",
54 paddingLeft: theme.spacing.unit * 2,
55 paddingTop: theme.spacing.unit * 2,
60 display: "inline-block",
61 paddingLeft: theme.spacing.unit * 2,
62 paddingTop: theme.spacing.unit * 2,
81 interface DataExplorerDataProps<T> {
82 fetchMode: DataTableFetchMode;
84 itemsAvailable: number;
85 columns: DataColumns<T, any>;
89 rowsPerPageOptions: number[];
91 contextMenuColumn: boolean;
92 defaultViewIcon?: IconType;
93 defaultViewMessages?: string[];
95 currentRefresh?: string;
96 currentRoute?: string;
97 hideColumnSelector?: boolean;
98 paperProps?: PaperProps;
99 actions?: React.ReactNode;
100 hideSearchInput?: boolean;
101 title?: React.ReactNode;
102 progressBar?: React.ReactNode;
104 currentRouteUuid: string;
105 selectedResourceUuid: string;
106 elementPath?: string;
107 isMSToolbarVisible: boolean;
108 checkedList: TCheckedList;
111 interface DataExplorerActionProps<T> {
112 onSetColumns: (columns: DataColumns<T, any>) => void;
113 onSearch: (value: string) => void;
114 onRowClick: (item: T) => void;
115 onRowDoubleClick: (item: T) => void;
116 onColumnToggle: (column: DataColumn<T, any>) => void;
117 onContextMenu: (event: React.MouseEvent<HTMLElement>, item: T) => void;
118 onSortToggle: (column: DataColumn<T, any>) => void;
119 onFiltersChange: (filters: DataTableFilters, column: DataColumn<T, any>) => void;
120 onChangePage: (page: number) => void;
121 onChangeRowsPerPage: (rowsPerPage: number) => void;
122 onLoadMore: (page: number) => void;
123 extractKey?: (item: T) => React.Key;
124 toggleMSToolbar: (isVisible: boolean) => void;
125 setCheckedListOnStore: (checkedList: TCheckedList) => void;
126 setSelectedUuid: (uuid: string) => void;
129 type DataExplorerProps<T> = DataExplorerDataProps<T> & DataExplorerActionProps<T> & WithStyles<CssRules> & MPVPanelProps;
131 export const DataExplorer = withStyles(styles)(
132 class DataExplorerGeneric<T> extends React.Component<DataExplorerProps<T>> {
137 msToolbarInDetailsCard: true,
140 multiSelectToolbarInTitle = !this.props.title && !this.props.progressBar;
142 componentDidUpdate(prevProps: DataExplorerProps<T>) {
143 const currentRefresh = this.props.currentRefresh || "";
144 const currentRoute = this.props.currentRoute || "";
146 if (currentRoute !== this.state.prevRoute) {
147 // Component already mounted, but the user comes from a route change,
148 // like browsing through a project hierarchy.
150 showLoading: this.props.working,
151 prevRoute: currentRoute,
155 if (currentRefresh !== this.state.prevRefresh) {
156 // Component already mounted, but the user just clicked the
159 showLoading: this.props.working,
160 prevRefresh: currentRefresh,
163 if (this.state.showLoading && !this.props.working) {
168 if (this.props.selectedResourceUuid !== prevProps.selectedResourceUuid || this.props.currentRouteUuid !== prevProps.currentRouteUuid) {
170 msToolbarInDetailsCard: this.props.selectedResourceUuid === this.props.currentRouteUuid,
175 componentDidMount() {
176 if (this.props.onSetColumns) {
177 this.props.onSetColumns(this.props.columns);
179 // Component just mounted, so we need to show the loading indicator.
181 showLoading: this.props.working,
182 prevRefresh: this.props.currentRefresh || "",
183 prevRoute: this.props.currentRoute || "",
213 selectedResourceUuid,
224 setCheckedListOnStore,
229 className={classes.root}
232 data-cy={this.props["data-cy"]}
238 className={classes.container}
240 <div className={classes.titleWrapper} style={currentRoute?.includes('search-results') || !!progressBar ? {marginBottom: '-20px'} : {}}>
245 className={!!progressBar ? classes.subProcessTitle : classes.title}
250 {!!progressBar && progressBar}
251 {console.log('this.multiSelectToolbarInTitle', this.multiSelectToolbarInTitle, !this.state.msToolbarInDetailsCard)}
252 {this.multiSelectToolbarInTitle && !this.state.msToolbarInDetailsCard && <MultiselectToolbar injectedStyles={classes.msToolbarStyles} />}
253 {(!hideColumnSelector || !hideSearchInput || !!actions) && (
255 className={classes.headerMenu}
259 <Toolbar className={classes.toolbar}>
260 <Grid container justify="space-between" wrap="nowrap" alignItems="center">
261 {!hideSearchInput && (
262 <div className={classes.searchBox}>
263 {!hideSearchInput && (
274 {!hideColumnSelector && (
277 onColumnToggle={onColumnToggle}
281 {doUnMaximizePanel && panelMaximized && (
283 title={`Unmaximize ${panelName || "panel"}`}
286 <IconButton onClick={doUnMaximizePanel}>
291 {doMaximizePanel && !panelMaximized && (
293 title={`Maximize ${panelName || "panel"}`}
296 <IconButton onClick={doMaximizePanel}>
303 title={`Close ${panelName || "panel"}`}
307 disabled={panelMaximized}
308 onClick={doHidePanel}
318 {!this.multiSelectToolbarInTitle && <MultiselectToolbar isSubPanel={true} injectedStyles={classes.subpanelToolbarStyles}/>}
322 className={classes.dataTable}
323 style={currentRoute?.includes('search-results') || !!progressBar ? {marginTop: '-10px'} : {}}
326 columns={this.props.contextMenuColumn ? [...columns, this.contextMenuColumn] : columns}
328 onRowClick={(_, item: T) => onRowClick(item)}
329 onContextMenu={onContextMenu}
330 onRowDoubleClick={(_, item: T) => onRowDoubleClick(item)}
331 onFiltersChange={onFiltersChange}
332 onSortToggle={onSortToggle}
333 extractKey={extractKey}
334 working={this.state.showLoading}
335 defaultViewIcon={defaultViewIcon}
336 defaultViewMessages={defaultViewMessages}
337 currentRoute={paperKey}
338 toggleMSToolbar={toggleMSToolbar}
339 setCheckedListOnStore={setCheckedListOnStore}
340 checkedList={checkedList}
341 selectedResourceUuid={selectedResourceUuid}
342 setSelectedUuid={this.props.setSelectedUuid}
343 currentRouteUuid={this.props.currentRouteUuid}
350 <Toolbar className={classes.footer}>
353 <span data-cy="element-path">{elementPath}</span>
357 container={!elementPath}
360 {fetchMode === DataTableFetchMode.PAGINATED ? (
362 count={itemsAvailable}
363 rowsPerPage={rowsPerPage}
364 rowsPerPageOptions={rowsPerPageOptions}
365 page={this.props.page}
366 onChangePage={this.changePage}
367 onChangeRowsPerPage={this.changeRowsPerPage}
368 // Disable next button on empty lists since that's not default behavior
369 nextIconButtonProps={itemsAvailable > 0 ? {} : { disabled: true }}
376 onClick={this.loadMore}
389 changePage = (event: React.MouseEvent<HTMLButtonElement>, page: number) => {
390 this.props.onChangePage(page);
393 changeRowsPerPage: React.ChangeEventHandler<HTMLTextAreaElement | HTMLInputElement> = event => {
394 this.props.onChangeRowsPerPage(parseInt(event.target.value, 10));
398 this.props.onLoadMore(this.props.page + 1);
401 renderContextMenuTrigger = (item: T) => (
411 className={this.props.classes.moreOptionsButton}
413 event.stopPropagation()
414 this.props.onContextMenu(event, item)
423 contextMenuColumn: DataColumn<any, any> = {
427 filters: createTree(),
428 key: "context-actions",
429 render: this.renderContextMenuTrigger,