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 * 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, 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';
  16
  17 type CssRules = 'searchBox' | "toolbar" | "footer" | "root" | 'moreOptionsButton';
  18
  19 const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
  20     searchBox: {
  21         paddingBottom: theme.spacing.unit * 2
  22     },
  23     toolbar: {
  24         paddingTop: theme.spacing.unit * 2
  25     },
  26     footer: {
  27         overflow: 'auto'
  28     },
  29     root: {
  30         height: '100%'
  31     },
  32     moreOptionsButton: {
  33         padding: 0
  34     }
  35 });
  36
  37 interface DataExplorerDataProps<T> {
  38     fetchMode: DataTableFetchMode;
  39     items: T[];
  40     itemsAvailable: number;
  41     columns: DataColumns<T>;
  42     searchValue: string;
  43     rowsPerPage: number;
  44     rowsPerPageOptions: number[];
  45     page: number;
  46     contextMenuColumn: boolean;
  47     dataTableDefaultView?: React.ReactNode;
  48     working?: boolean;
  49     hideColumnSelector?: boolean;
  50     paperProps?: PaperProps;
  51     actions?: React.ReactNode;
  52     hideSearchInput?: boolean;
  53     header?: React.ReactNode;
  54     paperKey?: string;
  55     currentItemUuid: string;
  56 }
  57
  58 interface DataExplorerActionProps<T> {
  59     onSetColumns: (columns: DataColumns<T>) => void;
  60     onSearch: (value: string) => void;
  61     onRowClick: (item: T) => void;
  62     onRowDoubleClick: (item: T) => void;
  63     onColumnToggle: (column: DataColumn<T>) => void;
  64     onContextMenu: (event: React.MouseEvent<HTMLElement>, item: T) => void;
  65     onSortToggle: (column: DataColumn<T>) => void;
  66     onFiltersChange: (filters: DataTableFilters, column: DataColumn<T>) => void;
  67     onChangePage: (page: number) => void;
  68     onChangeRowsPerPage: (rowsPerPage: number) => void;
  69     onLoadMore: (page: number) => void;
  70     extractKey?: (item: T) => React.Key;
  71 }
  72
  73 type DataExplorerProps<T> = DataExplorerDataProps<T> & DataExplorerActionProps<T> & WithStyles<CssRules>;
  74
  75 export const DataExplorer = withStyles(styles)(
  76     class DataExplorerGeneric<T> extends React.Component<DataExplorerProps<T>> {
  77         componentDidMount() {
  78             if (this.props.onSetColumns) {
  79                 this.props.onSetColumns(this.props.columns);
  80             }
  81         }
  82         render() {
  83             const {
  84                 columns, onContextMenu, onFiltersChange, onSortToggle, working, extractKey,
  85                 rowsPerPage, rowsPerPageOptions, onColumnToggle, searchValue, onSearch,
  86                 items, itemsAvailable, onRowClick, onRowDoubleClick, classes,
  87                 dataTableDefaultView, hideColumnSelector, actions, paperProps, hideSearchInput,
  88                 paperKey, fetchMode, currentItemUuid, header
  89             } = this.props;
  90             return <Paper className={classes.root} {...paperProps} key={paperKey}>
  91                 {(!hideColumnSelector || !hideSearchInput) && <Toolbar className={classes.toolbar}>
  92                     <Grid container justify="space-between" wrap="nowrap" alignItems="center">
  93                         {header && <div>{header}</div>}
  94                         <div className={classes.searchBox}>
  95                             {!hideSearchInput && <SearchInput
  96                                 value={searchValue}
  97                                 onSearch={onSearch} />}
  98                         </div>
  99                         {actions}
 100                         {!hideColumnSelector && <ColumnSelector
 101                             columns={columns}
 102                             onColumnToggle={onColumnToggle} />}
 103                     </Grid>
 104                 </Toolbar>}
 105                 <DataTable
 106                     columns={this.props.contextMenuColumn ? [...columns, this.contextMenuColumn] : columns}
 107                     items={items}
 108                     onRowClick={(_, item: T) => onRowClick(item)}
 109                     onContextMenu={onContextMenu}
 110                     onRowDoubleClick={(_, item: T) => onRowDoubleClick(item)}
 111                     onFiltersChange={onFiltersChange}
 112                     onSortToggle={onSortToggle}
 113                     extractKey={extractKey}
 114                     working={working}
 115                     defaultView={dataTableDefaultView}
 116                     currentItemUuid={currentItemUuid}
 117                     currentRoute={paperKey} />
 118                 <Toolbar className={classes.footer}>
 119                     <Grid container justify="flex-end">
 120                         {fetchMode === DataTableFetchMode.PAGINATED ? <TablePagination
 121                             count={itemsAvailable}
 122                             rowsPerPage={rowsPerPage}
 123                             rowsPerPageOptions={rowsPerPageOptions}
 124                             page={this.props.page}
 125                             onChangePage={this.changePage}
 126                             onChangeRowsPerPage={this.changeRowsPerPage}
 127                             component="div" /> : <Button
 128                                 variant="text"
 129                                 size="medium"
 130                                 onClick={this.loadMore}
 131                             >Load more</Button>}
 132                     </Grid>
 133                 </Toolbar>
 134             </Paper>;
 135         }
 136
 137         changePage = (event: React.MouseEvent<HTMLButtonElement>, page: number) => {
 138             this.props.onChangePage(page);
 139         }
 140
 141         changeRowsPerPage: React.ChangeEventHandler<HTMLTextAreaElement | HTMLInputElement> = (event) => {
 142             this.props.onChangeRowsPerPage(parseInt(event.target.value, 10));
 143         }
 144
 145         loadMore = () => {
 146             this.props.onLoadMore(this.props.page + 1);
 147         }
 148
 149         renderContextMenuTrigger = (item: T) =>
 150             <Grid container justify="center">
 151                 <Tooltip title="More options" disableFocusListener>
 152                     <IconButton className={this.props.classes.moreOptionsButton} onClick={event => this.props.onContextMenu(event, item)}>
 153                         <MoreOptionsIcon />
 154                     </IconButton>
 155                 </Tooltip>
 156             </Grid>
 157
 158         contextMenuColumn: DataColumn<any> = {
 159             name: "Actions",
 160             selected: true,
 161             configurable: false,
 162             filters: createTree(),
 163             key: "context-actions",
 164             render: this.renderContextMenuTrigger
 165         };
 166     }
 167 );