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 { createTree } from 'models/tree';
13 import { DataTableFilters } from 'components/data-table-filters/data-table-filters-tree';
14 import { MoreOptionsIcon } from 'components/icon/icon';
15 import { PaperProps } from '@material-ui/core/Paper';
17 type CssRules = 'searchBox' | "toolbar" | "toolbarUnderTitle" | "footer" | "root" | 'moreOptionsButton' | 'title';
19 const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
21 paddingBottom: theme.spacing.unit * 2
24 paddingTop: theme.spacing.unit * 2
39 paddingLeft: theme.spacing.unit * 3,
40 paddingTop: theme.spacing.unit * 3,
45 interface DataExplorerDataProps<T> {
46 fetchMode: DataTableFetchMode;
48 itemsAvailable: number;
49 columns: DataColumns<T>;
53 rowsPerPageOptions: number[];
55 contextMenuColumn: boolean;
56 dataTableDefaultView?: React.ReactNode;
58 hideColumnSelector?: boolean;
59 paperProps?: PaperProps;
60 actions?: React.ReactNode;
61 hideSearchInput?: boolean;
62 title?: React.ReactNode;
64 currentItemUuid: string;
67 interface DataExplorerActionProps<T> {
68 onSetColumns: (columns: DataColumns<T>) => void;
69 onSearch: (value: string) => void;
70 onRowClick: (item: T) => void;
71 onRowDoubleClick: (item: T) => void;
72 onColumnToggle: (column: DataColumn<T>) => void;
73 onContextMenu: (event: React.MouseEvent<HTMLElement>, item: T) => void;
74 onSortToggle: (column: DataColumn<T>) => void;
75 onFiltersChange: (filters: DataTableFilters, column: DataColumn<T>) => void;
76 onChangePage: (page: number) => void;
77 onChangeRowsPerPage: (rowsPerPage: number) => void;
78 onLoadMore: (page: number) => void;
79 extractKey?: (item: T) => React.Key;
82 type DataExplorerProps<T> = DataExplorerDataProps<T> & DataExplorerActionProps<T> & WithStyles<CssRules>;
84 export const DataExplorer = withStyles(styles)(
85 class DataExplorerGeneric<T> extends React.Component<DataExplorerProps<T>> {
87 if (this.props.onSetColumns) {
88 this.props.onSetColumns(this.props.columns);
93 columns, onContextMenu, onFiltersChange, onSortToggle, working, extractKey,
94 rowsPerPage, rowsPerPageOptions, onColumnToggle, searchLabel, searchValue, onSearch,
95 items, itemsAvailable, onRowClick, onRowDoubleClick, classes,
96 dataTableDefaultView, hideColumnSelector, actions, paperProps, hideSearchInput,
97 paperKey, fetchMode, currentItemUuid, title
99 const dataCy = this.props["data-cy"];
100 return <Paper className={classes.root} {...paperProps} key={paperKey} data-cy={dataCy}>
101 {title && <div className={classes.title}>{title}</div>}
102 {(!hideColumnSelector || !hideSearchInput || !!actions) && <Toolbar className={title ? classes.toolbarUnderTitle : classes.toolbar}>
103 <Grid container justify="space-between" wrap="nowrap" alignItems="center">
104 {!hideSearchInput && <div className={classes.searchBox}>
105 {!hideSearchInput && <SearchInput
108 onSearch={onSearch} />}
111 {!hideColumnSelector && <ColumnSelector
113 onColumnToggle={onColumnToggle} />}
117 columns={this.props.contextMenuColumn ? [...columns, this.contextMenuColumn] : columns}
119 onRowClick={(_, item: T) => onRowClick(item)}
120 onContextMenu={onContextMenu}
121 onRowDoubleClick={(_, item: T) => onRowDoubleClick(item)}
122 onFiltersChange={onFiltersChange}
123 onSortToggle={onSortToggle}
124 extractKey={extractKey}
126 defaultView={dataTableDefaultView}
127 currentItemUuid={currentItemUuid}
128 currentRoute={paperKey} />
129 <Toolbar className={classes.footer}>
130 <Grid container justify="flex-end">
131 {fetchMode === DataTableFetchMode.PAGINATED ? <TablePagination
132 count={itemsAvailable}
133 rowsPerPage={rowsPerPage}
134 rowsPerPageOptions={rowsPerPageOptions}
135 page={this.props.page}
136 onChangePage={this.changePage}
137 onChangeRowsPerPage={this.changeRowsPerPage}
138 // Disable next button on empty lists since that's not default behavior
139 nextIconButtonProps={(itemsAvailable > 0) ? {} : {disabled: true}}
140 component="div" /> : <Button
143 onClick={this.loadMore}
150 changePage = (event: React.MouseEvent<HTMLButtonElement>, page: number) => {
151 this.props.onChangePage(page);
154 changeRowsPerPage: React.ChangeEventHandler<HTMLTextAreaElement | HTMLInputElement> = (event) => {
155 this.props.onChangeRowsPerPage(parseInt(event.target.value, 10));
159 this.props.onLoadMore(this.props.page + 1);
162 renderContextMenuTrigger = (item: T) =>
163 <Grid container justify="center">
164 <Tooltip title="More options" disableFocusListener>
165 <IconButton className={this.props.classes.moreOptionsButton} onClick={event => this.props.onContextMenu(event, item)}>
171 contextMenuColumn: DataColumn<any> = {
175 filters: createTree(),
176 key: "context-actions",
177 render: this.renderContextMenuTrigger