1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
5 import * as 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 } from "~/components/data-table/data-table";
9 import { DataColumn, SortDirection } 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" | "footer" | "root" | 'moreOptionsButton';
19 const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
21 paddingBottom: theme.spacing.unit * 2
24 paddingTop: theme.spacing.unit * 2
37 interface DataExplorerDataProps<T> {
39 itemsAvailable: number;
40 columns: DataColumns<T>;
43 rowsPerPageOptions: number[];
45 contextMenuColumn: boolean;
46 dataTableDefaultView?: React.ReactNode;
48 hideColumnSelector?: boolean;
49 paperProps?: PaperProps;
50 actions?: React.ReactNode;
53 interface DataExplorerActionProps<T> {
54 onSetColumns: (columns: DataColumns<T>) => void;
55 onSearch: (value: string) => void;
56 onRowClick: (item: T) => void;
57 onRowDoubleClick: (item: T) => void;
58 onColumnToggle: (column: DataColumn<T>) => void;
59 onContextMenu: (event: React.MouseEvent<HTMLElement>, item: T) => void;
60 onSortToggle: (column: DataColumn<T>) => void;
61 onFiltersChange: (filters: DataTableFilters, column: DataColumn<T>) => void;
62 onChangePage: (page: number) => void;
63 onChangeRowsPerPage: (rowsPerPage: number) => void;
64 extractKey?: (item: T) => React.Key;
67 type DataExplorerProps<T> = DataExplorerDataProps<T> & DataExplorerActionProps<T> & WithStyles<CssRules>;
69 export const DataExplorer = withStyles(styles)(
70 class DataExplorerGeneric<T> extends React.Component<DataExplorerProps<T>> {
72 if (this.props.onSetColumns) {
73 this.props.onSetColumns(this.props.columns);
78 columns, onContextMenu, onFiltersChange, onSortToggle, working, extractKey,
79 rowsPerPage, rowsPerPageOptions, onColumnToggle, searchValue, onSearch,
80 items, itemsAvailable, onRowClick, onRowDoubleClick, classes,
81 dataTableDefaultView, hideColumnSelector, actions, paperProps,
83 return <Paper className={classes.root} {...paperProps}>
84 <Toolbar className={classes.toolbar}>
85 <Grid container justify="space-between" wrap="nowrap" alignItems="center">
86 <div className={classes.searchBox}>
89 onSearch={onSearch} />
92 {!hideColumnSelector && <ColumnSelector
94 onColumnToggle={onColumnToggle} />}
98 columns={this.props.contextMenuColumn ? [...columns, this.contextMenuColumn] : columns}
100 onRowClick={(_, item: T) => onRowClick(item)}
101 onContextMenu={onContextMenu}
102 onRowDoubleClick={(_, item: T) => onRowDoubleClick(item)}
103 onFiltersChange={onFiltersChange}
104 onSortToggle={onSortToggle}
105 extractKey={extractKey}
107 defaultView={dataTableDefaultView}
109 <Toolbar className={classes.footer}>
110 <Grid container justify="flex-end">
112 count={itemsAvailable}
113 rowsPerPage={rowsPerPage}
114 rowsPerPageOptions={rowsPerPageOptions}
115 page={this.props.page}
116 onChangePage={this.changePage}
117 onChangeRowsPerPage={this.changeRowsPerPage}
124 changePage = (event: React.MouseEvent<HTMLButtonElement>, page: number) => {
125 this.props.onChangePage(page);
128 changeRowsPerPage: React.ChangeEventHandler<HTMLTextAreaElement | HTMLInputElement> = (event) => {
129 this.props.onChangeRowsPerPage(parseInt(event.target.value, 10));
132 renderContextMenuTrigger = (item: T) =>
133 <Grid container justify="center">
134 <Tooltip title="More options" disableFocusListener>
135 <IconButton className={this.props.classes.moreOptionsButton} onClick={event => this.props.onContextMenu(event, item)}>
141 contextMenuColumn: DataColumn<any> = {
145 sortDirection: SortDirection.NONE,
146 filters: createTree(),
147 key: "context-actions",
148 render: this.renderContextMenuTrigger