src/components/data-explorer/data-explorer.tsx

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   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 { CloseIcon, MaximizeIcon, MoreOptionsIcon } from 'components/icon/icon';
  15 import { PaperProps } from '@material-ui/core/Paper';
  16 import { MPVPanelProps } from 'components/multi-panel-view/multi-panel-view';
  17
  18 type CssRules = 'searchBox' | "toolbar" | "toolbarUnderTitle" | "footer" | "root" | 'moreOptionsButton' | 'title';
  19
  20 const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
  21     searchBox: {
  22         paddingBottom: theme.spacing.unit * 2
  23     },
  24     toolbar: {
  25         paddingTop: theme.spacing.unit,
  26         paddingRight: theme.spacing.unit * 2,
  27     },
  28     toolbarUnderTitle: {
  29         paddingTop: 0
  30     },
  31     footer: {
  32         overflow: 'auto'
  33     },
  34     root: {
  35         height: '100%'
  36     },
  37     moreOptionsButton: {
  38         padding: 0
  39     },
  40     title: {
  41         paddingLeft: theme.spacing.unit * 3,
  42         paddingTop: theme.spacing.unit * 3,
  43         fontSize: '18px'
  44     }
  45 });
  46
  47 interface DataExplorerDataProps<T> {
  48     fetchMode: DataTableFetchMode;
  49     items: T[];
  50     itemsAvailable: number;
  51     columns: DataColumns<T>;
  52     searchLabel?: string;
  53     searchValue: string;
  54     rowsPerPage: number;
  55     rowsPerPageOptions: number[];
  56     page: number;
  57     contextMenuColumn: boolean;
  58     dataTableDefaultView?: React.ReactNode;
  59     working?: boolean;
  60     hideColumnSelector?: boolean;
  61     paperProps?: PaperProps;
  62     actions?: React.ReactNode;
  63     hideSearchInput?: boolean;
  64     title?: React.ReactNode;
  65     paperKey?: string;
  66     currentItemUuid: string;
  67 }
  68
  69 interface DataExplorerActionProps<T> {
  70     onSetColumns: (columns: DataColumns<T>) => void;
  71     onSearch: (value: string) => void;
  72     onRowClick: (item: T) => void;
  73     onRowDoubleClick: (item: T) => void;
  74     onColumnToggle: (column: DataColumn<T>) => void;
  75     onContextMenu: (event: React.MouseEvent<HTMLElement>, item: T) => void;
  76     onSortToggle: (column: DataColumn<T>) => void;
  77     onFiltersChange: (filters: DataTableFilters, column: DataColumn<T>) => void;
  78     onChangePage: (page: number) => void;
  79     onChangeRowsPerPage: (rowsPerPage: number) => void;
  80     onLoadMore: (page: number) => void;
  81     extractKey?: (item: T) => React.Key;
  82 }
  83
  84 type DataExplorerProps<T> = DataExplorerDataProps<T> &
  85     DataExplorerActionProps<T> & WithStyles<CssRules> & MPVPanelProps;
  86
  87 export const DataExplorer = withStyles(styles)(
  88     class DataExplorerGeneric<T> extends React.Component<DataExplorerProps<T>> {
  89         componentDidMount() {
  90             if (this.props.onSetColumns) {
  91                 this.props.onSetColumns(this.props.columns);
  92             }
  93         }
  94         render() {
  95             const {
  96                 columns, onContextMenu, onFiltersChange, onSortToggle, working, extractKey,
  97                 rowsPerPage, rowsPerPageOptions, onColumnToggle, searchLabel, searchValue, onSearch,
  98                 items, itemsAvailable, onRowClick, onRowDoubleClick, classes,
  99                 dataTableDefaultView, hideColumnSelector, actions, paperProps, hideSearchInput,
 100                 paperKey, fetchMode, currentItemUuid, title,
 101                 doHidePanel, doMaximizePanel, panelName, panelMaximized
 102             } = this.props;
 103             return <Paper className={classes.root} {...paperProps} key={paperKey}>
 104                 {title && <div className={classes.title}>{title}</div>}
 105                 {(!hideColumnSelector || !hideSearchInput) && <Toolbar className={title ? classes.toolbarUnderTitle : classes.toolbar}>
 106                     <Grid container justify="space-between" wrap="nowrap" alignItems="center">
 107                         <div className={classes.searchBox}>
 108                             {!hideSearchInput && <SearchInput
 109                                 label={searchLabel}
 110                                 value={searchValue}
 111                                 onSearch={onSearch} />}
 112                         </div>
 113                         {actions}
 114                         {!hideColumnSelector && <ColumnSelector
 115                             columns={columns}
 116                             onColumnToggle={onColumnToggle} />}
 117                     </Grid>
 118                     { doMaximizePanel && !!!panelMaximized &&
 119                         <Tooltip title={`Maximize ${panelName || 'panel'}`} disableFocusListener>
 120                             <IconButton onClick={doMaximizePanel}><MaximizeIcon /></IconButton>
 121                         </Tooltip> }
 122                     { doHidePanel &&
 123                         <Tooltip title={`Close ${panelName || 'panel'}`} disableFocusListener>
 124                             <IconButton onClick={doHidePanel}><CloseIcon /></IconButton>
 125                         </Tooltip> }
 126                 </Toolbar>}
 127                 <DataTable
 128                     columns={this.props.contextMenuColumn ? [...columns, this.contextMenuColumn] : columns}
 129                     items={items}
 130                     onRowClick={(_, item: T) => onRowClick(item)}
 131                     onContextMenu={onContextMenu}
 132                     onRowDoubleClick={(_, item: T) => onRowDoubleClick(item)}
 133                     onFiltersChange={onFiltersChange}
 134                     onSortToggle={onSortToggle}
 135                     extractKey={extractKey}
 136                     working={working}
 137                     defaultView={dataTableDefaultView}
 138                     currentItemUuid={currentItemUuid}
 139                     currentRoute={paperKey} />
 140                 <Toolbar className={classes.footer}>
 141                     <Grid container justify="flex-end">
 142                         {fetchMode === DataTableFetchMode.PAGINATED ? <TablePagination
 143                             count={itemsAvailable}
 144                             rowsPerPage={rowsPerPage}
 145                             rowsPerPageOptions={rowsPerPageOptions}
 146                             page={this.props.page}
 147                             onChangePage={this.changePage}
 148                             onChangeRowsPerPage={this.changeRowsPerPage}
 149                             // Disable next button on empty lists since that's not default behavior
 150                             nextIconButtonProps={(itemsAvailable > 0) ? {} : {disabled: true}}
 151                             component="div" /> : <Button
 152                                 variant="text"
 153                                 size="medium"
 154                                 onClick={this.loadMore}
 155                             >Load more</Button>}
 156                     </Grid>
 157                 </Toolbar>
 158             </Paper>;
 159         }
 160
 161         changePage = (event: React.MouseEvent<HTMLButtonElement>, page: number) => {
 162             this.props.onChangePage(page);
 163         }
 164
 165         changeRowsPerPage: React.ChangeEventHandler<HTMLTextAreaElement | HTMLInputElement> = (event) => {
 166             this.props.onChangeRowsPerPage(parseInt(event.target.value, 10));
 167         }
 168
 169         loadMore = () => {
 170             this.props.onLoadMore(this.props.page + 1);
 171         }
 172
 173         renderContextMenuTrigger = (item: T) =>
 174             <Grid container justify="center">
 175                 <Tooltip title="More options" disableFocusListener>
 176                     <IconButton className={this.props.classes.moreOptionsButton} onClick={event => this.props.onContextMenu(event, item)}>
 177                         <MoreOptionsIcon />
 178                     </IconButton>
 179                 </Tooltip>
 180             </Grid>
 181
 182         contextMenuColumn: DataColumn<any> = {
 183             name: "Actions",
 184             selected: true,
 185             configurable: false,
 186             filters: createTree(),
 187             key: "context-actions",
 188             render: this.renderContextMenuTrigger
 189         };
 190     }
 191 );